Grundlegende Antworten zur Adressvalidierung

Die Address Validation API stellt einen Antworttext im JSON-Format bereit. , das zwei übergeordnete Eigenschaften enthält:

• result, ein Objekt vom Typ ValidationResult
• responseID

{
  "result": {
    // Validation verdict.
    "verdict": {},
    // Address details determined by the API.
    "address": {},
    // The geocode generated for the input address.
    "geocode": {},
    // Information indicating if the address is a business, residence, etc.
    "metadata": {},
    // Information about the address from the US Postal Service
    // ("US" and "PR" addresses only).
    "uspsData": {},
  },
  // A unique identifier generated for every request to the API.
  "responseId": "ID"
}

In diesem Dokument geht es um das result-Objekt. Informationen zur responseID, siehe Umgang mit aktualisierten Adressen.

Das Attribut verdict

Das Attribut verdict fasst die Ergebnisse der Adressvalidierung und sollte die erste Property sein, die beim Erstellen einer Logik zur Adressprüfung ausgewertet wird. Die Eigenschaft kann eine Vielzahl von Feldern zurückgeben, abhängig von der Qualität des . Im folgenden Beispiel wird das Attribut verdict einer Adresse von guter Qualität, wodurch 4 Felder für diese bestimmte Anfrage zurückgegeben werden:

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true
}

In den folgenden Abschnitten werden alle Felder des Attributs verdict zusammengefasst.

Detaillierungsgrad der Adresse

Der Detaillierungsgrad der Adresse bezieht sich auf den Detaillierungsgrad, Spezifität einer Adresse oder eines Geocodes. Adressspezifität in der Die validationGranularity-Antwort ist ein wichtiges Signal dafür, ob eine Adresse Liefergegenstand ist.

Das Attribut verdict gibt diese Granularitätssignale zurück:

• inputGranularity: Beschreibt die Detailgenauigkeit, die mithilfe der Adresse, die an die Address Validation API gesendet wird. Der Detaillierungsgrad der Adresse in der -Anfrage beeinflusst den Detaillierungsgrad der Adresse in der Validierungsantwort. Beispiel: Eine Adresse mit einem inputGranularity unter PREMISE unten führt normalerweise nicht zu einem validationGranularity bis PREMISE
• validationGranularity: Der Detaillierungsgrad, den die Die Address Validation API kann die Adresse vollständig validieren. In den meisten Fällen Der Detaillierungsgrad PREMISE oder SUB_PREMISE steht für eine hochwertige Adresse. der wahrscheinlich zu liefern ist.
• geocodeGranularity: Beschreibt die Detailgenauigkeit des Geocodes die mit der Adresse verknüpft sind. So können Google-Datensätze z. B. angeben, eine Wohnungsnummer vorhanden ist, aber keinen genauen Standort dafür. für eine bestimmte Wohnung in einem großen Wohnkomplex. In diesem Fall validationGranularity ist SUB_PREMISE, aber die geocodeGranularityisPREMISE.

Vollständigkeit der Adresse

Das Ergebnis gibt das Attribut addressComplete als Signal für einen qualitativ hochwertiger Adresse also keine fehlenden, ungelösten oder unerwarteten Komponenten:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

Wenn die Adresse fehlende, nicht aufgelöste oder unerwartete Komponenten enthält, wird das Feld ist auf false festgelegt.

Adressqualität

Eine Reihe möglicher Felder weist entweder auf Probleme mit Adresskomponenten hin Anpassungen wie abgeleitete oder fehlende Adresskomponenten. Für Beispiel: Die folgende verdict-Eigenschaft gibt eine Adresse an, bei der noch nicht bestätigt wurde. Komponenten und einem fehlenden addressComplete-Feld:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

Die Attribute address und addressComponent

Das Attribut address formatiert die verarbeitete Adresse, die in der Anfrage zusammen mit Zusammenfassungen der Adresse auf Komponentenebene, einschließlich falsch geschriebene Teile der Adresse; fehlerhafte Teile ersetzt und abgeleitete Informationen fehlen Teile.

Das Attribut addressComponent ist eine Unterkomponente von address und bietet folgende Vorteile: eine detaillierte Auflistung der Elemente oder Komponenten der Adresse, Address Validation API wurde verarbeitet. Die API identifiziert die einzelnen Komponenten nach Name, Typ und Bestätigungsebene liefert.

Das Attribut geocode

Die Eigenschaft geocode gibt den geocodierten Ort an, der mit der Eingabe verknüpft ist. Adresse. Diese Eigenschaft bietet Details zum Standort selbst, z. B. ihre Orts-ID.

Das Attribut metadata

Diese Eigenschaft wird möglicherweise nicht für jede Adresse ausgefüllt, die vom Address Validation API, gibt aber an, ob die Adresse vom Typ „Wohn“, Unternehmen oder ein Postfach.

Das Attribut uspsData

Diese Eigenschaft bietet nützliche Informationen zu Postanschriften in den USA. Es kann jedoch nicht garantiert werden, dass er für jede bestätigte Adresse vollständig ausgefüllt wird. durch den Dienst. Daher sollten Sie sich nicht auf diese Property als Adressen validieren, aber prüfen Sie stattdessen die verdict und address.