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 Adresse, die validiert wird. Unformatierte Adressen müssen über addressLines eingereicht werden.

Die Felder in dieser Eingabe dürfen insgesamt nicht länger als 280 Zeichen sein.

Hier finden Sie die unterstützten Regionen.

Der Wert languageCode in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird heute ignoriert. Das Ergebnis der überprüften Adresse wird auf Grundlage der vom System ermittelten bevorzugten Sprache für die angegebene Adresse eingefügt.

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 anfänglichen Validierung vornimmt, noch einmal validiert werden müssen, muss dieses Feld für jede Folgeanfrage mit responseId aus der ersten 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 nach USPS CASS für Adressen in Puerto Rico muss ein google.type.PostalAddress.region_code der address als „PR“ oder eine google.type.PostalAddress.administrative_area der address als „Puerto Rico“ angegeben werden. (Groß-/Kleinschreibung nicht berücksichtigend) oder „PR“.

Es wird empfohlen, address in 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.

Aktiviert die Address Validation API, um zusätzliche Informationen in die Antwort aufzunehmen.
sessionToken

string

Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss aus einer URL und einem sicheren Base64-String mit einem Dateinamen und maximal 36 ASCII-Zeichen bestehen. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.

Die Sitzung beginnt, wenn der Nutzer eine Autocomplete-Anfrage stellt, und endet, wenn er einen Ort auswählt und ein „Place Details“- oder „Address Validation“-Aufruf erfolgt. Jede Sitzung kann mehrere Autocomplete-Abfragen enthalten, gefolgt von einer „Place Details“- oder „Address Validation“-Anfrage. Die für jede Anfrage in einer Sitzung verwendeten Anmeldedaten müssen zum selben Google Cloud Console-Projekt gehören. Nach Abschluss einer Sitzung ist das Token nicht mehr gültig. Ihre App muss für jede Sitzung ein neues Token generieren. Wenn Sie den Parameter sessionToken weglassen oder ein Sitzungstoken wiederverwenden, wird die Sitzung so in Rechnung gestellt, als wäre kein Sitzungstoken bereitgestellt worden. Jede Anfrage wird separat abgerechnet.

Hinweis: Address Validation kann nur in Sitzungen mit der Autocomplete (New) API und nicht mit der Autocomplete API verwendet werden. 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. Wenn die Adresse erneut validiert werden muss, muss diese UUID zusammen mit der neuen Anfrage angegeben 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 Eingabe / Bearbeitung von Adressen: – Verwenden Sie ein für die Internationalisierung geeignetes Adress-Widget wie https://github.com/google/libaddressinput. Nutzern sollten außerhalb der Länder, in denen dieses Feld verwendet wird, keine UI-Elemente zur Eingabe oder Bearbeitung von Feldern angezeigt werden.

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. Bei jedem anderen Wert als 0 gibt die API den Fehler INVALID_ARGUMENT zurück.
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 kein Regionscode angegeben ist, wird er aus der Adresse abgeleitet. Für eine optimale Leistung wird empfohlen, den Regionscode anzugeben, falls er Ihnen bekannt ist. Uneinheitliche oder wiederholte Regionen können zu Leistungseinbußen führen. Wenn beispielsweise addressLines die Region bereits enthält, geben Sie den Regionscode nicht noch einmal in diesem Feld an. Unterstützte Regionen finden Sie in den häufig gestellten Fragen.
languageCode

string

Der Sprachcode 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 können (z.B. „Austin, TX“), ist es wichtig, dass die Zeilenreihenfolge klar erkennbar ist. 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 in der addressLines platziert sind. Wenn kein regionCode angegeben ist, wird die Region aus den Adresszeilen abgeleitet.

Für die Verarbeitung vollständig unstrukturierter Adressen wird empfohlen, eine Adresse zu erstellen, die nur addressLines enthält und die dann über Geocoding verarbeitet werden sollen. So muss nicht erraten werden, welche Teile der Adresse Orte oder Verwaltungsgebiete sein sollen.
recipients[]

string

Legen Sie dieses Feld nicht fest. Sie wird derzeit nicht von der Address Validation API verwendet. Obwohl die API derzeit Anfragen mit diesem festgelegten Feld nicht ablehnt, werden die Informationen verworfen und nicht in der Antwort zurückgegeben.
organization

string

Legen Sie dieses Feld nicht fest. Sie wird derzeit nicht von der Address Validation API verwendet. Obwohl die API derzeit Anfragen mit diesem festgelegten Feld nicht ablehnt, werden die Informationen 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.

Aktiviert die Address Validation API, um zusätzliche Informationen in die Antwort aufzunehmen.

JSON-Darstellung 
{
  "returnEnglishLatinAddress": boolean
}
Felder
returnEnglishLatinAddress

boolean

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

ValidationResult

Das Ergebnis der Validierung einer Adresse.

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

object (Verdict)

Meldungen zum Gesamtergebnis
address

object (Address)

Informationen zur Adresse selbst, nicht zur Geocodierung.
geocode

object (Geocode)

Informationen zum Standort und Ort, für den die Adresse geocodiert wurde.
metadata

object (AddressMetadata)

Sonstige Informationen, die für die Lieferbarkeit relevant sind. Es kann nicht garantiert werden, dass metadata für jede Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt wird.
uspsData

object (UspsData)

Zusätzliche Zustellbarkeits-Flags von USPS. 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, die ins Englische übersetzt wurde.

Übersetzte Adressen können nicht als API-Eingabe wiederverwendet werden. Der Dienst stellt sie bereit, damit der Nutzer die Bestätigung der ursprünglich angegebenen Adresse in seiner Muttersprache bestätigen oder ablehnen kann.

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 Transliterationen in einer Sprache mit lateinischer Schrift vorhanden sind, gibt der Dienst diesen Teil in der lokalen Sprache der Adresse zurück.

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

Hinweis: Die Felder google.maps.addressvalidation.v1.Address.unconfirmed_component_types in den Feldern englishLatinAddress und google.maps.addressvalidation.v1.AddressComponent.confirmation_level in englishLatinAddress.address_components enthalten keine Daten.

Urteil

Grober Überblick ü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 und liefert keine Validierungssignale. Informationen zu Validierungssignalen finden Sie unten im Abschnitt validationGranularity.

Wenn die eingegebene Adresse beispielsweise eine bestimmte Wohnungsnummer enthält, ist die 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 kleiner.
validationGranularity

enum (Granularity)

Der Detaillierungsgrad, auf dem die API die Adresse vollständig validieren kann. Beispielsweise gibt ein validationGranularity von PREMISE an, dass alle Adresskomponenten auf der Ebene PREMISE oder einer groben Ebene validiert werden können.

Das Validierungsergebnis pro Adresskomponente finden Sie in google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

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

Diese kann sich gelegentlich von der validationGranularity oben unterscheiden. Beispielsweise könnte unsere Datenbank die Existenz einer Wohnungsnummer aufzeichnen, jedoch keinen genauen Standort für die Wohnung in einem großen Wohnkomplex. In diesem Fall ist validationGranularity SUB_PREMISE, geocodeGranularity aber PREMISE.
addressComplete

boolean

Die Adresse gilt als vollständig, wenn keine nicht aufgelösten Tokens oder keine unerwarteten oder fehlenden Adresskomponenten vorhanden sind. Wenn kein Wert festgelegt ist, bedeutet das, dass der Wert false ist. Weitere Informationen finden Sie 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. Diese Werte geben an, wie detailliert die Adresse für eine Adresse ist. Eine Adresse wie „123 Main Street, Redwood City, CA, 94061“ PREMISE identifiziert, während so etwas wie „Redwood City, CA, 94061“ identifiziert ein LOCALITY. Wenn wir jedoch keinen Geocode für „Hauptstraße 123“ finden können, in Redwood City wird der zurückgegebene Geocode möglicherweise mit LOCALITY-Detaillierungsgrad zurückgegeben, obwohl die Adresse detaillierter ist.

Enums
GRANULARITY_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
SUB_PREMISE Ergebnis unter Gebäudeebene, z. B. eine Wohnung.
PREMISE Ergebnis auf Gebäudeebene.
PREMISE_PROXIMITY Ein Geocode, der den ungefähren Standort der Adresse auf Gebäudeebene darstellt.
BLOCK Durch die Adresse oder den Geocode wird ein Block gekennzeichnet. Wird nur in Regionen mit Adressierung auf Blockebene verwendet, z. B. in Japan.
ROUTE Der Geocode oder die Adresse lässt sich auf die Route eingrenzen, z. B. Straße, Straße oder Autobahn.
OTHER Alle anderen Detaillierungsgrade, die zusammengefasst sind, 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 das Ableiten fehlender Teile.

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

string

Die nachbearbeitete Adresse im Format einer einzeiligen Adresse, die den Formatierungsregeln der Region entspricht, in der sich die Adresse befindet.
postalAddress

object (PostalAddress)

Die nachbearbeitete Adresse, dargestellt als Postanschrift.
addressComponents[]

object (AddressComponent)

Unsortierte Liste. Die einzelnen Adresskomponenten der formatierten und korrigierten Adresse sowie Validierungsinformationen. Dieser Bericht enthält Informationen zum Validierungsstatus der einzelnen Komponenten.

Adresskomponenten sind nicht auf eine bestimmte Weise angeordnet. Treffen Sie keine Annahmen zur Reihenfolge der Adresskomponenten in der Liste.
missingComponentTypes[]

string

Die Komponententypen, die in einer korrekt formatierten Postanschrift vorhanden sein sollten, aber in der Eingabe nicht gefunden wurden, 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 addressComponents vorhanden sind, aber nicht als korrekt bestätigt werden konnten. Dieses Feld wird der Einfachheit halber bereitgestellt: Sein Inhalt entspricht der Iteration durch 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 könnte eine Eingabe sein, die nicht als gültiger Teil einer Adresse erkannt wurde. Beispiel: Bei einer Eingabe wie „123235253253 Main St, San Francisco, CA, 94105“ sehen die nicht aufgelösten Tokens möglicherweise so aus: ["123235253253"], da es keine gültige Hausnummer zu sein scheint.

AddressComponent

Eine Adresskomponente, z. B. 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 in Tabelle 2: Weitere vom Places-Dienst zurückgegebene Typen.
confirmationLevel

enum (ConfirmationLevel)

Gibt die Sicherheit an, mit der die Komponente korrekt ist.
inferred

boolean

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

boolean

Gibt eine Korrektur eines Rechtschreibfehlers im Komponentennamen an. Die API kennzeichnet Änderungen nicht immer von einer Schreibvariante an eine andere, z. B. beim Ändern von „Zentrum“. auf „Mitte“ setzen. Außerdem werden häufige Rechtschreibfehler nicht immer gemeldet, z. B. wenn „Amphitheater Pkwy“ geändert wird. nach „Amphitheatre Pkwy“.
replaced

boolean

Gibt an, dass der Name der Komponente durch einen völlig anderen ersetzt wurde, z. B. wurde eine falsche Postleitzahl durch eine falsche Postleitzahl ersetzt. Hierbei handelt es sich nicht um eine kosmetische Änderung. Die Eingabekomponente wurde in eine andere geändert.
unexpected

boolean

Gibt eine Adresskomponente an, die in der angegebenen Region voraussichtlich nicht in einer Postadresse vorhanden ist. Wir haben sie nur deshalb 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" nach einem Straßennamen oder „1253“ nach einer Hausnummer.
languageCode

string

Der BCP-47-Sprachcode. Dieser wird nicht angezeigt, wenn der Komponentenname nicht mit einer Sprache verknüpft ist, wie z. B. 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 überprüfen, ob diese Komponente vorhanden ist und im Zusammenhang mit der übrigen Adresse Sinn ergibt.
UNCONFIRMED_BUT_PLAUSIBLE Diese Komponente konnte nicht bestätigt werden, aber es ist durchaus möglich, dass sie existiert. Beispiel: eine Hausnummer in einem bekannten gültigen Zahlenbereich in einer Straße, in der bestimmte Hausnummern nicht bekannt sind.
UNCONFIRMED_AND_SUSPICIOUS Diese Komponente wurde nicht bestätigt und ist wahrscheinlich falsch. Beispiel: ein Viertel, das nicht zum Rest der Adresse passt.

Geocode

Enthält Informationen zu dem 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)

Die geocodierte Position der Eingabe.

Die Verwendung von Orts-IDs ist gegenüber Adressen, Breiten- und Längengraden oder Plus Codes vorzuziehen. Die Verwendung von Koordinaten bei der Routenplanung oder Berechnung von Routen führt immer dazu, dass der Punkt an der Straße ausgerichtet wird, die diesen Koordinaten am nächsten liegt. 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 Grundstück befindet. Außerdem gibt es keine Garantie, dass die zurückgegebene Adresse mit dem Original übereinstimmt, wenn ein Standort umgekehrt geocodiert wird.
plusCode

object (PlusCode)

Der Plus Code, der location entspricht.
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 Standorts, allerdings in physikalischer Größe und nicht in semantischen Bedeutungen.
placeId

string

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

Weitere Informationen zu Orts-IDs finden Sie hier.
placeTypes[]

string

Der oder die Typ(en) des Orts, für den/die die Eingabe eine Geocodierung durchgeführt hat. 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 aus Werten vom Typ „Double“ (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: der globale Code, der ein Rechteck mit der Größe 14mx14m (1/8.000. Grad) oder ein kleineres Rechteck definiert, und ein zusammengesetzter Code, bei dem das Präfix durch einen Referenzort ersetzt wird.

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

string

Der globale (vollständige) Code des Orts, z. B. „9FWM33GV+HQ“, für einen Bereich von 1/8.000 × 1/8.000 Grad (~14 × 14 Meter).
compoundCode

string

Zusammengesetzter Code des Orts, z. B. „33GV+HQ, Ramberg, Norwegen“, der das Suffix des globalen Codes enthält und das Präfix durch einen formatierten Namen einer Referenzentität ersetzt.

Darstellungsbereich

Ein Darstellungsbereich für Breiten- und Längengrad, dargestellt als zwei diagonal gegenüberliegende low- und high-Punkte Ein Darstellungsbereich gilt als geschlossener Bereich, d.h. er enthält seine Begrenzung. Die Breitengradgrenzen müssen zwischen -90 und einschließlich 90 Grad und die Längengradgrenzen zwischen -180 und 180 Grad liegen. Es gibt verschiedene Fälle:

  • Wenn low = high, besteht der Darstellungsbereich aus diesem einzelnen Punkt.

  • Wenn low.longitude > high.longitude wird der Längengradbereich umgekehrt (der Darstellungsbereich kreuzt die 180-Grad-Längenlinie).

  • Wenn low.longitude = -180 Grad und high.longitude = 180 Grad ist, 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, der Breitengradbereich ist 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 schließt beispielsweise New York City vollständig ein:

{ "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 des Darstellungsbereichs.

AddressMetadata

Die Metadaten für die Adresse. Es kann nicht garantiert werden, dass metadata für jede Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt wird.

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

boolean

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

boolean

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

boolean

Gibt an, dass dies die Adresse eines Wohnsitzes ist. Wenn kein Wert festgelegt ist, ist der Wert unbekannt.

UspsData

Die USPS-Daten für die Adresse. Es kann nicht garantiert werden, 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 Sicherungsadressfelder in die Antwort zu integrieren, 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,
  "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 des Lieferorts. Diese Nummer wird bei mechanisch gescannten Posten am Ende von delivery_point_barcode hinzugefügt. Wenn Sie alle Ziffern von delivery_point_barcode, deliveryPointCheckDigit, Postleitzahl und ZIP+4 zusammen addieren, sollte eine durch 10 teilbare Zahl entstehen.
dpvConfirmation

string

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

  • N: Die Daten aus der primären und sekundären Nummer konnten vom DPV nicht bestätigt werden.
  • D: Die Adresse wurde nur für die primäre Nummer bestätigt und die Zweitnummer fehlt.
  • S: Die Adresse wurde nur für die primäre Nummer bestätigt und die Zweitnummer war vorhanden, aber nicht bestätigt.
  • Y: Die Adresse wurde für die primäre und alle sekundären Telefonnummern durch die Datenschutzvereinbarung bestätigt.
  • Leer: Wenn die Antwort keinen dpvConfirmation-Wert enthält, wurde die Adresse nicht für die DPV-Bestätigung eingereicht.
dpvFootnote

string

Die Fußnoten aus der Validierung von Lieferpunkten. Es können mehrere Fußnoten in einem String aneinandergereiht werden.

  • AA: Eingabeadresse, die mit der ZIP + 4-Datei übereinstimmt
  • A1: Die Eingabeadresse wurde nicht mit der ZIP+4-Datei abgeglichen
  • BB: An Datenschutzanforderungen angepasst (alle Komponenten)
  • CC: Zweitnummer stimmt nicht überein und ist nicht erforderlich
  • C1: Zweitnummer stimmt nicht überein, ist aber erforderlich
  • N1: Die Adresse des Hochhauses hat keine Zweitnummer.
  • M1: Primäre Nummer fehlt
  • M3: Primäre Nummer ungültig
  • P1: PO-, RR- oder HC-Feldnummer der Eingabeadresse fehlt
  • P3: Die PO-, RR- oder HC-Box-Nummer der Eingabeadresse ist ungültig.
  • F1: Eingabeadresse, die mit einer Militäradresse übereinstimmt
  • G1: Eingabeadresse, die mit einer allgemeinen Lieferadresse übereinstimmt
  • U1: Eingabeadresse, die einer eindeutigen Postleitzahl zugeordnet ist
  • PB: Eingabeadresse, die mit dem PBSA-Eintrag übereinstimmt
  • RR: DPV-bestätigte Adresse mit PMB-Informationen
  • R1: DPV-bestätigte Adresse ohne PMB-Informationen
  • R7: Carrier Route 777- oder R779-Eintrag
  • IA: Informierte Adresse erkannt
  • TA: Primäre Nummer, die durch Löschen einer nachgestellten Alpha-Nummer übereinstimmt
dpvCmra

string

Gibt an, ob es sich bei der Adresse um eine CMRA (Commercial Mail Received Agency) handelt, also ein privates Unternehmen, das Post für Kunden empfängt. Gibt ein einzelnes Zeichen zurück.

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

Handelt es sich um eine Adresse ohne Statistik oder um eine aktive Adresse? Keine Statistikadressen sind Adressen, die nicht kontinuierlich besetzt sind, oder Adressen, die nicht vom USPS bedient werden. Gibt ein einzelnes Zeichen zurück.

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

integer

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

  • 1: IDA (Internal Drop Address) – Adressen, die E-Mails nicht direkt vom USPS erhalten, sondern an eine Postadresse zugestellt werden, die sie bedient.
  • 2: CDS – Adressen, die noch nicht lieferbar sind. Beispiel: eine neue Untergruppe, in der Grundstücke und Primärnummern bestimmt wurden, aber noch keine Struktur für die Belegung existiert.
  • 3: Kollision – Adressen, die nicht von DPV bestätigt werden.
  • 4: CMZ (College, Militär und andere Typen) – ZIP + 4 Datensätze, USPS hat die Daten berücksichtigt.
  • 5: Regulär: Gibt an, dass Adressen keine Zustellung erhalten und nicht als mögliche Zustellungen gezählt werden.
  • 6: „Sekundär“ erforderlich – Für diese Adresse sind sekundäre Informationen erforderlich.
dpvDrop

string

Kennzeichnung gibt an, dass E-Mails an einen einzelnen Empfangsempfänger auf einer Website zugestellt werden. Gibt ein einzelnes Zeichen zurück.

  • Y: Die E-Mail wird an einen einzelnen empfangsbaren Inhalt auf einer Website zugestellt.
  • N: Die E-Mail wird nicht an einen einzelnen Empfangsempfänger auf einer Website zugestellt.
dpvThrowback

string

Gibt an, dass keine Post an die Adresse zugestellt wird. Gibt ein einzelnes Zeichen zurück.

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

string

Kennzeichnung bedeutet, dass die E-Mail nicht an jedem Tag der Woche zugestellt wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Die E-Mail wird nicht an jedem Wochentag zugestellt.
  • N: Keine Angabe, dass die E-Mail nicht an jedem Wochentag zugestellt wird.
dpvNonDeliveryDaysValues

integer

Ganzzahl zur Kennzeichnung der Nicht-Auslieferungstage. Sie können mit Bit-Flags abfragen: 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 0x02 – Freitag ist ein Tag der Nichtlieferung 0x
dpvNoSecureLocation

string

Eine Fahne zeigt an, dass die Tür zugänglich ist, aber das Paket aus Sicherheitsgründen nicht abgelegt wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Das Paket wird aus Sicherheitsgründen nicht hinterlassen.
  • N: Kein Hinweis darauf, dass das Paket aufgrund von Sicherheitsbedenken nicht verlassen 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 wurde nicht mit dem PBSA-Eintrag abgeglichen.
dpvDoorNotAccessible

string

Kennzeichnung kennzeichnet Adressen, an denen USPS nicht an eine Tür klopfen darf, um Post zuzustellen. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Tür ist nicht zugänglich.
  • N: Es wird nicht angezeigt, dass die Tür nicht zugänglich ist.
dpvEnhancedDeliveryCode

string

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

  • Y: Die Adresse wurde für die primäre und alle sekundären Telefonnummern durch die Datenschutzvereinbarung bestätigt.
  • N: Die Daten aus der primären und sekundären Nummer konnten vom DPV nicht bestätigt werden.
  • S: Die Adresse wurde nur für die primäre Nummer bestätigt und die Zweitnummer war vorhanden, aber nicht bestätigt, oder eine nachgestellte Alpha-Nummer für eine Primärnummer wurde entfernt, um eine DPV-Übereinstimmung herzustellen und sekundäre Informationen erforderlich zu machen.
  • D: Die Adresse wurde nur für die primäre Nummer bestätigt und die Zweitnummer fehlt.
  • R: Adresse bestätigt, aber den Phantomrouten R777 und R779 zugewiesen. USPS-Übermittlung ist nicht angegeben.
carrierRoute

string

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

Präfixe:

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

string

Sortieranzeige für die vom Transportunternehmen berechnete Route.
ewsNoMatch

boolean

Die Lieferadresse kann abgeglichen werden, aus der EWS-Datei geht jedoch hervor, dass bald eine genaue Übereinstimmung verfügbar ist.
postOfficeCity

string

Stadt der Hauptpost.
postOfficeState

string

Bundesland des Hauptpostamts.
abbreviatedCity

string

Gekürzte Stadt.
fipsCountyCode

string

FIPS-Landkreiscode
county

string

Name des Landkreises.
elotNumber

string

eLOT-Nummer (Enhanced Line of Travel)
elotFlag

string

Aufsteigendes/Absteigendes eLOT-Flag (A/D).
poBoxOnlyPostalCode

boolean

Postleitzahl nur Postfach
pmbDesignator

string

Identifizator der 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. Dies ist die genaueste verfügbare Übereinstimmung für eine Adresse.
  • G: ALLGEMEINE LIEFERUNG. Dies ist eine Übereinstimmung mit einem Datensatz für allgemeine Zustellung.
  • H: BAU / APARTMENT. Dies ist eine Übereinstimmung mit einem Gebäude- oder Wohnungseintrag.
  • P: Postamt. Dies ist eine Übereinstimmung mit einem Postfach.
  • R: RURAL ROUTE oder HIGHWAY CONTRACT: Dies ist eine Übereinstimmung mit einem Eintrag auf einer ländlichen Route oder einem Fernstraßenvertrag, für den beide Bereiche enthalten sein können.
  • S: STREET RECORD: Dies ist eine Übereinstimmung mit einem Street-Datensatz, der einen gültigen primären Zahlenbereich enthält.
defaultAddress

boolean

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

string

Fehlermeldung beim USPS-Datenabruf. Dieses Feld wird ausgefüllt, wenn die USPS-Verarbeitung aufgrund der Erkennung künstlich erstellter Adressen ausgesetzt wird.

Die USPS-Datenfelder sind in diesem Fall möglicherweise nicht ausgefüllt.
cassProcessed

boolean

Zeigt an, dass die Anfrage von CASS verarbeitet wurde.

UspsAddress

USPS-Darstellung einer US-amerikanischen 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

Bundesstaatcode mit zwei Buchstaben.
zipCode

string

Postleitzahl z.B. 10009.
zipCodeExtension

string

Vierstellige Postleitzahlerweiterung, z.B. 5023 aus.