Address Validation (beta)

Klasse AddressValidation

google.maps.addressValidation.AddressValidation Klasse

Statische Klasse für den Zugriff auf die Address Validation APIs.

Zugriff durch Anrufen von const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

fetchAddressValidation
fetchAddressValidation(request)
Parameter:
Rückgabewert:Promise<AddressValidation>
Validiert eine Adresse. Weitere Informationen finden Sie unter https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.
address
Typ:Address optional
Informationen zur Adresse selbst im Gegensatz zum Geocode.
geocode
Typ:Geocode optional
Informationen zum Standort und Ort, für die die Adresse geocodiert wurde.
metadata
Typ:AddressMetadata optional
Weitere Informationen, die für die Zustellbarkeit relevant sind. Es gibt keine Garantie dafür, dass metadata für jede an die Address Validation API gesendete Adresse vollständig ausgefüllt ist.
responseId
Typ:string optional
Die UUID, die diese Antwort identifiziert. Wenn die Adresse neu validiert werden muss, muss diese UUID der neuen Anfrage beigefügt werden.
uspsData
Typ:USPSData optional
Zusätzliche Zustellbarkeits-Flags von USPS. Nur in den Regionen US und PR verfügbar.
verdict
Typ:Verdict optional
Flags für das Gesamtergebnis
toJSON
toJSON()
Parameter:Keine
Rückgabewert:Object
Konvertiert die AddressValidation-Klasse in ein JSON-Objekt mit denselben Attributen.

AddressValidationRequest-Schnittstelle

google.maps.addressValidation.AddressValidationRequest-Schnittstelle

Anfrageschnittstelle für AddressValidation.fetchAddressValidation.

address
Die Adresse wird bestätigt. Nicht formatierte Adressen sollten über PostalAddress.addressLines eingereicht werden.
previousResponseId optional
Typ:string optional
Dieses Feld darf für die erste Anfrage zur Adressvalidierung nicht festgelegt werden. Wenn weitere Anfragen erforderlich sind, um eine einzelne Adresse vollständig zu bestätigen (z. B. wenn die Änderungen, die der Nutzer nach der ersten Bestätigung vornimmt, noch einmal bestätigt werden müssen), muss in jeder Folgeanfrage das Feld mit dem AddressValidation.responseId aus der allerersten Antwort in der Bestätigungssequenz ausgefüllt werden.
uspsCASSEnabled optional
Typ:boolean optional
Aktiviert den USPS CASS-kompatiblen Modus. Dies betrifft nur das Feld AddressValidation.uspsData von AddressValidation. Hinweis: Bei USPS CASS-fähigen Anfragen für Adressen in Puerto Rico muss eine PostalAddress.regionCode der address als „PR“ oder eine PostalAddress.administrativeArea der address als „Puerto Rico“ (Groß-/Kleinschreibung wird nicht beachtet) oder „PR“ angegeben werden.

Klasse Address

google.maps.addressValidation.Address Klasse

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

Zugriff durch Anrufen von const {Address} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

components
Die einzelnen Adresskomponenten der formatierten und korrigierten Adresse sowie Validierungsinformationen. Hier finden Sie Informationen zum Validierungsstatus der einzelnen Komponenten.
formattedAddress
Typ:string optional
Die nachbearbeitete Adresse, formatiert als einzeilige Adresse gemäß den Adressformatierungsregeln der Region, in der sich die Adresse befindet.
missingComponentTypes
Typ:Array<string>
Die Arten von Komponenten, die in einer korrekt formatierten Postanschrift vorhanden sein sollten, aber nicht in der Eingabe gefunden wurden UND nicht abgeleitet werden konnten. Komponenten dieses Typs sind in formatted_address, postal_address oder address_components 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.
postalAddress
Typ:PostalAddress optional
Die nachbearbeitete Adresse als Postadresse.
unconfirmedComponentTypes
Typ:Array<string>
Die Typen der Komponenten, die in address_components vorhanden sind, deren Richtigkeit aber nicht bestätigt werden konnte. Dieses Feld dient der Übersichtlichkeit: Sein Inhalt entspricht dem Durchlaufen von address_components, um die Typen aller Komponenten zu finden, bei denen AddressComponent.confirmationLevel nicht ConfirmationLevel.CONFIRMED ist oder das AddressComponent.inferred-Flag nicht auf true gesetzt ist. Eine Liste der möglichen Typen finden Sie hier.
unresolvedTokens
Typ:Array<string>
Alle Tokens in der Eingabe, die nicht aufgelöst werden konnten. Das kann an einer Eingabe liegen, die nicht als gültiger Teil einer Adresse erkannt wurde. In der Eingabe „123235253253 Main St, San Francisco, CA, 94105“ könnten die nicht aufgelösten Tokens beispielsweise so aussehen: ["123235253253"], da dies keine gültige Hausnummer ist.

Klasse AddressComponent

google.maps.addressValidation.AddressComponent Klasse

Stellt eine einzelne Komponente einer Adresse dar, z. B. Straßenname oder Stadt.

Zugriff durch Anrufen von const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

componentName
Typ:string optional
Der Text des Komponentennamens. Beispiel: „5th Avenue“ für einen Straßennamen oder „1253“ für eine Hausnummer.
componentNameLanguageCode
Typ:string optional
Der BCP-47-Sprachcode. Diese ist nicht vorhanden, wenn der Komponentenname nicht mit einer Sprache verknüpft ist, z. B. bei einer Hausnummer.
componentType
Typ:string optional
Der Typ der Adresskomponente. Eine Liste der möglichen Typen finden Sie unter Tabelle 2: Zusätzliche vom „Places“-Dienst zurückgegebene Typen.
confirmationLevel
Typ:ConfirmationLevel optional
Gibt an, wie sicher es ist, dass die Komponente korrekt ist.
inferred
Typ:boolean
Wenn „true“, war diese Komponente nicht Teil der Eingabe, wurde aber für den Adressstandort abgeleitet. Diese Komponente wird für eine vollständige Adresse empfohlen.
replaced
Typ:boolean
Gibt an, dass der Name der Komponente durch einen völlig anderen Namen ersetzt wurde. Beispiel: Eine falsche Postleitzahl wird durch die richtige Postleitzahl für die Adresse ersetzt. Es handelt sich nicht um eine kosmetische Änderung. Die Eingabekomponente wurde durch eine andere ersetzt.
spellCorrected
Typ:boolean
Gibt eine Korrektur eines Rechtschreibfehlers im Komponentennamen an. Die API kennzeichnet nicht immer Änderungen von einer Schreibweise zur anderen, z. B. von „centre“ zu „center“.
unexpected
Typ:boolean
Wenn „true“, wird erwartet, dass diese Komponente in einer Postanschrift für die angegebene Region nicht vorhanden ist. Sie wurde nur beibehalten, weil sie Teil der Eingabe war.

AddressMetadata-Klasse

google.maps.addressValidation.AddressMetadata Klasse

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

Zugriff durch Anrufen von const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

business
Typ:boolean
poBox
Typ:boolean
residential
Typ:boolean

ConfirmationLevel-Konstanten

google.maps.addressValidation.ConfirmationLevel Konstanten

Die verschiedenen möglichen Werte, die den Grad der Gewissheit angeben, dass die Komponente korrekt ist.

Zugriff durch Anrufen von const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Geocode-Klasse

google.maps.addressValidation.Geocode Klasse

Enthält Informationen zum Ort, an dem die Eingabe geocodiert wurde.

Zugriff durch Anrufen von const {Geocode} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

bounds
Typ:LatLngBounds optional
Die Grenzen des Orts mit Geocoding.
featureSizeMeters
Typ:number optional
Die Größe des Orts mit Geocoding in Metern. Dies ist ein weiteres Maß für die Unschärfe des geocodierten Standorts, aber in Bezug auf die physische Größe und nicht auf die semantische Bedeutung.
location
Typ:LatLngAltitude optional
Der Standort der Eingabe mit Geocoding.
placeId
Typ:string optional
Die Orts-ID des Orts mit Geocoding. Die Verwendung von „Ort“ wird gegenüber Adressen, Breiten-/Längengradkoordinaten oder Plus Codes bevorzugt. Wenn Sie Koordinaten für die Routenplanung oder die Berechnung von Wegbeschreibungen verwenden, wird der Punkt immer an die Straße angehängt, die diesen Koordinaten am nächsten ist. Diese Straße führt möglicherweise nicht schnell oder sicher zum Ziel und befindet sich möglicherweise nicht in der Nähe eines Zugangspunkts zum Grundstück. Außerdem gibt es beim Reverse-Geocoding eines Standorts keine Garantie dafür, dass die zurückgegebene Adresse mit der ursprünglichen übereinstimmt.
placeTypes
Typ:Array<string>
Der Typ bzw. die Typen des Orts, für den die Eingabe geocodiert wurde. Beispiel: ['locality', 'political']. Eine vollständige Liste der Typen finden Sie in der Dokumentation zur Geocoding API.
plusCode
Typ:PlusCode optional
Der Plus Code, der location entspricht.
fetchPlace
fetchPlace()
Parameter:Keine
Rückgabewert:Keiner
Gibt eine Ortsdarstellung dieses Geocodes zurück. Um vollständige Ortsdetails zu erhalten, muss ein Aufruf von place.fetchFields() erfolgen.

Konstanten für den Detaillierungsgrad

google.maps.addressValidation.Granularity Konstanten

Die verschiedenen Granularitäten, die eine Adresse oder ein Geocode haben kann. Wenn diese Werte verwendet werden, um die Granularität für eine Adresse anzugeben, geben sie an, mit welcher Granularität die Adresse ein Versandziel identifiziert. Eine Adresse wie „123 Main Street, Redwood City, CA, 94061“ identifiziert beispielsweise eine PREMISE, während „Redwood City, CA, 94061“ eine LOCALITY identifiziert. Wenn wir jedoch keinen Geocode für „123 Main Street“ in Redwood City finden, ist der zurückgegebene Geocode möglicherweise auf der LOCALITY-Ebene, obwohl die Adresse genauer ist.

Zugriff durch Anrufen von const {Granularity} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

BLOCK Die Adresse oder der Geocode gibt einen Block an. Wird nur in Regionen mit Adressierung auf Blockebene verwendet, z. B. in Japan.
OTHER Alle anderen Granularitäten, die zusammengefasst werden, da sie nicht lieferbar sind.
PREMISE Ergebnis auf Gebäudeebene.
PREMISE_PROXIMITY Ein Geocode, der den Standort der Adresse auf Gebäudeebene annähert.
ROUTE Der Geocode oder die Adresse ist auf Routenebene granular, z. B. für eine Straße oder Autobahn.
SUB_PREMISE Ergebnis unterhalb der Gebäudeebene, z. B. für eine Wohnung.

PossibleNextAction-Konstanten

google.maps.addressValidation.PossibleNextAction Konstanten

Bietet eine interpretative Zusammenfassung der API-Antwort, die bei der Entscheidung über eine mögliche Folgemaßnahme helfen soll. Dieses Feld wird aus anderen Feldern in der API-Antwort abgeleitet und sollte nicht als Garantie für die Richtigkeit oder Zustellbarkeit der Adresse angesehen werden.

Zugriff durch Anrufen von const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

ACCEPT Die API-Antwort enthält keine Signale, die einen der anderen PossibleNextAction-Werte rechtfertigen. Sie können die nachbearbeitete Adresse verwenden, ohne den Kunden noch einmal zu fragen. Das garantiert jedoch nicht, dass die Adresse gültig ist. Sie kann weiterhin Korrekturen enthalten. Es liegt in Ihrer Verantwortung, zu entscheiden, ob und wie Sie Ihren Kunden auffordern, die Zahlungsmethode zu aktualisieren.
CONFIRM Ein oder mehrere Felder der API-Antwort weisen auf potenzielle kleinere Probleme mit der nachbearbeiteten Adresse hin, z. B. war die Adresskomponente postal_code replaced. Wenn Sie Ihren Kunden auffordern, die Adresse zu überprüfen, kann dies die Qualität der Adresse verbessern.
CONFIRM_ADD_SUBPREMISES Die API-Antwort gibt an, dass in der nachbearbeiteten Adresse möglicherweise eine Untereinheit fehlt. Wenn Sie Ihren Kunden auffordern, die Adresse zu überprüfen und eventuell eine Einheitsnummer hinzuzufügen, kann die Qualität der Adresse verbessert werden. Die nachbearbeitete Adresse kann auch andere kleinere Probleme aufweisen. Hinweis: Dieser Enum-Wert kann nur für US-Adressen zurückgegeben werden.
FIX Ein oder mehrere Felder der API-Antwort weisen auf ein potenzielles Problem mit der nachbearbeiteten Adresse hin, z. B. ist verdict.validation_granularity gleich OTHER. Wenn Sie Ihren Kunden auffordern, die Adresse zu bearbeiten, kann dies die Qualität der Adresse verbessern.

Klasse USPSAddress

google.maps.addressValidation.USPSAddress Klasse

USPS-Darstellung einer US-Adresse

Zugriff durch Anrufen von const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

city
Typ:string optional
Der Name der Stadt.
cityStateZipAddressLine
Typ:string optional
Die Adresszeile mit dem Ort, dem Bundesstaat und der Postleitzahl.
firm
Typ:string optional
Der Name des Unternehmens.
firstAddressLine
Typ:string optional
Die erste Zeile der Adresse.
secondAddressLine
Typ:string optional
Die zweite Zeile der Adresse.
state
Typ:string optional
Der zweistellige Bundesland-/Staats-Code.
urbanization
Typ:string optional
Der Name der Urbanisation in Puerto Rico.
zipCode
Typ:string optional
Die Postleitzahl, z. B. „10009“
zipCodeExtension
Typ:string optional
Die 4-stellige Postleitzahlerweiterung, z. B. „5023“

USPSData-Klasse

google.maps.addressValidation.USPSData Klasse

Die USPS-Daten für die Adresse. USPSData ist nicht garantiert für jede US- oder PR-Adresse, die an die Address Validation API gesendet wird, vollständig ausgefüllt. Es wird empfohlen, die Felder für die Sicherungsadresse in die Antwort zu integrieren, wenn Sie „uspsData“ als primären Teil der Antwort verwenden.

Zugriff durch Anrufen von const {USPSData} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

abbreviatedCity
Typ:string optional
Abgekürzte Stadt.
addressRecordType
Typ:string optional
Typ des Adressdatensatzes, der der eingegebenen Adresse entspricht.
carrierRoute
Typ:string optional
Der Code der Zustellroute. Ein vierstelliges Kürzel, das aus einem Buchstaben als Präfix und einer dreistelligen Routenbezeichnung besteht.
carrierRouteIndicator
Typ:string optional
Sortierindikator für die Versandart des Transportunternehmens.
cassProcessed
Typ:boolean
Gibt an, dass die Anfrage von CASS verarbeitet wurde.
county
Typ:string optional
Name des Countys.
deliveryPointCheckDigit
Typ:string optional
Die Prüfziffer für den Zustellpunkt. Diese Nummer wird am Ende des delivery_point_barcode für maschinell gescannte Post hinzugefügt. Wenn Sie alle Ziffern von delivery_point_barcode, delivery_point_check_digit, postal_code und ZIP+4 addieren, sollte das Ergebnis eine durch 10 teilbare Zahl sein.
deliveryPointCode
Typ:string optional
Der zweistellige Code der Zustelladresse.
dpvCMRA
Typ:string optional
Gibt an, ob es sich bei der Adresse um eine CMRA (Commercial Mail Receiving Agency) handelt, also ein privates Unternehmen, das Post für Kunden entgegennimmt. Gibt ein einzelnes Zeichen zurück.
dpvConfirmation
Typ:string optional
Die möglichen Werte für die Bestätigung des DPV. Gibt ein einzelnes Zeichen zurück oder keinen Wert.
dpvDoorNotAccessible
Typ:string optional
Gibt Adressen an, an denen die USPS nicht an eine Tür klopfen kann, um Post zuzustellen. Gibt ein einzelnes Zeichen zurück.
dpvDrop
Typ:string optional
Das Flag gibt an, dass die E-Mail an einen einzelnen Behälter an einem Standort zugestellt wird. Gibt ein einzelnes Zeichen zurück.
dpvEnhancedDeliveryCode
Typ:string optional
Gibt an, dass mehr als ein DPV-Rückgabecode für die Adresse gültig ist. Gibt ein einzelnes Zeichen zurück.
dpvFootnote
Typ:string optional
Die Fußnoten aus der Validierung des Zustellpunkts. Mehrere Fußnoten können im selben String aneinandergereiht werden.
dpvNonDeliveryDays
Typ:string optional
Gibt an, dass die E-Mail-Zustellung nicht an jedem Wochentag erfolgt. Gibt ein einzelnes Zeichen zurück.
dpvNonDeliveryDaysValues
Typ:number optional
Ganzzahl zur Identifizierung von Tagen, an denen keine Auslieferung erfolgt. Sie kann mit Bit-Flags abgefragt werden: 0x40 – Sonntag ist kein Liefertag 0x20 – Montag ist kein Liefertag 0x10 – Dienstag ist kein Liefertag 0x08 – Mittwoch ist kein Liefertag 0x04 – Donnerstag ist kein Liefertag 0x02 – Freitag ist kein Liefertag 0x01 – Samstag ist kein Liefertag
dpvNoSecureLocation
Typ:string optional
Das Flag gibt an, dass die Tür zugänglich ist, das Paket aber aus Sicherheitsgründen nicht hinterlassen wird. Gibt ein einzelnes Zeichen zurück.
dpvNoStat
Typ:string optional
Gibt an, ob es sich bei der Adresse um eine Adresse ohne Statistiken oder eine aktive Adresse handelt. „No stat“-Adressen sind Adressen, die nicht dauerhaft bewohnt sind oder die vom USPS nicht bedient werden. Gibt ein einzelnes Zeichen zurück.
dpvNoStatReasonCode
Typ:number optional
Gibt den NoStat-Typ an. Gibt einen Ursachencode als Ganzzahl zurück.
dpvPBSA
Typ:string optional
Gibt an, dass die Adresse mit einem PBSA-Datensatz abgeglichen wurde. Gibt ein einzelnes Zeichen zurück.
dpvThrowback
Typ:string optional
Gibt an, dass die E‑Mail nicht an die Straßenadresse zugestellt wird. Gibt ein einzelnes Zeichen zurück.
dpvVacant
Typ:string optional
Gibt an, ob die Adresse frei ist. Gibt ein einzelnes Zeichen zurück.
elotFlag
Typ:string optional
eLOT-Flag aufsteigend/absteigend (A/D).
elotNumber
Typ:string optional
Nummer der erweiterten Fahrtlinie (Enhanced Line of Travel, eLOT).
errorMessage
Typ:string optional
Fehlermeldung für den USPS-Datenabruf. Dieses Feld wird ausgefüllt, wenn die Verarbeitung durch USPS aufgrund der Erkennung künstlich erstellter Adressen ausgesetzt wird.
fipsCountyCode
Typ:string optional
FIPS-Countycode.
hasDefaultAddress
Typ:boolean
Gibt an, dass eine Standardadresse gefunden wurde, aber spezifischere Adressen vorhanden sind.
hasNoEWSMatch
Typ:boolean
Die Lieferadresse ist abgleichbar, aber die EWS-Datei gibt an, dass in Kürze eine genaue Übereinstimmung verfügbar sein wird.
lacsLinkIndicator
Typ:string optional
LACSLink-Anzeige
lacsLinkReturnCode
Typ:string optional
LACSLink-Rückgabecode.
pmbDesignator
Typ:string optional
PMB (Private Mail Box) unit designator.
pmbNumber
Typ:string optional
PMB-Nummer (Private Mail Box).
poBoxOnlyPostalCode
Typ:boolean
Postleitzahl nur für Postfach.
postOfficeCity
Typ:string optional
Hauptpostamt der Stadt.
postOfficeState
Typ:string optional
Status des Hauptpostamts.
standardizedAddress
Typ:USPSAddress optional
Standardisierte USPS-Adresse.
suiteLinkFootnote
Typ:string optional
Fußnoten, die durch den Abgleich eines Straßen- oder Hochhausdatensatzes mit Informationen zu Wohneinheiten entstehen. Wenn eine Übereinstimmung mit dem Unternehmensnamen gefunden wird, wird die sekundäre Nummer zurückgegeben.

Klasse Verdict

google.maps.addressValidation.Verdict Klasse

Stellt die nachbearbeitete Adresse für die angegebene Adresse dar.

Zugriff durch Anrufen von const {Verdict} = await google.maps.importLibrary("addressValidation").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

addressComplete
Typ:boolean
Die Adresse gilt als vollständig, wenn keine unaufgelösten Tokens und keine unerwarteten oder fehlenden Adresskomponenten vorhanden sind. Wenn nicht festgelegt, gibt dies an, dass der Wert false ist. Weitere Informationen finden Sie in den Feldern Address.missingComponentTypes, Address.unresolvedTokens oder AddressComponent.unexpected.
geocodeGranularity
Typ:Granularity optional
Informationen zum Detaillierungsgrad von Geocode. Das kann als semantische Bedeutung dafür verstanden werden, wie grob oder fein der geocodierte Standort ist.
hasInferredComponents
Typ:boolean
Mindestens eine Adresskomponente wurde abgeleitet (d. h. hinzugefügt), die nicht in der Eingabe enthalten war. Weitere Informationen finden Sie unter AddressComponent.
hasReplacedComponents
Typ:boolean optional
Mindestens eine Adresskomponente wurde ersetzt. Weitere Informationen finden Sie unter AddressComponent.
hasUnconfirmedComponents
Typ:boolean
Mindestens eine Adresskomponente kann nicht kategorisiert oder validiert werden. Weitere Informationen finden Sie unter AddressComponent.
inputGranularity
Typ:Granularity optional
Der Detaillierungsgrad der Eingabe-Adresse. Dies ist das Ergebnis der Analyse der eingegebenen Adresse und liefert keine Validierungssignale. Informationen zu Validierungssignalen finden Sie unter validationGranularity.
possibleNextAction
Typ:PossibleNextAction optional
Eine mögliche nächste Aktion, die auf Grundlage anderer Felder in der API-Antwort ausgeführt werden kann. Weitere Informationen findest du unter PossibleNextAction.
validationGranularity
Typ:Granularity optional
Die Granularitätsebene, bis zu der die API die Adresse vollständig validieren kann. Ein validationGranularity von PREMISE gibt beispielsweise an, dass alle Adresskomponenten auf der Ebene von PREMISE und höher validiert werden können.