- HTTP-Anfrage
- Anfragetext
- Antworttext
- PostalAddress (Postanschrift)
- LanguageOptions
- ValidationResult
- Urteil
- Detaillierungsgrad
- Adresse
- AddressComponent
- ComponentName
- ConfirmationLevel
- Geocode erstellen
- LatLng
- PlusCode
- Darstellungsbereich
- AddressMetadata
- UspsData
- UspsAddress
Validiert eine Adresse.
HTTP-Anfrage
POST https://addressvalidation.googleapis.com/v1:validateAddress
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "address": { object ( |
Felder | |
---|---|
address |
Erforderlich. Die zu bestätigende Adresse. Nicht formatierte Adressen müssen über Die Gesamtlänge der Felder in dieser Eingabe darf 280 Zeichen nicht überschreiten. Unterstützte Regionen finden Sie hier. Der Wert Die Address Validation API ignoriert die Werte in |
previousResponseId |
Dieses Feld muss bei der ersten Anfrage zur Adressüberprüfung leer sein. Wenn mehrere Anfragen erforderlich sind, um eine einzelne Adresse vollständig zu validieren, z. B. wenn die Änderungen, die der Nutzer nach der ersten Überprüfung vornimmt, noch einmal validiert werden müssen, muss in jeder Folgeanfrage dieses Feld mit dem |
enableUspsCass |
Aktiviert den USPS CASS-kompatiblen Modus. Dies betrifft nur das Feld Es empfiehlt sich, eine |
languageOptions |
Optional. Vorabversion: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‑Funktionen werden eventuell nur eingeschränkt unterstützt. Außerdem sind Änderungen an diesen Produkten und Funktionen möglicherweise nicht mit anderen pre-GA-Versionen kompatibel. Pre-GA-Angebote sind durch die dienstspezifischen Nutzungsbedingungen für die Google Maps Platform abgedeckt. Weitere Informationen finden Sie unter Beschreibungen der Startphase. Hiermit kann die Address Validation API zusätzliche Informationen in die Antwort aufnehmen. |
sessionToken |
Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss ein URL- und Dateiname-sicherer Base64-String mit maximal 36 ASCII-Zeichen sein. Andernfalls wird der Fehler INVALID_ ARGUMENT zurückgegeben. Die Sitzung beginnt, wenn der Nutzer eine Autocomplete-Abfrage stellt, und endet, wenn er einen Ort auswählt und ein Aufruf von Place Details oder Address Validation erfolgt. Jede Sitzung kann mehrere Autocomplete-Abfragen enthalten, gefolgt von einer Place Details- oder Address Validation-Anfrage. Die für die einzelnen Anfragen innerhalb einer Sitzung verwendeten Anmeldedaten müssen zum selben Google Cloud Console-Projekt gehören. Sobald eine Sitzung beendet ist, ist das Token nicht mehr gültig. Ihre App muss für jede Sitzung ein neues Token generieren. Wenn der Parameter Hinweis: Address Validation kann nur in Sitzungen mit der Autocomplete (New) API verwendet werden, nicht in der Autocomplete API. Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/places/web-service/session-pricing. |
Antworttext
Die Antwort auf eine Anfrage zur Adressüberprüfung.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"result": {
object ( |
Felder | |
---|---|
result |
Das Ergebnis der Adressvalidierung. |
responseId |
Die UUID, die diese Antwort identifiziert. Muss die Adresse noch einmal validiert werden, muss diese UUID der neuen Anfrage beigefügt werden. |
PostalAddress
Stellt eine Postadresse dar, z. B. für Postzustellungs- oder Zahlungsadressen. Mit einer Postadresse kann ein Postdienst Artikel an eine Einrichtung, ein Postfach oder eine andere Adresse liefern. Sie stellt kein Modell eines geografischen Standorts (Straßen, Städte, Berge) dar.
Normalerweise wird eine Adresse je nach Prozesstyp durch eine Nutzereingabe oder den Import vorhandener Daten erstellt.
Hinweise zur Adresseingabe/-bearbeitung: Verwenden Sie ein internationalisierungsfähiges Adress-Widget wie https://github.com/google/libaddressinput. Nutzern sollten keine UI-Elemente für die Eingabe oder Bearbeitung von Feldern außerhalb der Länder angezeigt werden, in denen das Feld verwendet wird.
Weitere Informationen zur Verwendung dieses Schemas finden Sie unter https://support.google.com/business/answer/6397478.
JSON-Darstellung |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Felder | |
---|---|
revision |
Die Schemaversion von |
regionCode |
Optional. CLDR-Regionscode des Landes bzw. der Region der Adresse. Weitere Informationen finden Sie unter https://cldr.unicode.org/ und https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Beispiel: "CH" für die Schweiz. Wenn der Regionscode nicht angegeben ist, wird er von der Adresse abgeleitet. Für eine optimale Leistung empfiehlt es sich, den Regionscode anzugeben, sofern Sie ihn kennen. Inkonsistente oder wiederholte Regionen können die Leistung beeinträchtigen. Wenn beispielsweise die Region in |
languageCode |
Der Sprachcode in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird heute ignoriert. Die API gibt die Adresse in der Sprache zurück, in der sich die Adresse befindet. |
postalCode |
Optional. Postleitzahl der Adresse. Postleitzahlen werden nicht in allen Ländern verwendet oder benötigt. Dort, wo sie verwendet werden, können sie weitere Validierungsvorgänge für andere Adressteile nach sich ziehen, z. B. die Validierung von Bundesstaat/Postleitzahl in den USA. |
sortingCode |
Optional. Zusätzlicher länderspezifischer Sortiercode. Dieser wird nur für wenige Regionen genutzt. Wenn er verwendet wird, ist der Wert entweder ein String wie "CEDEX", optional gefolgt von einer Ziffer (z. B. "CEDEX 7"), oder nur eine Ziffer für den Sektorcode (Jamaika), den Zustellbereichsindikator (Malawi) oder den Postamtindikator (z. B. Elfenbeinküste). |
administrativeArea |
Optional. Höchste administrative Untergliederung, die für Postadressen eines Landes oder einer Region verwendet wird. Dies kann beispielsweise ein Bundesland, eine Provinz, eine Oblast oder eine Präfektur sein. In Spanien ist dies beispielsweise die Provinz und nicht das autonome Gebiet, also z. B. "Barcelona" und nicht "Katalonien". In vielen Ländern werden in der Postadresse keine Verwaltungsgebiete verwendet. Für die Schweiz etwa sollte dieses Feld leer gelassen werden. |
locality |
Optional. Bezieht sich in der Regel auf die Stadt-/Ortsangabe der Adresse. Beispiele: Stadt in den USA, italienische Gemeinde, Post Town in Großbritannien. Lassen Sie in Regionen der Welt, in denen Lokalitäten nicht hinreichend definiert sind oder nicht dieser Struktur entsprechen, diese Angabe leer und verwenden Sie stattdessen "addressLines". |
sublocality |
Optional. Unterlokalität der Adresse. Dies können beispielsweise Stadtviertel, Stadtteile und Bezirke sein. |
addressLines[] |
Erforderlich. Unstrukturierte Adresszeilen, mit denen die unteren Ebenen einer Adresse beschrieben werden. |
recipients[] |
Vermeiden Sie es, in diesem Feld anzugeben. Sie wird derzeit nicht von der Address Validation API verwendet. Derzeit lehnt die API zwar Anfragen mit diesem Feld nicht ab, die Informationen werden aber verworfen und nicht in der Antwort zurückgegeben. |
organization |
Vermeiden Sie es, in diesem Feld anzugeben. Sie wird derzeit nicht von der Address Validation API verwendet. Derzeit lehnt die API zwar Anfragen mit diesem Feld nicht ab, die Informationen werden aber verworfen und nicht in der Antwort zurückgegeben. |
LanguageOptions
Vorabversion: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‑Funktionen werden eventuell nur eingeschränkt unterstützt. Außerdem sind Änderungen an diesen Produkten und Funktionen möglicherweise nicht mit anderen pre-GA-Versionen kompatibel. Pre-GA-Angebote sind durch die dienstspezifischen Nutzungsbedingungen für die Google Maps Platform abgedeckt. Weitere Informationen finden Sie unter Beschreibungen der Startphase.
Hiermit kann die Address Validation API zusätzliche Informationen in die Antwort aufnehmen.
JSON-Darstellung |
---|
{ "returnEnglishLatinAddress": boolean } |
Felder | |
---|---|
returnEnglishLatinAddress |
Vorschau: Geben Sie |
ValidationResult
Das Ergebnis der Adressüberprüfung.
JSON-Darstellung |
---|
{ "verdict": { object ( |
Felder | |
---|---|
verdict |
Flags für das Gesamtergebnis |
address |
Informationen zur Adresse selbst, im Gegensatz zum Geocode. |
geocode |
Informationen über den Standort und den Ort, für den die Adresse das Geocoding durchgeführt hat. |
metadata |
Weitere Informationen, die für die Lieferbarkeit relevant sind. Das Feld |
uspsData |
Flags für zusätzliche Zustellbarkeit wurden von USPS bereitgestellt. Nur in den Regionen |
englishLatinAddress |
Vorabversion: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‑Funktionen werden eventuell nur eingeschränkt unterstützt. Außerdem sind Änderungen an diesen Produkten und Funktionen möglicherweise nicht mit anderen pre-GA-Versionen kompatibel. Pre-GA-Angebote sind durch die dienstspezifischen Nutzungsbedingungen für die Google Maps Platform abgedeckt. Weitere Informationen finden Sie unter Beschreibungen der Startphase. Die Adresse wird ins Englische übersetzt. Übersetzte Adressen können nicht als API-Eingabe wiederverwendet werden. Der Dienst stellt sie zur Verfügung, damit Nutzer die Bestätigung der ursprünglich angegebenen Adresse in ihrer Muttersprache bestätigen oder ablehnen können. Wenn es für einen Teil der Adresse keine englische Übersetzung gibt, gibt der Dienst diesen Teil in einer alternativen Sprache mit lateinischer Schrift zurück. Weitere Informationen dazu, wie die alternative Sprache ausgewählt wird, finden Sie hier. Wenn für einen Teil der Adresse keine Übersetzungen oder Transkriptionen in einer Sprache mit lateinischer Schrift verfügbar sind, gibt der Dienst diesen Teil in der mit der Adresse verknüpften lokalen Sprache zurück. Aktivieren Sie diese Ausgabe mit dem Flag Hinweis: Das Feld |
Ergebnis
Allgemeine Übersicht über das Ergebnis und die Geocodierung der Adresse
JSON-Darstellung |
---|
{ "inputGranularity": enum ( |
Felder | |
---|---|
inputGranularity |
Der Detaillierungsgrad der input-Adresse. Dies ist das Ergebnis des Parsens der Eingabeadresse. Es werden keine Validierungssignale ausgegeben. Informationen zu Validierungssignalen finden Sie unter Wenn die eingegebene Adresse beispielsweise eine bestimmte Wohnungsnummer enthält, lautet |
validationGranularity |
Der Detaillierungsgrad, mit dem die API die Adresse vollständig validate kann. Ein Das Validierungsergebnis für die einzelnen Adresskomponenten finden Sie in |
geocodeGranularity |
Informationen zum Detaillierungsgrad von Diese kann gelegentlich vom obigen |
addressComplete |
Die Adresse gilt als vollständig, wenn es keine nicht aufgelösten Tokens oder keine unerwarteten oder fehlenden Adresskomponenten gibt. Wenn kein Wert festgelegt ist, wird der Wert auf |
hasUnconfirmedComponents |
Mindestens eine Adresskomponente kann nicht kategorisiert oder validiert werden. Weitere Informationen finden Sie unter |
hasInferredComponents |
Mindestens eine Adresskomponente wurde abgeleitet (hinzugefügt), die nicht in der Eingabe enthalten war. Weitere Informationen finden Sie unter |
hasReplacedComponents |
Mindestens eine Adresskomponente wurde ersetzt. Weitere Informationen finden Sie unter |
Detaillierungsgrad
Die verschiedenen Detaillierungsgrad, die eine Adresse oder ein Geocode haben kann. Wenn diese Werte zur Angabe des Detaillierungsgrads für eine Adresse verwendet werden, geben diese Werte den Detaillierungsgrad an, mit dem die Adresse eine Postanschrift identifiziert. Beispielsweise identifiziert eine Adresse wie „123 Main Street, Redwood City, CA, 94061“ ein PREMISE
, während etwas wie „Redwood City, CA, 94061“ ein LOCALITY
identifiziert. Wenn wir jedoch keinen Geocode für die „Hauptstraße 123“ in Redwood City finden, kann der zurückgegebene Geocode den Detaillierungsgrad LOCALITY
haben, obwohl die Adresse detaillierter ist.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
SUB_PREMISE |
Ergebnis unterhalb der Gebäudeebene, z. B. eine Wohnung. |
PREMISE |
Ergebnis auf Gebäudeebene. |
PREMISE_PROXIMITY |
Ein Geocode, der den Standort der Adresse auf Gebäudeebene nähert. |
BLOCK |
Die Adresse bzw. der Geocode steht für einen Block. Wird nur in Regionen mit Adressierung auf Blockebene verwendet, z. B. Japan. |
ROUTE |
Der Geocode oder die Adresse ist detailliert für die Route, z. B. eine Straße, eine Straße oder eine Autobahn. |
OTHER |
Alle anderen Detaillierungen, die zu einer Gruppe zusammengefasst werden, da sie nicht lieferbar sind. |
Adresse
Details zur nachbearbeiteten Adresse. Die Nachbearbeitung umfasst das Korrigieren falsch geschriebener Teile der Adresse, das Ersetzen falscher Teile und die Ableitung fehlender Teile.
JSON-Darstellung |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
Felder | |
---|---|
formattedAddress |
Die nachbearbeitete Adresse, die gemäß den Formatierungsregeln der Region, in der sich die Adresse befindet, als einzeilige Adresse formatiert wird. |
postalAddress |
Die nachbearbeitete Adresse, dargestellt als Postanschrift. |
addressComponents[] |
Unsortierte Liste. Die einzelnen Adresskomponenten der formatierten und korrigierten Adresse sowie Validierungsinformationen. Sie erhalten Informationen zum Validierungsstatus der einzelnen Komponenten. Die Adresskomponenten sind nicht auf eine bestimmte Weise angeordnet. Machen Sie keine Annahmen über die Reihenfolge der Adresskomponenten in der Liste. |
missingComponentTypes[] |
Die Komponenten, die in einer korrekt formatierten Postanschrift vorhanden sein sollten, aber in der Eingabe nicht gefunden wurden UND konnten nicht abgeleitet werden. Komponenten dieses Typs sind in |
unconfirmedComponentTypes[] |
Die Komponententypen, die in der |
unresolvedTokens[] |
Alle Tokens in der Eingabe, die nicht aufgelöst werden konnten. Dies kann eine Eingabe sein, die nicht als gültiger Teil einer Adresse erkannt wurde. In einer Eingabe wie „123235253253 Main St, San Francisco, CA, 94105“ können die nicht aufgelösten Tokens beispielsweise wie |
AddressComponent
Eine Adresskomponente, z. B. Straße, Stadt oder Bundesland
JSON-Darstellung |
---|
{ "componentName": { object ( |
Felder | |
---|---|
componentName |
Der Name für diese Komponente. |
componentType |
Der Typ der Adresskomponente. Eine Liste möglicher Typen finden Sie in Tabelle 2: Zusätzliche vom Places-Dienst zurückgegebene Typen. |
confirmationLevel |
Gibt an, wie sicher wir sind, dass die Komponente korrekt ist. |
inferred |
Gibt an, dass die Komponente nicht Teil der Eingabe war, aber wir haben sie für den Adressstandort abgeleitet und glauben, dass sie für eine vollständige Adresse bereitgestellt werden sollte. |
spellCorrected |
Weist auf eine Korrektur eines Rechtschreibfehlers im Komponentennamen hin. Die API meldet Änderungen von einer Rechtschreibvariante zu einer anderen nicht immer, z. B. wenn „Zentrum“ zu „Zentrum“ geändert wird. Außerdem werden häufig falsch geschriebene Wörter nicht immer erkannt, z. B. wenn „Amphitheater Pkwy“ in „Amphitheatre Pkwy“ geändert wird. |
replaced |
Gibt an, dass der Name der Komponente durch eine völlig andere ersetzt wurde, z. B. dass eine falsche Postleitzahl durch eine für die Adresse richtige Postleitzahl ersetzt wurde. Dies ist keine kosmetische Änderung. Die Eingabekomponente wurde geändert. |
unexpected |
Gibt eine Adresskomponente an, die voraussichtlich nicht in einer Postanschrift für die angegebene Region vorhanden ist. Wir haben sie nur beibehalten, weil sie Teil der Eingabe war. |
ComponentName
Ein Wrapper für den Namen der Komponente.
JSON-Darstellung |
---|
{ "text": string, "languageCode": string } |
Felder | |
---|---|
text |
Der Namenstext. Beispiel: „5th Avenue“ für einen Straßennamen oder „1253“ für eine Hausnummer. |
languageCode |
Der BCP-47-Sprachcode. Er ist nicht vorhanden, wenn der Komponentenname nicht mit einer Sprache verknüpft ist, z. B. mit einer Hausnummer. |
ConfirmationLevel
Die verschiedenen möglichen Werte für Bestätigungsebenen.
Enums | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
CONFIRMED |
Wir konnten bestätigen, dass diese Komponente existiert und im Kontext der übrigen Adresse sinnvoll ist. |
UNCONFIRMED_BUT_PLAUSIBLE |
Diese Komponente konnte nicht bestätigt werden, es ist jedoch möglich, dass sie vorhanden ist. Zum Beispiel eine Hausnummer innerhalb eines bekannten gültigen Nummernbereichs auf einer Straße, für die bestimmte Hausnummern nicht bekannt sind. |
UNCONFIRMED_AND_SUSPICIOUS |
Diese Komponente wurde nicht bestätigt und ist wahrscheinlich falsch. Zum Beispiel ein Viertel, das nicht zum Rest der Adresse passt. |
Geocodieren
Enthält Informationen über den Ort, für den die Eingabe geocodiert wurde.
JSON-Darstellung |
---|
{ "location": { object ( |
Felder | |
---|---|
location |
Der geocodierte Standort der Eingabe. Orts-IDs sollten gegenüber Adressen, Breiten- und Längengradkoordinaten oder Plus Codes bevorzugt verwendet werden. Die Verwendung von Koordinaten bei der Routenplanung oder Berechnung von Wegbeschreibungen führt immer dazu, dass der Punkt an der Straße ausgerichtet wird, die diesen Koordinaten am nächsten ist. Dies darf keine Straße sein, die schnell oder sicher zum Ziel führt und sich nicht in der Nähe eines Zugangspunkts zum Objekt befindet. Außerdem gibt es bei einer umgekehrten Geocodierung eines Standorts keine Garantie, dass die zurückgegebene Adresse mit der ursprünglichen Adresse übereinstimmt. |
plusCode |
Der Plus Code für |
bounds |
Die Grenzen des geocodierten Orts. |
featureSizeMeters |
Die Größe des geocodierten Orts in Metern. Dies ist ein weiteres Maß für die Grobheit des geocodierten Orts, jedoch nicht in semantisch, sondern in physikalischer Größe. |
placeId |
Die PlaceID des Orts, für den diese Eingabe geocodiert wird. |
placeTypes[] |
Die Art(en) des Ortes, für den die Eingabe das Geocoding vorgenommen hat. Beispiel: |
LatLng
Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Dies wird als Paar von Double-Werten (Breiten- und Längengrad) ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.
JSON-Darstellung |
---|
{ "latitude": number, "longitude": number } |
Felder | |
---|---|
latitude |
Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen. |
longitude |
Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen. |
PlusCode
Plus Code (http://plus.codes) ist eine Standortreferenz in zwei Formaten: Globaler Code, der ein Rechteck mit einer Größe von 14 MXN14 m (1/8.000 Grad eines Grads) oder kleiner definiert, und Kompoundcode, bei dem das Präfix durch eine Referenzposition ersetzt wird.
JSON-Darstellung |
---|
{ "globalCode": string, "compoundCode": string } |
Felder | |
---|---|
globalCode |
Der globale (vollständige) Code des Orts, z. B. „9FWM33GV+HQ“, der eine Fläche von 1/8.000 × 1/8.000 Grad (ca. 14 × 14 Meter) darstellt. |
compoundCode |
Zusammengesetzter Code eines Orts, z. B. „33GV+HQ, Ramberg, Norway“, der das Suffix des globalen Codes enthält und das Präfix durch den formatierten Namen einer Referenzentität ersetzt |
Darstellungsbereich
Ein Darstellungsbereich für Breiten- und Längengrad, dargestellt als zwei diagonal gegenüberliegende Punkte von low
und high
. Ein Darstellungsbereich wird als geschlossener Bereich betrachtet, d.h. er enthält seine Begrenzung. Die Breitengradgrenzen müssen zwischen -90 und 90 Grad liegen und die Längengradgrenzen zwischen -180 und 180 Grad (jeweils einschließlich). Verschiedene Fälle sind:
Wenn
low
=high
ist, besteht der Darstellungsbereich aus diesem einzelnen Punkt.Wenn
low.longitude
>high.longitude
ist, wird der Längengradbereich invertiert (der Darstellungsbereich kreuzt die 180-Grad-Längengradlinie).Ist
low.longitude
= -180 Grad undhigh.longitude
= 180 Grad, enthält der Darstellungsbereich alle Längengrade.Wenn
low.longitude
= 180 Grad undhigh.longitude
= -180 Grad ist, ist der Längengradbereich leer.Wenn
low.latitude
>high.latitude
ist, ist der Breitengradbereich leer.
Sowohl low
als auch high
müssen ausgefüllt werden und das dargestellte Feld darf nicht leer sein (wie in den Definitionen oben angegeben). Ein leerer Darstellungsbereich führt zu einem Fehler.
Dieser Darstellungsbereich umfasst beispielsweise New York City:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON-Darstellung |
---|
{ "low": { object ( |
Felder | |
---|---|
low |
Erforderlich. Der Tiefstpunkt des Darstellungsbereichs. |
high |
Erforderlich. Der höchste Punkt im Darstellungsbereich. |
AddressMetadata
Die Metadaten für die Adresse. Das Feld metadata
wird möglicherweise nicht für jede Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt.
JSON-Darstellung |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
Felder | |
---|---|
business |
Gibt an, dass dies die Adresse eines Unternehmens ist. Wenn nicht festgelegt, ist der Wert unbekannt. |
poBox |
Gibt die Adresse eines Postfachs an. Wenn nicht festgelegt, ist der Wert unbekannt. |
residential |
Gibt an, dass dies die Adresse eines Wohnsitzes ist. Wenn nicht festgelegt, ist der Wert unbekannt. |
UspsData
Die USPS-Daten für die Adresse. Es wird nicht garantiert, dass uspsData
für jede US- oder PR-Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt wird. Es wird empfohlen, die Backup-Adressfelder in die Antwort zu integrieren, wenn du uspsData als primären Teil der Antwort verwendest.
JSON-Darstellung |
---|
{
"standardizedAddress": {
object ( |
Felder | |
---|---|
standardizedAddress |
Standardisierte USPS-Adresse. |
deliveryPointCode |
2-stelliger Code der Lieferstelle |
deliveryPointCheckDigit |
Die Prüfziffer für den Lieferort. Bei mechanisch gescannten E-Mails wird diese Nummer am Ende des „delivery_point_barcode“ eingefügt. Die Addition aller Ziffern von delivery_point_barcode, deliveryPointCheckDigit, der Postleitzahl und der ZIP+4-Nummer ergibt eine durch 10 teilbare Zahl. |
dpvConfirmation |
Mögliche Werte für die DPV-Bestätigung. Gibt ein einzelnes Zeichen oder keinen Wert zurück.
|
dpvFootnote |
Die Fußnoten aus der Validierung der Lieferpunkte. Mehrere Fußnoten können in derselben Zeichenfolge aneinandergereiht werden.
|
dpvCmra |
Gibt an, ob die Adresse eine CMRA (Commercial Mail Receiving Agency) ist – ein privates Unternehmen, das Post für Kunden erhält. Gibt ein einzelnes Zeichen zurück.
|
dpvVacant |
Ist dieser Ort leer? Gibt ein einzelnes Zeichen zurück.
|
dpvNoStat |
Ist dies eine Adresse ohne Statistik oder eine aktive Adresse? Keine Statistik-Adressen sind Adressen, die nicht ständig belegt sind oder die nicht von USPS bedient werden. Gibt ein einzelnes Zeichen zurück.
|
dpvNoStatReasonCode |
Gibt den Typ NoStat an. Gibt einen Ursachencode als int zurück.
|
dpvDrop |
Das Flag gibt an, dass die E-Mail an einen einzelnen Empfänger eines Standorts zugestellt wird. Gibt ein einzelnes Zeichen zurück.
|
dpvThrowback |
Gibt an, dass E-Mails nicht an die Adresse zugestellt werden. Gibt ein einzelnes Zeichen zurück.
|
dpvNonDeliveryDays |
Das Flag gibt an, dass die E-Mail nicht an jedem Wochentag zugestellt wird. Gibt ein einzelnes Zeichen zurück.
|
dpvNonDeliveryDaysValues |
Ganzzahl, die die Tage der Nicht-Auslieferung angibt. Er kann mit Bit-Flags abgefragt werden: 0x40 – Sonntag ist ein Tag der Nichtlieferung 0x20 – Montag ist ein Tag der Nichtlieferung 0x10 – Dienstag ist ein Tag der Nichtlieferung 0x08 – Mittwoch ist ein Tag der Nichtlieferung 0x04 – Donnerstag ist ein Tag der Nichtlieferung 0x02 – Freitag ist ein Tag der Nichtlieferung 0x01 |
dpvNoSecureLocation |
Flagge zeigt an, dass die Tür zugänglich ist, aber das Paket wird aus Sicherheitsgründen nicht abgelegt. Gibt ein einzelnes Zeichen zurück.
|
dpvPbsa |
Gibt an, dass die Adresse mit dem PBSA-Eintrag abgeglichen wurde. Gibt ein einzelnes Zeichen zurück.
|
dpvDoorNotAccessible |
Flagge zeigt Adressen an, bei denen USPS nicht an die Tür klopfen kann, um Post zuzustellen. Gibt ein einzelnes Zeichen zurück.
|
dpvEnhancedDeliveryCode |
Gibt an, dass mehr als ein DPV-Rückgabecode für die Adresse gültig ist. Gibt ein einzelnes Zeichen zurück.
|
carrierRoute |
Der Routencode des Transportunternehmens. Ein vierstelliger Code, der aus einem Präfix aus einem Buchstaben und einem dreistelligen Routenbezeichner besteht. Präfixe:
|
carrierRouteIndicator |
Sortieranzeige für Versandpreise für Transportunternehmen. |
ewsNoMatch |
Die Lieferadresse kann abgeglichen werden, aber aus der EWS-Datei geht hervor, dass in Kürze eine genaue Übereinstimmung verfügbar sein wird. |
postOfficeCity |
Stadt der Hauptpostfiliale. |
postOfficeState |
Hauptpostfiliale. |
abbreviatedCity |
Gekürzte Stadt. |
fipsCountyCode |
FIPS-Bezirkscode. |
county |
Landkreis |
elotNumber |
eLOT-Nummer (Enhanced Line of Travel) |
elotFlag |
Aufsteigendes/absteigendes eLOT-Flag (A/D). |
lacsLinkReturnCode |
LACSLink-Rückgabecode. |
lacsLinkIndicator |
LACSLink-Indikator. |
poBoxOnlyPostalCode |
Postleitzahl (nur Postfach). |
suitelinkFootnote |
Fußnoten, die mit einer Aufnahme in eine Straße oder ein Hochhaus übereinstimmen oder mit Informationen zur Wohnung Wenn der Name des Unternehmens übereinstimmt, wird die Zweitnummer zurückgegeben.
|
pmbDesignator |
PMB-Einheit (Private Mail Box) |
pmbNumber |
PMB-Nummer (Private Mail Box): |
addressRecordType |
Typ des Adresseintrags, der mit der Eingabeadresse übereinstimmt.
|
defaultAddress |
Zeigt an, dass eine Standardadresse gefunden wurde, aber spezifischere Adressen vorhanden sind. |
errorMessage |
Fehlermeldung zum Abrufen von USPS-Daten. Dieses Feld wird ausgefüllt, wenn die USPS-Verarbeitung aufgrund der Erkennung von künstlich erstellten Adressen ausgesetzt wurde. Wenn dieser Fehler auftritt, werden die USPS-Datenfelder möglicherweise nicht ausgefüllt. |
cassProcessed |
Zeigt an, dass die Anfrage CASS verarbeitet wurde. |
UspsAddress
USPS-Darstellung einer US-Adresse.
JSON-Darstellung |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
Felder | |
---|---|
firstAddressLine |
Erste Adresszeile. |
firm |
Name des Unternehmens. |
secondAddressLine |
Zweite Adresszeile. |
urbanization |
Puerto-ricanischer Urbanisierungsname. |
cityStateZipAddressLine |
Stadt + Bundesland + Postleitzahl. |
city |
Stadt |
state |
2-stelliger Bundesstaatcode. |
zipCode |
Postleitzahl, z.B. 10009. |
zipCodeExtension |
4-stellige Postleitzahlerweiterung, z.B. 5023. |