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 Gesamtlänge der Felder in dieser Eingabe darf 280 Zeichen nicht überschreiten.

Eine Liste der unterstützten Regionen finden Sie hier.

Der languageCode-Wert in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird derzeit 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 für die vollständige Validierung einer einzelnen Adresse weitere Anfragen erforderlich sind (z. B. wenn die vom Nutzer nach der ersten Validierung vorgenommenen Änderungen noch einmal validiert werden müssen), muss dieses Feld in jeder Folgeanfrage mit der responseId aus 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 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“ (Groß-/Kleinschreibung nicht berücksichtigend) oder „PR“ angegeben werden.

Wir empfehlen, eine komponentenbasierte address zu verwenden. Alternativ können Sie mindestens zwei google.type.PostalAddress.address_lines angeben, wobei die erste Zeile die Hausnummer und den Straßennamen und die zweite Zeile die Stadt, den Bundesstaat und die Postleitzahl enthält.
languageOptions

object (LanguageOptions)

Optional. Vorabversion: Diese Funktion befindet sich in der 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.

Ermöglicht es der Address Validation API, zusätzliche Informationen in die Antwort aufzunehmen.
sessionToken

string

Optional. Ein String, der eine Autocomplete-Sitzung zu Abrechnungszwecken identifiziert. Muss ein URL- und Dateinamen-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-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 und eine „Places Details“- oder „Adressüberprüfung“-Anfrage umfassen. Die Anmeldedaten, die für jede Anfrage innerhalb einer Sitzung verwendet werden, müssen zu demselben 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: Die Adressbestätigung kann nur in Sitzungen mit der Autocomplete (New) API, 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 Adressbestätigung.

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 Adressbestätigung.
responseId

string

Die UUID, die diese Antwort identifiziert. Wenn die Adresse noch einmal bestätigt werden muss, 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 Address Widget wie https://github.com/google/libaddressinput. Nutzer sollten nur UI-Elemente für die Eingabe oder Bearbeitung von Feldern sehen, die in ihrem Land verwendet 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 der 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 der Regionscode nicht angegeben ist, wird er aus der Adresse abgeleitet. Für eine optimale Leistung wird empfohlen, den Regionscode anzugeben, falls er Ihnen bekannt ist. Inkonsistente oder wiederholte Regionen können zu einer schlechten Leistung führen. Wenn die addressLines beispielsweise bereits die Region enthält, geben Sie die Regionscode in diesem Feld nicht noch einmal an. 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 derzeit ignoriert. Die API gibt die Adresse in der Sprache zurück, die für den Standort der Adresse geeignet ist.
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 beinhalten 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 geringste 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.

Es empfiehlt sich, für vollständig unstrukturierte Adressen eine Adresse mit nur addressLines zu erstellen und danach eine Geocodierung dafür durchzuführen. So muss nicht geraten werden, welche Teile der Adresse Postorte oder Verwaltungsgebiete darstellen.
recipients[]

string

Legen Sie dieses Feld nicht fest. Sie wird derzeit nicht von der Address Validation API verwendet. Derzeit werden Anfragen mit diesem Feld in der API nicht abgelehnt. Die Informationen werden jedoch 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 befindet sich in der 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.

Ermöglicht es der Address Validation API, zusätzliche Informationen in die Antwort aufzunehmen.

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

boolean

Vorschau: Gibt einen google.maps.addressvalidation.v1.Address auf Englisch zurück. Weitere Informationen finden Sie 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)

Flags für das Gesamturteil
address

object (Address)

Informationen zur Adresse selbst, nicht zur Geocodierung.
geocode

object (Geocode)

Informationen zum Standort und Ort, zu dem die Adresse geocodiert wurde.
metadata

object (AddressMetadata)

Sonstige für die Zustellbarkeit relevante Informationen. Es kann nicht garantiert werden, dass metadata für jede an die Address Validation API gesendete Adresse vollständig ausgefüllt ist.
uspsData

object (UspsData)

Zusätzliche Flags zur Zustellbarkeit, die von USPS bereitgestellt werden. Nur in den Regionen US und PR verfügbar.
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 in englischer Sprache.

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

Wenn für einen Teil der Adresse keine englische Übersetzung vorhanden ist, gibt der Dienst diesen Teil in einer anderen Sprache zurück, die ein lateinisches Schriftsystem verwendet. Hier finden Sie eine Erklärung dazu, wie die alternative Sprache ausgewählt wird. Wenn für einen Teil der Adresse keine Übersetzungen oder Transliterationen in einer Sprache mit lateinischem Alphabet verfügbar sind, gibt der Dienst diesen Teil in der mit der Adresse verknüpften Landessprache zurück.

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

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.

Urteil

Grober Überblick über das Ergebnis der Adressbestätigung und den Geocode.

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

enum (Granularity)

Die Detaillierung der Eingabeadresse. Dies ist das Ergebnis des Parsens der Eingabeadresse und gibt keine Validierungssignale. Informationen zu Validierungssignalen finden Sie unten unter validationGranularity.

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

enum (Granularity)

Die Detailebene, auf der die API die Adresse vollständig validieren kann. Ein validationGranularity von PREMISE bedeutet beispielsweise, dass alle Adresskomponenten auf der Ebene von PREMISE oder gröber validiert werden können.

Die Ergebnisse der Validierung der einzelnen Adresskomponenten finden Sie unter 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 genau der geocodierte Standort ist.

Dieser kann gelegentlich von validationGranularity oben abweichen. In unserer Datenbank ist beispielsweise die Existenz einer Wohnungsnummer erfasst, aber es ist nicht genau bekannt, wo sich die Wohnung in einem großen Wohnkomplex befindet. In diesem Fall ist die validationGranularity SUB_PREMISE, die geocodeGranularity aber PREMISE.
addressComplete

boolean

Die Adresse gilt als vollständig, wenn keine nicht aufgelösten Tokens, keine unerwarteten oder fehlenden Adresskomponenten vorhanden sind. Wenn kein Wert festgelegt ist, bedeutet dies, dass der Wert false ist. Weitere Informationen finden Sie 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 Detaillierungsgrade, die eine Adresse oder ein Geocode haben kann. Wenn diese Werte verwendet werden, um die Detailgenauigkeit einer Adresse anzugeben, geben sie an, mit welcher Detailgenauigkeit die Adresse ein Ziel für die Zustellung von E-Mails identifiziert. Eine Adresse wie „123 Main Street, Redwood City, CA, 94061“ bezeichnet beispielsweise eine PREMISE, während „Redwood City, CA, 94061“ eine LOCALITY bezeichnet. Wenn wir jedoch keinen Geocode für „123 Main Street“ in Redwood City finden, kann der zurückgegebene Geocode eine LOCALITY-Genauigkeit haben, auch wenn die Adresse detaillierter ist.

Enums
GRANULARITY_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
SUB_PREMISE Ergebnis unterhalb der Gebäudeebene, z. B. ein Apartment.
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 Detailebenen, die zusammengefasst werden, da sie nicht ausgeliefert werden können.

Adresse

Details zur nachbearbeiteten Adresse. Die Nachbearbeitung umfasst das Korrigieren falsch geschriebener Teile der Adresse, das Ersetzen falscher Teile und das Erschließen fehlender Teile.

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

string

Die nachbehandelte Adresse, formatiert als eine Zeile gemäß den Adressformatierungsregeln der Region, in der sich die Adresse befindet.

Hinweis: Das Format dieser Adresse stimmt möglicherweise nicht mit dem Format der Adresse im Feld postalAddress überein. Beispiel: Das postalAddress steht immer für das Land als zweistelliger regionCode, z. B. „DE“ oder „NZ“. In diesem Feld wird dagegen eine längere Form des Landesnamens verwendet, z. B. „USA“ oder „Neuseeland“.
postalAddress

object (PostalAddress)

Die nachbearbeitete Adresse, dargestellt als Postanschrift.
addressComponents[]

object (AddressComponent)

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

Adresskomponenten sind nicht auf eine bestimmte Weise angeordnet. Gehen Sie nicht davon aus, dass die Adresskomponenten in der Liste in einer bestimmten Reihenfolge angeordnet sind.
missingComponentTypes[]

string

Die Arten von Komponenten, die in einer korrekt formatierten Postanschrift vorhanden sein sollten, aber in der Eingabe nicht gefunden wurden ODER nicht abgeleitet werden konnten. 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“. Eine Liste der möglichen Typen finden Sie hier.
unconfirmedComponentTypes[]

string

Die Typen der Komponenten, die in der addressComponents vorhanden sind, deren Richtigkeit jedoch nicht bestätigt werden konnte. Dieses Feld dient der Bequemlichkeit: Sein Inhalt entspricht einer Iteration durch die addressComponents, um die Typen aller Komponenten zu finden, bei denen confirmationLevel nicht CONFIRMED ist oder das inferred-Flag 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. Möglicherweise wurde eine Eingabe nicht als gültiger Teil einer Adresse erkannt. Bei einer Eingabe wie „Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US“ sehen die nicht aufgelösten Tokens beispielsweise so aus: ["Parcel", "0000123123", "&", "0000456456"].

AddressComponent

Stellt eine Adresskomponente dar, 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: 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, wir sie aber für den Standort der Adresse abgeleitet haben und der Meinung sind, dass sie für eine vollständige Adresse angegeben werden sollte.
spellCorrected

boolean

Gibt eine Korrektur einer Rechtschreibfehler im Komponentennamen an. Die API meldet nicht immer Änderungen von einer Schreibvariante zu einer anderen, z. B. wenn „Zentrum“ in „Zentrum“ geändert wird. Außerdem werden nicht immer häufige Rechtschreibfehler gemeldet, z. B. wenn „Amphitheater Pkwy“ in „Amphitheatre Pkwy“ geändert wird.
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 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 Name. Beispiel: „5th Avenue“ für einen Straßennamen oder „1253“ für eine 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 bestätigen, dass diese Komponente vorhanden ist und im Kontext der restlichen Adresse sinnvoll ist.
UNCONFIRMED_BUT_PLAUSIBLE Diese Komponente konnte nicht bestätigt werden, es ist aber wahrscheinlich, dass sie vorhanden ist. Beispiel: Eine Hausnummer innerhalb eines bekannten gültigen Zahlenbereichs in einer Straße, in der bestimmte Hausnummern nicht bekannt sind.
UNCONFIRMED_AND_SUSPICIOUS Diese Komponente wurde nicht bestätigt und ist wahrscheinlich falsch. Dies kann beispielsweise ein Viertel sein, das nicht zum Rest der Adresse passt.

Geocode

Enthält Informationen zum Ort, zu dem 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 ist gegenüber Adressen, Breiten- und Längengraden oder Plus Codes vorzuziehen. Wenn Sie beim Berechnen von Routen oder Wegbeschreibungen Koordinaten verwenden, wird der Punkt immer an der Straße angedockt, die diesen Koordinaten am nächsten ist. 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 dafür, dass die zurückgegebene Adresse mit der ursprünglichen übereinstimmt, wenn ein Standort umgekehrt geocodiert wird.
plusCode

object (PlusCode)

Der Plus Code, der 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, jedoch in Bezug auf die physische Größe und nicht auf die semantische Bedeutung.
placeId

string

Die PlaceID des Orts, zu dem diese Eingabe geocodiert wird.

Weitere Informationen zu Orts-IDs
placeTypes[]

string

Der oder die Typ(en) des Ortes, 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 es dem World Geodetic System 1984 (WGS 84) 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.

Plus Code

Ein Plus Code (http://plus.codes) ist ein Standortbezug mit zwei Formaten: ein globaler Code, der ein Rechteck von 14 × 14 m (1/8.000stel eines Grades) oder kleiner definiert, und ein zusammengesetzter Code, bei dem das Präfix durch einen Referenzstandort 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

Der zusammengesetzte Code des Orts, z. B. „33GV+HQ, Ramberg, Norwegen“, mit dem Suffix des globalen Codes und dem Präfix einer formatierten Referenzentität.

Darstellungsbereich

Ein Breiten- und Längengrad-Darstellungsbereich, dargestellt als zwei diagonal gegenüberliegende Punkte low und high. Ein Darstellungsbereich gilt als geschlossene Region, d. h., er schließt seine Grenze ein. Die Breitengradgrenzen müssen zwischen -90 und 90 Grad liegen und die Längengradgrenzen zwischen -180 und 180 Grad. Beispiele für verschiedene Fälle:

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

  • Wenn low.longitude > high.longitude ist, ist der Längengradbereich umgekehrt (der Darstellungsbereich schneidet den Längengrad 180).

  • 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 ist, ist der Breitengradbereich leer.

Sowohl low als auch high müssen ausgefüllt sein und das dargestellte Feld darf nicht leer sein (wie in den Definitionen oben angegeben). Ein leerer Darstellungsbereich führt zu einem Fehler.

Dieser Ansichtsbereich umschließt beispielsweise vollständig 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 des Darstellungsbereichs.

AddressMetadata

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

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

boolean

Gibt an, dass es sich um die Adresse eines Unternehmens handelt. Wenn dieser Parameter nicht festgelegt ist, ist der Wert unbekannt.
poBox

boolean

Gibt an, dass es sich um die Adresse eines Postfachs handelt. Wenn kein Wert festgelegt ist, ist der Wert unbekannt.
residential

boolean

Gibt an, dass es sich um die Adresse eines Privathauses handelt. Wenn dieser Parameter nicht festgelegt ist, ist der Wert unbekannt.

UspsData

Die USPS-Daten für die Adresse. Es kann nicht garantiert werden, dass uspsData für jede an die Address Validation API gesendete US- oder PR-Adresse vollständig ausgefüllt ist. Wir empfehlen, die Felder für die Ersatzadresse in die Antwort einzubinden, wenn Sie „uspsData“ als Hauptteil 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)

USPS-Standardadresse.
deliveryPointCode

string

Zweistelliger Code des Lieferorts
deliveryPointCheckDigit

string

Die Prüfziffer des Lieferorts. Diese Nummer wird am Ende des delivery_point_barcode für mechanisch gescannte Post hinzugefügt. Die Summe aller Ziffern von delivery_point_barcode, deliveryPointCheckDigit, postal_code und ZIP+4 muss durch 10 teilbar sein.
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 per DPV bestätigt und die Informationen zur sekundären Nummer fehlten.
  • S: Die Adresse wurde nur für die primäre Nummer per DPV bestätigt. Die Informationen zur sekundären Nummer waren 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 zur DPV-Bestätigung gesendet.
dpvFootnote

string

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

  • AA: Die Eingabeadresse, die mit der ZIP+4-Datei übereinstimmt
  • A1: Die Eingabeadresse wurde nicht mit der ZIP+4-Datei abgeglichen
  • BB: Mit DPV abgeglichen (alle Komponenten)
  • CC: Sekundäre Nummer stimmt nicht überein und ist nicht erforderlich
  • C1: Zweitnummer stimmt nicht überein, ist aber erforderlich
  • N1: Für Adresse eines Hochhauses fehlt die sekundäre Nummer
  • M1: Primäre Nummer fehlt
  • M3: Die primäre Nummer ist ungültig.
  • P1: PO-, RR- oder HC-Feldnummer der Eingabeadresse fehlt
  • P3: Die Postfachnummer der Eingabeadresse (PO, RR oder HC) ist ungültig.
  • F1: Die Eingabeadresse stimmt mit einer Militäradresse überein.
  • 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: Von DPV bestätigte Adresse ohne PMB-Informationen
  • R7: Eintrag „Carrier Route R777“ oder „Carrier Route R779“
  • IA: Die benachrichtigte Adresse wurde ermittelt.
  • TA: Primäre Nummer, die durch Weglassen eines nachfolgenden Alphazeichens übereinstimmt
dpvCmra

string

Gibt an, ob es sich bei der Adresse um eine CMRA (Commercial Mail Receiving Agency) handelt, also um 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 Platz frei? Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse ist unbewohnt
  • N: Die Adresse ist nicht frei.
dpvNoStat

string

Ist dies eine Adresse ohne Status oder 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 Grundcode als int 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 Parzelle, für die Parzellen und Hauptnummern festgelegt wurden, aber noch kein Gebäude für die Belegung vorhanden ist.
  • 3: Kollision: Adressen, die nicht durch DPV bestätigt werden.
  • 4: CMZ (College, Militär und andere Typen) – ZIP + 4 Datensätze, USPS hat die Daten berücksichtigt.
  • 5: Normal: Gibt Adressen an, an die keine Zustellung erfolgt. Diese Adressen werden nicht als mögliche Zustellungen gezählt.
  • 6: Sekundär erforderlich: Für die Adresse sind sekundäre Informationen erforderlich.
dpvDrop

string

Das Flag gibt an, dass die Post an einem Standort an einem einzigen Abholort zugestellt wird. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Post wird an einem Standort an einem einzigen Abholort zugestellt.
  • N: Die Post wird nicht an einem einzigen Ort zugestellt.
dpvThrowback

string

Gibt an, dass die Post nicht an die angegebene Adresse zugestellt wird. 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 Zustellung nicht an jedem Wochentag erfolgt. 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, die die Tage angibt, an denen keine Zustellung stattgefunden hat. 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: Keine Angabe, dass das Paket aus Sicherheitsgründen nicht zugestellt 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

Gibt Adressen an, an denen die USPS nicht an der Tür klingeln kann, um Post zuzustellen. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Tür ist nicht barrierefrei.
  • N: Es gibt keine Hinweise darauf, dass die Tür nicht barrierefrei 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 Nummern per DPV bestätigt.
  • N: Die Informationen zur primären und allen sekundären Nummern konnten nicht per DPV 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: Die Adresse wurde bestätigt, aber dem Phantom-Weg R777 und R779 zugewiesen. Die Zustellung durch USPS ist nicht möglich.
carrierRoute

string

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

Präfixe:

  • C: Betreiberroute (oder Stadtbuslinie)
  • R: Ländliche Route
  • H: Autobahn-Vertragsroute
  • B: Abschnitt für Postfach
  • G: Allgemeine Übermittlungseinheit
carrierRouteIndicator

string

Sortierindikator für den Preis des Transportunternehmens.
ewsNoMatch

boolean

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

string

Ort der Hauptpost.
postOfficeState

string

Bundesland des Hauptpostamts.
abbreviatedCity

string

Abgekürzte Stadt.
fipsCountyCode

string

FIPS-County-Code.
county

string

Name des Landkreises.
elotNumber

string

eLOT-Nummer (Enhanced Line of Travel)
elotFlag

string

eLOT-Flag für aufsteigend/absteigend (A/D).
poBoxOnlyPostalCode

boolean

Postleitzahl nur Postfach
pmbDesignator

string

PMB (Private Mail Box)-Einheitsbezeichner.
pmbNumber

string

PMB-Nummer (Private Mail Box)
addressRecordType

string

Der Typ des Adresseintrags, der mit der Eingabeadresse übereinstimmt.

  • F: FIRM. Dies ist eine Übereinstimmung mit einem Firmeneintrag, was die genaueste verfügbare Übereinstimmung für eine Adresse darstellt.
  • G: ALLGEMEINE LIEFERUNG. Dieser Datensatz stimmt mit einem Datensatz für die Allgemeinzustellung überein.
  • H: BAU / APARTMENT. Es gibt eine Übereinstimmung mit einem Gebäude- oder Wohnungseintrag.
  • P: POSTFACH. Dies ist eine Übereinstimmung mit einem Postfach.
  • R: LÄNDLICHE STRASSE oder STRASSENBAUVERTRAG: Dies ist eine Übereinstimmung mit einem Eintrag für eine ländliche Straße oder einen Straßenbauvertrag. Beide können Bereiche mit Postleitzahlen haben.
  • S: STRASSENEINTRAG: Dies ist eine Übereinstimmung mit einem Straßeneintrag mit einem gültigen primären Nummernbereich.
defaultAddress

boolean

Ein Indikator dafür, dass eine Standardadresse gefunden wurde, es aber spezifischere Adressen gibt.
errorMessage

string

Fehlermeldung beim Abrufen von USPS-Daten Dieses Feld wird ausgefüllt, wenn die USPS-Verarbeitung aufgrund der Erkennung von künstlich erstellten Adressen ausgesetzt wird.

Die USPS-Datenfelder sind bei diesem Fehler möglicherweise nicht ausgefüllt.
cassProcessed

boolean

Gibt an, dass die Anfrage mit 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

Firmenname.
secondAddressLine

string

Zweite Adresszeile.
urbanization

string

Name der Urbanisierung in Puerto Rico.
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.