Die Address Validation API stellt einen Antworttext im JSON-Format bereit. , das zwei Eigenschaften der obersten Ebene enthält:
result
, ein Objekt vom TypValidationResult
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.
Weitere Informationen finden Sie unter Verdikt. |
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. Eine Adresse mit einerinputGranularity
unter einerPREMISE
führt beispielsweise in der Regel nicht zu einervalidationGranularity
bisPREMISE
.validationGranularity
: Der Detaillierungsgrad, den die Die Address Validation API kann die Adresse vollständig validieren. In den meisten Fällen Der DetaillierungsgradPREMISE
oderSUB_PREMISE
steht für eine hochwertige Adresse. der wahrscheinlich zu liefern ist.geocodeGranularity
: Gibt die Detailgenauigkeit des Geocodes an, der mit der Adresse verknüpft ist. 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 ist dievalidationGranularity
SUB_PREMISE
, aber diegeocodeGranularity
is
PREMISE.
Weitere Informationen finden Sie unter Detaillierungsgrad im Referenzleitfaden. |
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.
addressComplete ansehen unter
Verdikt und
Adresse. |
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
}
Siehe Verdikt im Referenzleitfaden. |
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.
Weitere Informationen finden Sie im Leitfaden unter Address . |
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.
Siehe addressComponent im Referenzleitfaden. |
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.
Weitere Informationen finden Sie im Leitfaden unter Geocode . |
Das Attribut metadata
Diese Eigenschaft ist möglicherweise nicht für jede Adresse ausgefüllt, die von der Address Validation API verarbeitet wird. Sie gibt jedoch an, ob es sich um eine Privat-, Geschäfts- oder Postfachadresse handelt.
Weitere Informationen finden Sie unter Abdeckung der Address Validation API und in der Referenz zu Address metadata .
|
Das Attribut uspsData
Diese Property enthält nützliche Informationen für Postadressen in den USA.
Es ist jedoch nicht garantiert, dass es für jede vom Dienst validierte Adresse vollständig ausgefüllt ist. Aus diesem Grund sollten Sie sich nicht nur auf dieses Attribut verlassen, um Adressen zu validieren, sondern auch verdict
und address
prüfen.
Weitere Informationen findest du unter Umgang mit US-Adressen und in der Referenz zu UspsData .
|