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,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Felder
address

object (PostalAddress)

Erforderlich. Die zu bestätigende Adresse. Nicht formatierte Adressen müssen über addressLines gesendet werden.

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

Unterstützte Regionen finden Sie hier.

Der Wert languageCode in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird heute ignoriert. Das validierte Ergebnis für die Adresse wird anhand der vom System ermittelten bevorzugten Sprache für die jeweilige 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 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 responseId von der allerersten Antwort in der Validierungssequenz ausgefüllt werden.

enableUspsCass

boolean

Aktiviert den USPS CASS-kompatiblen Modus. Dies betrifft nur das Feld google.maps.addressvalidation.v1.ValidationResult.usps_data von google.maps.addressvalidation.v1.ValidationResult. Hinweis: Bei Anfragen mit USPS CASS für Adressen in Puerto Rico müssen google.type.PostalAddress.region_code von address als „PR“ oder google.type.PostalAddress.administrative_area von address als „Puerto Rico“ (Groß-/Kleinschreibung nicht berücksichtigt) oder „PR“ angegeben werden.

Es empfiehlt sich, eine address mit Komponenten zu verwenden oder mindestens zwei google.type.PostalAddress.address_lines anzugeben, wobei die erste Zeile die Hausnummer und den Namen und die zweite Zeile die Stadt, das Bundesland und die Postleitzahl enthält.

languageOptions

object (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

string

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 sessionToken weggelassen wird oder Sie ein Sitzungstoken wiederverwenden, wird die Sitzung so abgerechnet, als wäre kein Sitzungstoken angegeben worden. Jede Anfrage wird separat abgerechnet.

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 (ValidationResult)
  },
  "responseId": string
}
Felder
result

object (ValidationResult)

Das Ergebnis der Adressvalidierung.

responseId

string

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

integer

Die Schemaversion von PostalAddress. Jeder andere Wert als 0 führt dazu, dass die API den Fehler INVALID_ARGUMENT zurückgibt.

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/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 addressLines bereits enthalten ist, geben Sie den Regionscode nicht noch einmal in dieses Feld ein. Unterstützte Regionen finden Sie in den häufig gestellten Fragen.

languageCode

string

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

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 die Werte in „addressLines“ keine Typinformationen enthalten und manchmal mehrere Werte in einem einzigen Feld enthalten sind (z.B. „Austin, TX“), muss die Zeilenreihenfolge deutlich erkennbar sein. Die Reihenfolge der Adresszeilen sollte der Adresse auf einem Briefumschlag für das Land bzw. die Region entsprechen.

Die mindestens zulässige strukturelle Darstellung einer Adresse besteht aus allen Informationen, die im addressLines platziert werden. Wenn regionCode nicht angegeben ist, wird die Region aus den Adresszeilen abgeleitet.

Für vollständig unstrukturierte Adressen wird empfohlen, eine Adresse zu erstellen, die nur addressLines enthält, und dann Geocoding zu erstellen. So muss nicht geraten werden, welche Teile der Adresse Orte oder Verwaltungsgebiete sein sollten.

recipients[]

string

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

string

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

boolean

Vorschau: Geben Sie google.maps.addressvalidation.v1.Address auf Englisch zurück. Weitere Informationen findest du unter google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

ValidationResult

Das Ergebnis der Adressüberprüfung.

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

object (Verdict)

Flags für das Gesamtergebnis

address

object (Address)

Informationen zur Adresse selbst, im Gegensatz zum Geocode.

geocode

object (Geocode)

Informationen über den Standort und den Ort, für den die Adresse das Geocoding durchgeführt hat.

metadata

object (AddressMetadata)

Weitere Informationen, die für die Lieferbarkeit relevant sind. Das Feld metadata wird möglicherweise nicht für jede Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt.

uspsData

object (UspsData)

Flags für zusätzliche Zustellbarkeit wurden von USPS bereitgestellt. Nur in den Regionen US und PR angegeben.

englishLatinAddress

object (Address)

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

Sie haben diese Ausgabe mit dem Flag google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address aktiviert.

Hinweis: Das Feld google.maps.addressvalidation.v1.Address.unconfirmed_component_types in englishLatinAddress und die Felder google.maps.addressvalidation.v1.AddressComponent.confirmation_level in englishLatinAddress.address_components sind nicht ausgefüllt.

Ergebnis

Allgemeine Übersicht über das Ergebnis und die Geocodierung der Adresse

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 input-Adresse. Dies ist das Ergebnis des Parsens der Eingabeadresse. Es werden keine Validierungssignale ausgegeben. Informationen zu Validierungssignalen finden Sie unter validationGranularity unten.

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

validationGranularity

enum (Granularity)

Der Detaillierungsgrad, mit dem die API die Adresse vollständig validate kann. Ein validationGranularity-Wert von PREMISE gibt beispielsweise an, dass alle Adresskomponenten auf PREMISE-Ebene oder einer höheren Ebene validiert werden können.

Das Validierungsergebnis für die einzelnen Adresskomponenten finden Sie in google.maps.addressvalidation.v1.Address.address_components.

geocodeGranularity

enum (Granularity)

Informationen zum Detaillierungsgrad von geocode. Dies kann als die semantische Bedeutung dessen verstanden werden, wie grob oder fein der geocodierte Standort ist.

Diese kann gelegentlich vom obigen validationGranularity abweichen. So kann es z. B. vorkommen, dass unsere Datenbank die Existenz einer Wohnungsnummer erfasst, aber keinen genauen Standort für die Wohnung innerhalb eines großen Wohnkomplexes aufweist. In diesem Fall ist validationGranularity SUB_PREMISE, geocodeGranularity aber PREMISE.

addressComplete

boolean

Die Adresse gilt als vollständig, wenn es keine nicht aufgelösten Tokens oder keine unerwarteten oder fehlenden Adresskomponenten gibt. Weitere Informationen findest du in den Feldern „missingComponentTypes“, „unresolvedTokens“ oder „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 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 (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Felder
formattedAddress

string

Die nachbearbeitete Adresse, die gemäß den Formatierungsregeln der Region, in der sich die Adresse befindet, als einzeilige Adresse formatiert wird.

postalAddress

object (PostalAddress)

Die nachbearbeitete Adresse, dargestellt als Postanschrift.

addressComponents[]

object (AddressComponent)

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[]

string

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 formattedAddress, postalAddress und addressComponents nicht vorhanden. Ein Beispiel wäre ['street_number', 'route'] für eine Eingabe wie „Boulder, Colorado, 80301, USA“. Die Liste der möglichen Typen finden Sie hier.

unconfirmedComponentTypes[]

string

Die Komponententypen, die in der addressComponents vorhanden sind, aber nicht als korrekt bestätigt werden konnten. Dieses Feld wird zur Vereinfachung bereitgestellt: Sein Inhalt entspricht der Iteration über addressComponents, um die Typen aller Komponenten zu finden, bei denen confirmationLevel nicht CONFIRMED oder das Flag inferred nicht auf true gesetzt ist. Die Liste der möglichen Typen finden Sie hier.

unresolvedTokens[]

string

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 ["123235253253"] aussehen, da sie nicht wie eine gültige Hausnummer aussieht.

AddressComponent

Eine Adresskomponente, z. B. Straße, Stadt oder 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 für diese Komponente.

componentType

string

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

confirmationLevel

enum (ConfirmationLevel)

Gibt an, wie sicher wir sind, dass die Komponente korrekt ist.

inferred

boolean

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

boolean

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

boolean

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

boolean

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

string

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

languageCode

string

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 (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Felder
location

object (LatLng)

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

object (PlusCode)

Der Plus Code für location.

bounds

object (Viewport)

Die Grenzen des geocodierten Orts.

featureSizeMeters

number

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

string

Die PlaceID des Orts, für den diese Eingabe geocodiert wird.

Weitere Informationen zu Orts-IDs

placeTypes[]

string

Die Art(en) des Ortes, für den die Eingabe das Geocoding vorgenommen hat. Beispiel: ['locality', 'political']. Die vollständige Liste der Typen findest du hier.

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

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 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

string

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

string

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 und high.longitude = 180 Grad, enthält der Darstellungsbereich alle Längengrade.

  • 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 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Felder
low

object (LatLng)

Erforderlich. Der Tiefstpunkt des Darstellungsbereichs.

high

object (LatLng)

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

boolean

Gibt an, dass dies die Adresse eines Unternehmens ist. Wenn nicht festgelegt, ist der Wert unbekannt.

poBox

boolean

Gibt die Adresse eines Postfachs an. Wenn nicht festgelegt, ist der Wert unbekannt.

residential

boolean

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 (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": 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)

Standardisierte USPS-Adresse.

deliveryPointCode

string

2-stelliger Code der Lieferstelle

deliveryPointCheckDigit

string

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

string

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

  • N: Die Angaben zur primären und sekundären Nummer konnten nicht per DPV bestätigt werden.
  • D: Die DPV wurde nur für die primäre Nummer bestätigt und die sekundäre Nummer fehlt.
  • S: Die Adresse wurde nur für die primäre Nummer bestätigt, die sekundäre Nummer war vorhanden, aber nicht bestätigt.
  • Y: DPV für primäre und alle sekundären Nummern wurde bestätigt.
  • Leer: Wenn die Antwort keinen dpvConfirmation-Wert enthält, wurde die Adresse nicht zur DPV-Bestätigung eingereicht.
dpvFootnote

string

Die Fußnoten aus der Validierung der Lieferpunkte. Mehrere Fußnoten können in derselben Zeichenfolge aneinandergereiht werden.

  • AA: Eingabeadresse, die mit der ZIP+4-Datei übereinstimmt
  • A1: Eingabeadresse stimmte nicht mit der ZIP+4-Datei überein
  • BB: An DPV angepasst (alle Komponenten)
  • CC: Sekundäre Nummer stimmt nicht überein und ist nicht erforderlich
  • C1: Sekundäre Nummer nicht zugeordnet, aber erforderlich
  • N1: Hochhausadresse ohne Zweitnummer
  • M1: primäre Nummer fehlt
  • M3: primäre Nummer ungültig
  • P1: Bestellnummer, RR- oder HC-Feldnummer fehlt
  • P3: PO-, RR- oder HC-Box-Nummer der Eingabeadresse ungültig
  • F1: Eingabeadresse stimmt mit einer Militäradresse überein
  • G1: Die eingegebene Adresse stimmt mit einer allgemeinen Lieferadresse überein
  • U1: Die eingegebene Adresse stimmt mit einer eindeutigen Postleitzahl überein
  • PB: Eingabeadresse stimmt mit dem PBSA-Eintrag überein
  • RR: vom Datenschutzrahmen bestätigte Adresse mit Angaben zum PMB
  • R1: vom Datenschutzrahmen bestätigte Adresse ohne Angaben zum PMB
  • R7: Carrier Route R777- oder R779-Eintrag
  • IA: Informierte Adresse identifiziert
  • TA: primäre Zahl für Übereinstimmung durch Entfernen eines nachgestellten Alpha-Werts
dpvCmra

string

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.

  • Y: Die Adresse ist eine CMRA-Datei.
  • N: Die Adresse ist keine CMRA-Datei.
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 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.

  • Y: Die Adresse ist nicht aktiv
  • N: Die Adresse ist aktiv.
dpvNoStatReasonCode

integer

Gibt den Typ NoStat an. Gibt einen Ursachencode als int zurück.

  • 1: IDA (Internal Drop Address) – Adressen, die Post nicht direkt vom USPS erhalten, sondern an eine Adresse zugestellt werden, die sie bedient.
  • 2: CDS – Adressen, die noch nicht zustellbar sind. Zum Beispiel eine neue Untergruppe, in der viele und primäre Nummern bestimmt wurden, aber noch keine Struktur für die Belegung vorhanden ist.
  • 3: Kollision – Adressen, die keine DPV-Bestätigung durchführen.
  • 4: CMZ (College, Military und andere Typen) – ZIP und 4 Einträge, die USPS in die Daten eingebunden hat.
  • 5: Normal – Gibt an, dass Adressen nicht zugestellt werden können und nicht als mögliche Zustellungen gezählt werden.
  • 6: sekundär erforderlich: Für die Adresse sind sekundäre Informationen erforderlich.
dpvDrop

string

Das Flag gibt an, dass die E-Mail an einen einzelnen Empfänger eines Standorts zugestellt wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Post wird an einen einzelnen Empfänger eines Standorts zugestellt.
  • N: Die E-Mail wird nicht an einen einzelnen Empfänger einer Website zugestellt.
dpvThrowback

string

Gibt an, dass E-Mails nicht an die Adresse zugestellt werden. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Post wird nicht an die Adresse zugestellt.
  • N: Die Post wird an die Adresse zugestellt.
dpvNonDeliveryDays

string

Das Flag gibt an, dass die E-Mail nicht an jedem Wochentag zugestellt wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Die E-Mail wird nicht an jedem Wochentag zugestellt.
  • N: Kein Hinweis, dass die E-Mail nicht an jedem Wochentag erfolgt.
dpvNonDeliveryDaysValues

integer

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

string

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.

  • Y: Das Paket wird aus Sicherheitsgründen nicht hinterlassen.
  • N: Kein Hinweis, dass das Paket aufgrund von Sicherheitsbedenken nicht hinterlassen wird.
dpvPbsa

string

Gibt an, dass die Adresse mit dem PBSA-Eintrag abgeglichen wurde. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse wurde mit dem PBSA-Eintrag abgeglichen.
  • N: Die Adresse konnte nicht mit dem PBSA-Eintrag abgeglichen werden.
dpvDoorNotAccessible

string

Flagge zeigt Adressen an, bei denen USPS nicht an die Tür klopfen kann, um Post zuzustellen. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Tür ist nicht zugänglich.
  • N: Es gibt keine Anzeichen dafür, dass die Tür nicht zugänglich ist.
dpvEnhancedDeliveryCode

string

Gibt an, dass mehr als ein DPV-Rückgabecode für die Adresse gültig ist. Gibt ein einzelnes Zeichen zurück.

  • Y: DPV für primäre und alle sekundären Nummern wurde bestätigt.
  • N: Die Angaben zur primären und sekundären Nummer konnten nicht per DPV bestätigt werden.
  • S: Die Adresse wurde nur für die primäre Nummer per DPV bestätigt und die Informationen zur sekundären Nummer waren durch nicht bestätigt oder es wurde bei einer primären Nummer ein nur nachgestellter Alphatest für eine primäre Nummer entfernt, um eine DPV-Übereinstimmung zu machen und sekundäre Informationen erforderlich zu machen.
  • D: Die DPV wurde nur für die primäre Nummer bestätigt und die sekundäre Nummer fehlt.
  • R: Die Adresse wurde bestätigt, ist aber der Phantomroute R777 und R779 zugewiesen. Keine Zustellung per USPS angegeben.
carrierRoute

string

Der Routencode des Transportunternehmens. Ein vierstelliger Code, der aus einem Präfix aus einem Buchstaben und einem dreistelligen Routenbezeichner besteht.

Präfixe:

  • C: Route des Transportunternehmens (oder Stadtroute)
  • R: Landstraße
  • H: Autobahnvertragsroute
  • B: Postfachbereich
  • G: allgemeine Bereitstellungseinheit
carrierRouteIndicator

string

Sortieranzeige für Versandpreise für Transportunternehmen.

ewsNoMatch

boolean

Die Lieferadresse kann abgeglichen werden, aber aus der EWS-Datei geht hervor, dass in Kürze eine genaue Übereinstimmung verfügbar sein wird.

postOfficeCity

string

Stadt der Hauptpostfiliale.

postOfficeState

string

Hauptpostfiliale.

abbreviatedCity

string

Gekürzte Stadt.

fipsCountyCode

string

FIPS-Bezirkscode.

county

string

Landkreis

elotNumber

string

eLOT-Nummer (Enhanced Line of Travel)

elotFlag

string

Aufsteigendes/absteigendes eLOT-Flag (A/D).

poBoxOnlyPostalCode

boolean

Postleitzahl (nur Postfach).

pmbDesignator

string

PMB-Einheit (Private Mail Box)

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 Firmeneintrag, der die genaueste verfügbare Übereinstimmung für eine Adresse darstellt.
  • G: ALLGEMEINE LIEFERUNG. Dies entspricht einem Datensatz für die allgemeine Zustellung.
  • H: AUFBAU / WOHNUNG. Dies stimmt mit einem Gebäude- oder Apartment-Eintrag überein.
  • P: POSTLEITFADEN. Dies entspricht einem Postfach.
  • R: LÄNDER ROUTE oder HIGHWAY CONTRACT: Dies ist eine Übereinstimmung mit einem Datensatz für eine Landstraße oder einen Fernstraßenvertrag, für den beide Bereiche mit Box-Nummern verknüpft sein können.
  • S: STREET RECORD: Übereinstimmung mit einem Straßendatensatz mit einem gültigen primären Zahlenbereich.
defaultAddress

boolean

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

errorMessage

string

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

boolean

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

string

Erste Adresszeile.

firm

string

Name des Unternehmens.

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.