Method: validateAddress

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 (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean
}
Felder
address

object (PostalAddress)

Erforderlich. Die zu validierende Adresse. Nicht formatierte Adressen müssen über addressLines eingereicht werden.

Die Gesamtlänge der Felder in dieser Eingabe darf 280 Zeichen nicht überschreiten.

Unterstützte Regionen

Der languageCode-Wert in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird heute ignoriert. Das Ergebnis der bestätigten Adresse wird anhand der vom System ermittelten, bevorzugten Sprache der angegebenen Adresse ausgefüllt.

Die Address Validation API ignoriert die Werte in recipients und organization. Alle Werte in diesen Feldern werden verworfen und nicht zurückgegeben. Legen Sie sie nicht fest.

previousResponseId

string

Dieses Feld muss für die erste Anfrage zur Adressbestätigung leer sein. Wenn mehr Anfragen erforderlich sind, um eine einzelne Adresse vollständig zu validieren (z. B. wenn die Änderungen des Nutzers nach der ersten Validierung noch einmal überprüft werden müssen), muss in jeder nachfolgenden Anfrage das Feld responseId aus der allerersten Antwort in der Sequenz verwendet werden.

enableUspsCass

boolean

Aktiviert den Modus „PSS CASS“. Dies wirkt sich nur auf das Feld google.maps.addressvalidation.v1.ValidationResult.usps_data von google.maps.addressvalidation.v1.ValidationResult aus. Hinweis: Für USPS-CASS-fähige Anfragen für Adressen in Puerto Rico muss eine google.type.PostalAddress.region_code der address als "PR" angegeben werden oder eine google.type.PostalAddress.administrative_area der address muss als "Puerto Rico" (Groß-/Kleinschreibung nicht berücksichtigend) oder "PR" angegeben werden.

Es wird empfohlen, ein komponentenbasiertes address-Element zu verwenden. Alternativ können Sie auch mindestens zwei google.type.PostalAddress.address_lines angeben, wobei die erste Zeile die Hausnummer und den Namen enthält, die zweite Zeile die Stadt, das Bundesland und die Postleitzahl.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Die Antwort auf eine Anfrage zur Adressbestätigung.

JSON-Darstellung
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Felder
result

object (ValidationResult)

Das Ergebnis der Validierung der Adresse.

responseId

string

Die UUID, die diese Antwort identifiziert. Eine erneute Validierung der Adresse muss durch die UUID begleitet 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 für die Internationalisierung geeignetes Adress-Widget wie https://github.com/google/libaddressinput. Nutzer sollten in anderen Ländern keine Felder für die Eingabe oder Bearbeitung von Feldern sehen, 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

integer

Die Schemaüberarbeitung von PostalAddress. Bei allen Werten außer 0 wird von der API der Fehler INVALID_ARGUMENT zurückgegeben.

regionCode

string

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/additional/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 sollten Sie den Regionscode angeben, wenn Sie ihn kennen. Inkonsistente oder wiederholte Regionen können zu Leistungseinbußen führen. Wenn der addressLines beispielsweise bereits die Region enthält, geben Sie den Regionscode nicht noch einmal in dieses Feld ein. Unterstützte Regionen finden Sie in den FAQs.

languageCode

string

Der Sprachcode in der Eingabeadresse ist für zukünftige Verwendungszwecke reserviert und wird heute ignoriert. Die API gibt die Adresse in der Sprache zurück, in der sie sich befindet.

postalCode

string

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

string

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

string

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

string

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

string

Optional. Unterlokalität der Adresse. Dies können beispielsweise Stadtviertel, Stadtteile und Bezirke sein.

addressLines[]

string

Erforderlich. Unstrukturierte Adresszeilen, mit denen die unteren Ebenen einer Adresse beschrieben werden.

Da Werte in „addressLines“ keine Typinformationen enthalten und manchmal mehrere Werte in einem einzelnen Feld enthalten sind (z.B. „Austin, TX“), ist es wichtig, dass die Zeilenreihenfolge klar ist. Die Reihenfolge der Adresszeilen sollte der Adresse auf einem Briefumschlag für das Land bzw. die Region entsprechen.

Die geringste zulässige Struktur einer Adresse besteht aus allen Informationen, die in die addressLines aufgenommen werden. Wenn kein regionCode angegeben ist, wird die Region aus den Adresszeilen abgeleitet.

Wir empfehlen, eine Adresse zu erstellen, die nur addressLines enthält, und dann das Geocoding, um vollständig unstrukturierte Adressen zu verarbeiten. So müssen Sie nicht raten, welche Teile der Adresse Orte oder Verwaltungsgebiete umfassen.

recipients[]

string

Bitte lege dieses Feld nicht fest. Die Address Validation API verwendet sie derzeit nicht. Derzeit lehnt die API Anfragen mit diesem Feld nicht ab. Die Informationen werden jedoch verworfen und in der Antwort nicht zurückgegeben.

organization

string

Bitte lege dieses Feld nicht fest. Die Address Validation API verwendet sie derzeit nicht. Derzeit lehnt die API Anfragen mit diesem Feld nicht ab. Die Informationen werden jedoch verworfen und in der Antwort nicht zurückgegeben.

ValidationResult

Das Ergebnis der Validierung einer Adresse.

JSON-Darstellung
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  }
}
Felder
verdict

object (Verdict)

Meldungen zum Urteil insgesamt

address

object (Address)

Informationen zur Adresse selbst, nicht zum Geocode

geocode

object (Geocode)

Informationen zum Ort und Ort, an den die Adresse geocodiert wurde.

metadata

object (AddressMetadata)

Sonstige für die Bereitstellung relevante Informationen. Es ist nicht garantiert, dass metadata bei jeder Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt ist.

uspsData

object (UspsData)

Zusätzliche Zustellungsflags von USPS. Nur in den Regionen US und PR angegeben.

Ergebnis

Eine allgemeine Übersicht über das Ergebnis der Adressenbestätigung und die Geocodierung.

JSON-Darstellung
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Felder
inputGranularity

enum (Granularity)

Der Detaillierungsgrad der Eingabeadresse. Das ist das Ergebnis des Parsens der Eingabeadresse und liefert keine Validierungssignale. Informationen zu Validierungssignalen finden Sie unten im Abschnitt validationGranularity.

Wenn die Eingabeadresse beispielsweise eine bestimmte Wohnungsnummer enthält, ist inputGranularity hier SUB_PREMISE. Wenn wir die Wohnungsnummer in den Datenbanken nicht abgleichen können oder die Wohnungsnummer ungültig ist, beträgt die validationGranularity wahrscheinlich PREMISE oder niedriger.

validationGranularity

enum (Granularity)

Der Detaillierungsgrad, mit dem die API die Adresse vollständig überprüfen kann. Beispiel: validationGranularity mit PREMISE gibt an, dass alle Adresskomponenten auf der Ebene PREMISE oder mehr grob validiert werden können.

Das Ergebnis der Überprüfung der Adresskomponenten findest du unter google.maps.addressvalidation.v1.Address.address_components.

geocodeGranularity

enum (Granularity)

Informationen zum Detaillierungsgrad von geocode. Dies kann als die semantische Bedeutung von grobem und fein abgestimmtem Standort interpretiert werden.

Dies kann gelegentlich von den oben genannten validationGranularity abweichen. So kann beispielsweise in unserer Datenbank das Vorhandensein einer Wohnungsnummer erfasst werden, Sie haben jedoch keinen genauen Standort für diese Wohnung in einer großen Wohnanlage. In diesem Fall ist validationGranularity SUB_PREMISE, geocodeGranularity jedoch PREMISE.

addressComplete

boolean

Die Adresse wird als vollständig betrachtet, wenn es keine unaufgelösten Tokens oder keine unerwarteten oder fehlenden Adresskomponenten gibt. Weitere Informationen findest du in den Feldern missingComponentTypes, unresolvedTokens und unexpected.

hasUnconfirmedComponents

boolean

Mindestens eine Adresskomponente kann nicht kategorisiert oder validiert werden. Weitere Informationen finden Sie unter google.maps.addressvalidation.v1.Address.address_components.

hasInferredComponents

boolean

Mindestens eine Adresskomponente wurde abgeleitet (hinzugefügt), die nicht in der Eingabe enthalten war. Weitere Informationen finden Sie unter google.maps.addressvalidation.v1.Address.address_components.

hasReplacedComponents

boolean

Mindestens eine Adresskomponente wurde ersetzt. Weitere Informationen finden Sie unter google.maps.addressvalidation.v1.Address.address_components.

Detaillierungsgrad

Die verschiedenen Detaillierungsgrade, die eine Adresse oder ein Geocode haben kann. Wenn Sie den Detaillierungsgrad für eine Adresse angeben, geben diese Werte an, wie detailliert die Adresse ist. So erkennt beispielsweise eine Adresse wie „Hauptstraße 123, 12347 Berlin“ eine PREMISE, während eine Adresse wie „Redwood City, Kalifornien, 94061“ eine LOCALITY identifiziert. Wenn wir jedoch keine Geocoding-Anfrage für „Hauptstraße 123“ in Redwood City finden können, ist diese möglicherweise über den Detaillierungsgrad LOCALITY möglich, obwohl die Adresse detaillierter ist.

Enums
GRANULARITY_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
SUB_PREMISE Ergebnisse unter dem Gebäude, z. B. eine Wohnung
PREMISE Ergebnis auf Gebäudeebene.
PREMISE_PROXIMITY Ein Geocode, der den ungefähren Standort auf Gebäudeebene der Adresse angibt.
BLOCK Die Adresse oder der Geocode gibt einen Block an. Wird nur in Regionen mit Adressierung auf Blockebene verwendet, z. B. Japan.
ROUTE Der Geocode oder die Adresse ist eine Route, z. B. eine Straße, eine Straße oder eine Autobahn.
OTHER Alle anderen Detaillierungsgrade, die in Buckets zusammengefasst werden, da sie nicht zustellbar sind.

Adresse

Details zur Nachverarbeitung der Adresse. Die Nachbearbeitung umfasst die Korrektur falsch geschriebener Teile der Adresse, den Austausch falscher Teile und die Ableitung fehlender Teile.

JSON-Darstellung
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Felder
formattedAddress

string

Die nach der Bearbeitungszeit verarbeitete Adresse, die als einzeilige Adresse gemäß den Formatierungsregeln für Regionen registriert ist, in denen sich die Adresse befindet.

postalAddress

object (PostalAddress)

Die nachträglich verarbeitete Adresse als Postanschrift.

addressComponents[]

object (AddressComponent)

Nicht sortierte Liste. Die einzelnen Adresskomponenten der formatierten und korrigierten Adresse zusammen mit Validierungsinformationen. Hier finden Sie Informationen zum Überprüfungsstatus der einzelnen Komponenten.

Adresskomponenten sind nicht in einer bestimmten Reihenfolge angeordnet. Nehmen Sie in der Liste keine Annahmen zur Reihenfolge der Adresskomponenten in der Liste an.

missingComponentTypes[]

string

Die Komponentenkomponenten, die in einer korrekt formatierten Postanschrift vorhanden waren, aber nicht in der Eingabe gefunden wurden, konnten nicht abgeleitet werden. Komponenten dieses Typs sind in formattedAddress, postalAddress oder addressComponents nicht vorhanden. Ein Beispiel wäre ['street_number', 'route'] für eine Eingabe wie „Boulder, Colorado, 80301, USA“. Eine Liste der möglichen Typen finden Sie hier.

unconfirmedComponentTypes[]

string

Die Arten der Komponenten, die in der addressComponents vorhanden sind, aber nicht als korrekt identifiziert werden konnten. Dieses Feld ist nur der Einfachheit halber vorgesehen. Der Inhalt entspricht dem Durchlaufen von addressComponents, um die Typen aller Komponenten zu finden, bei denen confirmationLevel nicht CONFIRMED ist oder das Flag inferred nicht auf true gesetzt ist. Eine Liste der möglichen Typen finden Sie hier.

unresolvedTokens[]

string

Alle Tokens in der Eingabe, die nicht aufgelöst werden konnten. Das kann eine Eingabe sein, die nicht als gültiger Teil einer Adresse erkannt wurde. Beispielsweise kann bei einer Eingabe wie „123235253253 Main St, San Francisco, CA, 94105,“ der Status „Nicht aufgelöst“ nicht gültig sein, da dies keine gültige Hausnummer ist.

Adresskomponente

Eine Adresskomponente wie eine Straße, eine Stadt oder ein Bundesland

JSON-Darstellung
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Felder
componentName

object (ComponentName)

Der Name dieser Komponente.

componentType

string

Der Typ der Adresskomponente. Eine Liste der möglichen Typen finden Sie unter Tabelle 2: Zusätzliche vom Places-Dienst zurückgegebene Typen.

confirmationLevel

enum (ConfirmationLevel)

Gibt an, wie sicher es ist, dass die Komponente korrekt ist

inferred

boolean

Gibt an, dass die Komponente nicht Teil der Eingabe war, wir sie aber für den Standort der Adresse abgeleitet haben und glauben, dass sie für eine vollständige Adresse angegeben werden sollte.

spellCorrected

boolean

Gibt an, dass der Name der Komponente geringfügig korrigiert wurde, z. B. indem zwei Zeichen in der falschen Reihenfolge geändert wurden. Dies weist auf eine kosmetische Änderung hin.

replaced

boolean

Gibt an, dass der Name der Komponente durch eine völlig neue ersetzt wurde, z. B. eine falsche Postleitzahl durch eine korrekte Adresse für die Adresse. Dies ist keine kosmetische Änderung, die Eingabekomponente wurde in eine andere geändert.

unexpected

boolean

Gibt eine Adresskomponente an, die voraussichtlich nicht in einer Postanschrift für die angegebene Region vorhanden ist. Wir haben es nur aufbewahrt, weil es Teil der Eingabe war.

Komponentenname

Ein Wrapper für den Namen der Komponente.

JSON-Darstellung
{
  "text": string,
  "languageCode": string
}
Felder
text

string

Name Beispiel: „5th Avenue“ für einen Straßennamen oder „1253“ für eine Hausnummer.

languageCode

string

Der BCP-47-Sprachcode. Diese Option ist nicht verfügbar, wenn der Komponentenname nicht mit einer Sprache verknüpft ist, z. B. eine Hausnummer.

Bestätigungsstufe

Verschiedene mögliche Werte für Bestätigungsstufen

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
CONFIRMED Wir konnten feststellen, ob diese Komponente vorhanden ist und im Kontext der restlichen Adresse sinnvoll sind.
UNCONFIRMED_BUT_PLAUSIBLE Diese Komponente konnte nicht bestätigt werden, ist aber verfügbar. Dies kann beispielsweise eine Hausnummer innerhalb eines bekannten gültigen Nummernbereichs auf einer Straße sein, an der keine Hausnummern bekannt sind.
UNCONFIRMED_AND_SUSPICIOUS Diese Komponente wurde nicht bestätigt und ist wahrscheinlich falsch. Das kann beispielsweise ein Stadtteil sein, der nicht zum Rest der Adresse passt.

Geocodieren

Enthält Informationen zu dem Ort, an den die Eingabe geocodiert wurde

JSON-Darstellung
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Felder
location

object (LatLng)

Der geocodierte Standort der Eingabe.

Die Verwendung von Orts-IDs wird gegenüber Adressen, Breiten- und Längengradkoordinaten oder Plus Codes bevorzugt. Wenn Sie bei der Routenplanung oder beim Berechnen von Routen die Koordinaten verwenden, wird der Punkt immer auf die nächstgelegene Straße ausgerichtet. Dies ist möglicherweise keine Straße, die schnell oder sicher zum Ziel führt und sich nicht in der Nähe eines Zugangspunkts zum Hotel befindet. Wenn Sie für einen Standort das umgekehrte Geocoding verwenden, ist nicht garantiert, dass die zurückgegebene Adresse mit dem Original übereinstimmt.

plusCode

object (PlusCode)

Der Pluscode für location.

bounds

object (Viewport)

Die Grenzen des geocodierten Ortes.

featureSizeMeters

number

Die Größe des geocodierten Ortes in Metern. Dies ist ein weiteres Maß für die Grobheit des geocodierten Standorts, jedoch in der physischen Größe und nicht in der semantischen Bedeutung.

placeId

string

Die PlaceID des Orts, an dem diese Eingabe geocodiert wird

Weitere Informationen zu Orts-IDs

placeTypes[]

string

Die Ortstypen, an die die Eingabe geocodiert werden soll. Beispiel: ['locality', 'political']. Eine vollständige Liste der Typen finden Sie hier.

LatLng

Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Es wird als Paar zweier Werte (Breiten- und Längengrad) ausgedrückt. Wenn 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

number

Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen.

longitude

number

Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen.

PlusCode

Plus Code (http://plus.codes) ist eine Standortreferenz mit zwei Formaten: globaler Code, der einen 14 MX 14 m (1/8.000. Grad) oder ein kleineres Rechteck definiert, und zusammengesetzter Code, wobei das Präfix durch einen Referenzort ersetzt wird.

JSON-Darstellung
{
  "globalCode": string,
  "compoundCode": string
}
Felder
globalCode

string

Globaler (vollständiger) Code des Ortes, z. B. „9FWM33GV+HQ“, was eine Fläche von 1/8000 x 1/8000 Grad darstellt (~14 x 14 Meter)

compoundCode

string

Zusammengesetzter Code des Ortes, z. B. "33GV+HQ, Ramberg, Norwegen", mit dem Suffix des globalen Codes und Ersetzen des Präfixes durch einen formatierten Namen einer Referenzentität.

Darstellungsbereich

Ein Darstellungsbereich mit Breiten- und Längengrad, dargestellt als zwei diagonale gegenüberliegende Punkte (low und high). Ein Darstellungsbereich gilt als geschlossener Bereich, 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. Verschiedene Fälle umfassen:

  • 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).

  • Wenn low.longitude = -180 Grad und high.longitude = 180 Grad, sind alle Längengrade im Darstellungsbereich enthalten.

  • Wenn low.longitude = 180 Grad und high.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 obigen Definitionen angegeben). Ein leerer Darstellungsbereich führt zu einem Fehler.

Dieser Darstellungsbereich umfasst beispielsweise New York City:

{ "low": { "Breitengrad": 40.477398, "Längengrad": -74.259087 }, "hoch": { "Breitengrad": 40.91618, "Längengrad": -73.70018 } }

JSON-Darstellung
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Felder
low

object (LatLng)

Erforderlich. Der niedrige Punkt des Darstellungsbereichs.

high

object (LatLng)

Erforderlich. Der Höhepunkt des Darstellungsbereichs.

Adressmetadaten

Die Metadaten der Adresse. Es ist nicht garantiert, dass metadata bei jeder Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt ist.

JSON-Darstellung
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Felder
business

boolean

Gibt an, dass dies die Adresse eines Unternehmens ist. Wenn die Richtlinie nicht konfiguriert ist, bedeutet das, dass der Wert unbekannt ist.

poBox

boolean

Gibt die Adresse eines Postfachs an. Wenn die Richtlinie nicht konfiguriert ist, bedeutet das, dass der Wert unbekannt ist.

residential

boolean

Gibt an, dass dies die Adresse eines Wohnsitzes ist. Wenn die Richtlinie nicht konfiguriert ist, bedeutet das, dass der Wert unbekannt ist.

USB-Daten

Die USPS-Daten für die Adresse. Es ist nicht garantiert, dass uspsData bei jeder US- oder PR-Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt ist. Wir empfehlen Ihnen, die Felder der Sicherungsadresse in die Antwort einzubinden, wenn Sie „uspsData“ als primären Teil der Antwort verwenden.

JSON-Darstellung
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Felder
standardizedAddress

object (UspsAddress)

USPS-standardisierte Adresse.

deliveryPointCode

string

2-stelliger Lieferpunktcode

deliveryPointCheckDigit

string

Die Prüfziffer des Lieferpunkts. Diese Nummer wird am Ende des delivery_point_barcode für mechanisch gescannte E-Mails hinzugefügt. Wenn alle Zahlen aus „delivery_point_barcode“, „deliveryPointCheckDigit“, „zip“ und „Zip+4“ addiert werden, muss die Zahl durch 10 geteilt werden.

dpvConfirmation

string

Mögliche Werte für die DPV-Bestätigung. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse wurde für die primäre und sekundäre Nummern bereits bestätigt.
  • N: Primäre und sekundäre Informationen konnten nicht von der DPV bestätigt werden.
  • S: Die Adresse wurde nur für die primäre Nummer bestätigt, die sekundäre Nummer war aber nicht vorhanden.
  • D: Die Adresse wurde nur für die primäre Nummer bestätigt, die Informationen zur sekundären Nummer fehlten.
dpvFootnote

string

Die Fußnoten aus der Validierung des Lieferpunkts. Mehrere Fußnoten können in einem String miteinander verbunden sein.

  • AA: Eingabeadresse, die mit der ZIP-Datei + 4 übereinstimmt
  • A1: Die eingegebene Adresse wurde nicht mit der ZIP-Datei 4 abgeglichen
  • BB: an DPV angepasst (alle Komponenten)
  • CC: Keine sekundäre Telefonnummer (entspricht, aber ungültig)
  • N1: In einer Hochhaus-Adresse fehlt die sekundäre Nummer
  • M1: Primäre Nummer fehlt
  • M3: Primäre Nummer ungültig
  • P1: Fehlende RR- oder HC-Feldnummer der Eingabe
  • P3: Postfach-, RR- oder HC-Feldnummer ist ungültig
  • F1: Eingabeadresse entspricht einer Militäradresse
  • G1: Eingabeadresse, die mit einer allgemeinen Lieferadresse übereinstimmt
  • U1: Eingabeadresse entspricht einer eindeutigen Postleitzahl
  • PB: Eingabeadresse entspricht PBSA-Eintrag
  • RR: DPV-bestätigte Adresse mit PMB-Informationen
  • R1: DPV-bestätigte Adresse ohne PMB-Informationen
  • R7: Carrier Route R777- oder R779-Eintrag
dpvCmra

string

Gibt an, ob die Adresse eine CMRA (Commercial Mail Received Agency) ist, also ein privates Unternehmen, das E-Mails für Kunden empfängt. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse ist ein CMRA
  • N: Die Adresse ist kein CMRA
dpvVacant

string

Ist dieser Ort leer? Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse ist leer
  • N: Die Adresse ist nicht leer
dpvNoStat

string

Ist das eine Adresse ohne Statistik oder eine aktive Adresse? Statistikadressen sind solche, die nicht kontinuierlich besetzt sind oder an denen der USPS nicht bedient wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse ist nicht aktiv
  • N: Die Adresse ist aktiv
carrierRoute

string

Der Routencode des Transportunternehmens. Ein Code aus vier Zeichen, der aus einem einstelligen Präfix und einer dreistelligen Routenbezeichnung besteht.

Präfixe:

  • C: Fluggesellschaft (oder Stadtroute)
  • R: Landstraße
  • H: Autobahn-Vertragsroute
  • B: Abschnitt „Postfach“
  • G: Allgemeine Auslieferungseinheit
carrierRouteIndicator

string

Anzeige zur Sortierung der vom Transportunternehmen berechneten Preise.

ewsNoMatch

boolean

Die Lieferadresse kann abgeglichen werden, die EWS-Datei gibt jedoch an, dass eine genaue Übereinstimmung bald verfügbar sein wird.

postOfficeCity

string

Stadt in der Hauptpoststelle.

postOfficeState

string

Hauptpostamt

abbreviatedCity

string

Abgekürzte Stadt.

fipsCountyCode

string

FIPS County-Code.

county

string

Name des Landkreises.

elotNumber

string

eLOT-Nummer (Extended Line of Travel)

elotFlag

string

eLOT Aufsteigende/absteigende Flagge (A/D).

poBoxOnlyPostalCode

boolean

Nur Postfach.

pmbDesignator

string

PMB (Private Postfach) Gerätekennzeichnung.

pmbNumber

string

PMB-Nummer (Private Mail Box)

addressRecordType

string

Typ des Adresseintrags, der mit der Eingabeadresse übereinstimmt.

  • F: FIRM Dies ist eine Übereinstimmung mit einem festen Datensatz, der besten verfügbaren Übereinstimmungsstufe für eine Adresse.
  • G: ALLGEMEINE LIEFERUNG. Dies ist eine Übereinstimmung mit einem General Delivery-Datensatz.
  • H: BAUER / EINHEIT. Dies ist eine Übereinstimmung mit einem Gebäude- oder Wohnungseintrag.
  • P: POST POSTEINGANG. Dies ist eine Übereinstimmung mit einer Briefkasten.
  • R: RURAL ROUTE oder HIGHWAY CONTRACT: Dies ist eine Übereinstimmung mit einer ländlichen Route oder einem Highway-Vertrag, die beide Nummernbereiche für Box-Nummern haben können.
  • S: STREET RECORD – Übereinstimmung mit einem Street Record-Eintrag mit einem gültigen primären Nummernbereich.
defaultAddress

boolean

Zeigt an, dass eine Standardadresse gefunden wurde, aber spezifischere Adressen vorhanden sind.

errorMessage

string

Fehlermeldung für den Abruf von USPS-Daten. Wird automatisch ausgefüllt, wenn die USPS-Verarbeitung aufgrund der Erkennung künstlich erstellter Adressen ausgesetzt wird.

Die USPS-Datenfelder werden möglicherweise nicht ausgefüllt, wenn dieser Fehler vorhanden ist.

cassProcessed

boolean

Zeigt an, dass die Anfrage verarbeitet wurde.

Usps-Adresse

USPS-Repräsentation 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

string

Erste Adresszeile.

firm

string

Firmenname.

secondAddressLine

string

Zweite Adresszeile.

urbanization

string

Puerto-ricanischer Urbanisierungsname.

cityStateZipAddressLine

string

Stadt + Bundesland + Postleitzahl.

city

string

Stadt

state

string

2-stelliger Bundesstaatcode

zipCode

string

Postleitzahl, z.B. 10009.

zipCodeExtension

string

4-stellige Postleitzahlerweiterung, z.B. 5023.