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)
  }
}
Felder
address

object (PostalAddress)

Erforderlich. Die zu überprüfende Adresse. Nicht formatierte Adressen müssen über addressLines gesendet werden.

Die Felder in dieser Eingabe dürfen insgesamt maximal 280 Zeichen lang sein.

Unterstützte Regionen

Der Wert languageCode in der Eingabeadresse ist für zukünftige Verwendungen reserviert und wird heute ignoriert. Das validierte Adressergebnis wird anhand der vom System ermittelten bevorzugten Sprache für die angegebene 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. Bitte 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, neu validiert werden müssen, muss dieses Feld in jeder Folgeanfrage mit dem responseId aus der ersten Antwort in der Validierungssequenz gefü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 USPS CASS-fähigen Anfragen für Adressen in Puerto Rico muss ein google.type.PostalAddress.region_code von address als „PR“ oder ein google.type.PostalAddress.administrative_area von address als „Puerto Rico“ (Groß-/Kleinschreibung wird nicht berücksichtigt) oder „PR“ angegeben werden.

Wir empfehlen, 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. Vorschau: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‐Funktionen werden möglicherweise 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 der Address Validation API, zusätzliche Informationen in die Antwort aufzunehmen.

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 noch einmal überprüft 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 Adress-Widget wie https://github.com/google/libaddressinput. Nutzer sollten außerhalb von Ländern, in denen dieses Feld verwendet wird, keine UI-Elemente für die Eingabe oder Bearbeitung von Feldern sehen.

Weitere Informationen zur Verwendung dieses Schemas finden Sie unter https://support.google.com/business/answer/6397478.

JSON-Darstellung
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Felder
revision

integer

Die Schemaüberarbeitung von PostalAddress. Jeder Wert außer 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 kein Regionscode angegeben ist, wird er von der Adresse abgeleitet. Für eine optimale Leistung wird empfohlen, den Regionscode anzugeben, wenn Sie ihn kennen. Inkonsistente oder wiederholte Regionen können zu Leistungseinbußen führen. Wenn beispielsweise addressLines die Region bereits enthält, geben Sie den 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 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 einzelnen Feld enthalten sind (z.B. „Austin, TX“), muss die Zeilenreihenfolge klar 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 im addressLines enthaltenen Informationen. 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 anschließend die Geocodierung. So muss nicht geraten werden, welche Teile der Adresse Orte oder Verwaltungsgebiete sind.

recipients[]

string

Bitte geben Sie dieses Feld nicht an. Die Address Validation API wird derzeit nicht verwendet. Derzeit lehnt die API zwar Anfragen mit diesem festgelegten Feld nicht ab, die Informationen werden jedoch verworfen und nicht in der Antwort zurückgegeben.

organization

string

Bitte geben Sie dieses Feld nicht an. Die Address Validation API wird derzeit nicht verwendet. Derzeit lehnt die API zwar Anfragen mit diesem festgelegten Feld nicht ab, die Informationen werden jedoch verworfen und nicht in der Antwort zurückgegeben.

Sprachoptionen

Vorschau: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‐Funktionen werden möglicherweise 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 der Address Validation API, zusätzliche Informationen in die Antwort aufzunehmen.

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

boolean

Vorschau: Ein 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 Überprüfung 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 zu Gesamtergebnissen

address

object (Address)

Informationen über die Adresse selbst im Gegensatz zur Geocodierung.

geocode

object (Geocode)

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

metadata

object (AddressMetadata)

Sonstige Informationen, die für die Zustellbarkeit relevant sind. Das Feld metadata ist nicht zwangsläufig für jede Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt.

uspsData

object (UspsData)

Zusätzliche Flags zur Zustellbarkeit wurden von USPS bereitgestellt. Nur in den Regionen US und PR verfügbar.

englishLatinAddress

object (Address)

Vorschau: Diese Funktion ist eine Vorabversion (pre-GA). Pre-GA-Produkte und ‐Funktionen werden möglicherweise 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 zur Auswahl der alternativen Sprache 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 der Adressüberprüfung 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)

Der Detaillierungsgrad der input-Adresse. Dies ist das Ergebnis des Parsens der Eingabeadresse und es werden keine Validierungssignale geliefert. Informationen zu Validierungssignalen finden Sie unten unter validationGranularity.

Wenn die Eingabeadresse beispielsweise eine bestimmte Wohnungsnummer enthält, lautet 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 niedriger.

validationGranularity

enum (Granularity)

Der Detaillierungsgrad, bei dem die API die Adresse vollständig validieren kann. Ein validationGranularity mit dem Wert PREMISE gibt beispielsweise an, dass alle Adresskomponenten auf der Ebene PREMISE 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 der grob oder fein der geocodierten Position verstanden werden.

Diese kann gelegentlich von den validationGranularity oben abweichen. Es kann beispielsweise sein, dass unsere Datenbank die Existenz einer Wohnungsnummer speichert, aber keinen genauen Standort für die Wohnung in einem großen Apartmentkomplex enthält. 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. 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

Es wurde mindestens eine Adresskomponente 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 Detaillierungen, die eine Adresse oder ein Geocode haben kann. Wenn diese Werte zur Angabe des Detaillierungsgrads für eine Adresse verwendet werden, geben diese Werte an, wie fein die Adresse ein Versandziel identifiziert. Eine Adresse wie „123 Main Street, Redwood City, CA, 94061“ identifiziert beispielsweise ein PREMISE, während eine Adresse wie „Redwood City, CA, 94061“ ein LOCALITY identifiziert. Wenn wir jedoch keinen Geocode für „Hauptstraße 123“ in Redwood City finden können, hat die zurückgegebene Geocodierung möglicherweise den Detaillierungsgrad LOCALITY, obwohl die Adresse differenzierter 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 ungefähren Standort der Adresse auf Gebäudeebene angibt.
BLOCK Die Adresse oder der Geocode gibt einen Block an. Wird nur in Regionen mit Adressierung auf Blockebene verwendet, z. B. Japan.
ROUTE Der Geocode oder die Adresse ist detailliert für die Route, z. B. eine Straße, Straße oder Autobahn.
OTHER Alle anderen Detaillierungsgrade, die zusammengefasst werden, da sie nicht lieferbar sind.

Adresse

Details zur nachbearbeiteten Adresse. Die Nachbearbeitung umfasst die Korrektur 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 als einzeilige Adresse gemäß den Formatierungsregeln für Adressen der Region formatiert ist, 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. Hier finden Sie Informationen zum Validierungsstatus der einzelnen Komponenten.

Adresskomponenten sind nicht in einer bestimmten Reihenfolge angeordnet. Machen Sie keine Annahmen über die Reihenfolge der Adresskomponenten in der Liste.

missingComponentTypes[]

string

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

unconfirmedComponentTypes[]

string

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

unresolvedTokens[]

string

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. Beispiel: In einer Eingabe wie „123235253253 Main St, San Francisco, CA, 94105“ sehen die nicht aufgelösten Tokens möglicherweise wie ["123235253253"] aus, da dies keine gültige Hausnummer ist.

Adresskomponente

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 für diese Komponente.

componentType

string

Der Typ der Adresskomponente. Eine Liste möglicher Typen finden Sie unter 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 haben sie jedoch als Adressstandort abgeleitet und glauben, dass sie für eine vollständige Adresse bereitgestellt werden sollte.

spellCorrected

boolean

Gibt eine Korrektur eines Rechtschreibfehlers im Komponentennamen an. Die API meldet Änderungen von einer Schreibvariante an eine andere nicht immer, z. B. wenn „centre“ in „center“ geändert wird. Auch häufig verwendete abweichende Schreibweisen, zum Beispiel die Änderung von "Amphitheater Pkwy" in "Amphitheatre Pkwy", werden nicht immer erkannt.

replaced

boolean

Gibt an, dass der Name der Komponente durch einen völlig anderen Namen ersetzt wurde, z. B. wird eine falsche Postleitzahl durch eine für die Adresse richtige Postleitzahl ersetzt. Dies ist keine kosmetische Änderung. Die Eingabekomponente wurde geändert.

unexpected

boolean

Gibt eine Adresskomponente an, die nicht in einer Postanschrift für die angegebene Region vorhanden sein muss. Wir haben sie nur gespeichert, weil sie Teil der Eingabe war.

Komponentenname

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 keiner Sprache zugeordnet ist, z. B. mit einer Hausnummer.

Bestätigungsebene

Die verschiedenen möglichen Werte für Bestätigungsstufen.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
CONFIRMED Wir konnten überprüfen, ob diese Komponente existiert und im Zusammenhang mit dem Rest der Adresse sinnvoll ist.
UNCONFIRMED_BUT_PLAUSIBLE Diese Komponente konnte nicht bestätigt werden, es ist jedoch plausibel, dass sie existiert. Dies kann beispielsweise eine Hausnummer innerhalb eines gültigen Nummernbereichs für eine Straße sein, in der die spezifischen Hausnummern nicht bekannt sind.
UNCONFIRMED_AND_SUSPICIOUS Diese Komponente wurde nicht bestätigt und ist wahrscheinlich falsch. Beispiel: ein Stadtteil, der nicht zur übrigen Adresse passt.

Geocodieren

Enthält Informationen über den Ort, an 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 Ort 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 Routen 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 Zugriffspunkts zum Objekt befindet. Außerdem gibt es bei der umgekehrten Geocodierung eines Standorts keine Garantie, dass die zurückgegebene Adresse mit dem Original übereinstimmt.

plusCode

object (PlusCode)

Der Plus Code, der location entspricht.

bounds

object (Viewport)

Die Grenzen des geocodierten Ortes.

featureSizeMeters

number

Die Größe des geocodierten Orts in Metern. Dies ist ein weiteres Maß für die Grobheit des geocodierten Standorts, allerdings nicht hinsichtlich der semantischen Bedeutung, sondern anhand der physischen Größe.

placeId

string

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

Weitere Informationen zu Orts-IDs

placeTypes[]

string

Der Typ(en) des Ortes, für den die Eingabe geocodiert wurde. Beispiel: ['locality', 'political']. Die vollständige Liste der Typen finden Sie hier.

LatLng

Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Wird als Paar von Double-Werten ausgedrückt, um den Breitengrad und den Längengrad darzustellen. 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: mit globalem Code, mit dem ein Rechteck mit einer Größe von 14 x 14 m (1/8.000. eines Grades) oder kleiner definiert wird, und zusammengesetztem 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“, der eine Fläche von 1/8.000 × 1/8.000 Grad (~14 × 14 Meter) darstellt.

compoundCode

string

Der zusammengesetzte 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 mit Breiten- und Längengrad, dargestellt als zwei diagonal gegenüberliegende low- und high-Punkte Ein Darstellungsbereich wird als geschlossener Bereich betrachtet, d.h. er enthält seine Begrenzung. Die Breitengrenzen müssen zwischen -90 und 90 Grad (einschließlich) und die Längengradgrenzen zwischen -180 und 180 Grad (einschließlich) liegen. Verschiedene Fälle sind z. B.:

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

  • Wenn low.longitude > high.longitude ist, wird der Längengradbereich umgekehrt, d. h., der Darstellungsbereich kreuzt die 180-Grad-Längengradlinie.

  • 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 Darstellungsbereich umfasst beispielsweise New York City:

}

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

object (LatLng)

Erforderlich. Tiefstpunkt des Darstellungsbereichs

high

object (LatLng)

Erforderlich. Der höchste Punkt des Darstellungsbereichs

Adressmetadaten

Die Metadaten für die Adresse. Das Feld metadata ist nicht zwangsläufig 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 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.

USPS-Daten

Die USPS-Daten für die Adresse. Das Feld uspsData ist nicht zwangsläufig für jede US- oder PR-Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt. Es wird empfohlen, die Backup-Adressfelder 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,
  "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 der Lieferstelle. Diese Nummer wird bei mechanisch gescannten E-Mails am Ende des delivery_point_barcode eingefügt. Wenn alle Ziffern von delivery_point_barcode, deliveryPointCheckDigit, der Postleitzahl und von ZIP+4 zusammengerechnet werden, ergibt sich eine durch 10 teilbare Zahl.

dpvConfirmation

string

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

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

string

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

  • AA: Die eingegebene Adresse stimmt mit der ZIP+4-Datei überein.
  • A1: Die eingegebene Adresse stimmte nicht mit der ZIP+4-Datei überein
  • BB: an DPV angepasst (alle Komponenten)
  • CC: Zweitnummer nicht zugeordnet (vorhanden, aber ungültig)
  • N1: Hochhausadresse hat keine Zweitnummer
  • M1: Primäre Nummer fehlt
  • M3: Primäre Nummer ungültig
  • P1: Nummer des RR- oder Hilfefelds für die Eingabeadresse fehlt
  • P3: Bestellnummer für die eingegebene Adresse, die Bestellnummer oder die Nummer der Hilfebox ist ungültig
  • F1: Eingabeadresse stimmt mit einer Militäradresse überein
  • G1: Eingabeadresse stimmt mit einer allgemeinen Lieferadresse überein
  • U1: Die eingegebene Adresse stimmt mit einer eindeutigen Postleitzahl überein
  • PB: Eingabeadresse stimmt mit PBSA-Eintrag überein
  • RR: Vom öffentlichen Verkehrsunternehmen bestätigte Adresse mit Informationen zum PMB
  • R1: Vom öffentlichen Verkehrsunternehmen bestätigte Adresse ohne PMB-Informationen
  • R7: Carrier Route R777- oder R779-Eintrag
dpvCmra

string

Gibt an, ob es sich bei der Adresse um eine CMRA (Commercial Mail Recipient Agency) handelt, d. h. ein privates Unternehmen, das E-Mails für Kunden erhält. Gibt ein einzelnes Zeichen zurück.

  • Y: Die Adresse ist eine CMRA-Adresse.
  • N: Die Adresse ist keine CMRA-Adresse.
dpvVacant

string

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

  • Y: Die Adresse ist leer.
  • N: Die Adresse ist ungültig
dpvNoStat

string

Handelt es sich um eine Adresse vom Typ „Keine Statistik“ oder eine aktive Adresse? Keine Statistikadressen sind solche, die nicht ständig belegt sind, oder Adressen, die vom USPS nicht bedient werden. Gibt ein einzelnes Zeichen zurück.

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

string

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

Präfixe:

  • C: Route des Transportunternehmens (oder Stadtstraße)
  • R: Landstraße
  • H: Fernstraßenvertragsroute
  • B: Postfach
  • G: Allgemeine Auslieferungseinheit
carrierRouteIndicator

string

Sortieranzeige für Routenkosten des Transportunternehmens.

ewsNoMatch

boolean

Die Lieferadresse kann abgeglichen werden, laut EWS-Datei wird aber demnächst eine genaue Übereinstimmung verfügbar sein.

postOfficeCity

string

Stadt der Hauptpoststelle

postOfficeState

string

Hauptstaat der Postfiliale.

abbreviatedCity

string

Stadt (abgekürzt)

fipsCountyCode

string

FIPS County-Code.

county

string

Name des Landkreises.

elotNumber

string

eLOT-Nummer (Enhanced Line of Travel)

elotFlag

string

Aufsteigende/absteigende eLOT-Markierung (A/D).

poBoxOnlyPostalCode

boolean

Postleitzahl nur für Postfach

pmbDesignator

string

PMB-Einheitenbezeichner (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 ist eine Übereinstimmung mit einem allgemeinen Lieferdatensatz.
  • H: GEBRAUCH / WERBEApartment. Dies ist eine Übereinstimmung mit einem Gebäude- oder Apartmentdatensatz.
  • P: POST OFFICE BOX. Dies entspricht einem Postfach.
  • R: ROUTEN- oder HIGHWAY-VERTRAG: Dies ist eine Übereinstimmung mit einer Landstraße oder einem Fernstraßenvertrag, die beide über verknüpfte Box-Nummernbereiche verfügen können.
  • S: STREET RECORD: Dies ist eine Übereinstimmung mit einem Street View-Datensatz, der einen gültigen primären Zahlenbereich enthält.
defaultAddress

boolean

Zeigt an, dass eine Standardadresse gefunden wurde, es aber genauere Adressen gibt.

errorMessage

string

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

Wenn dieser Fehler auftritt, werden die USPS-Datenfelder möglicherweise nicht ausgefüllt.

cassProcessed

boolean

Zeigt an, dass die Anfrage über CASS verarbeitet wurde.

USPS-Adresse

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

Vierstellige Postleitzahlerweiterung, z.B. 5023.