Method: validateAddress

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

integer

Wersja schematu obiektu PostalAddress. Każda wartość inna niż 0 spowoduje zwrócenie przez interfejs API błędu INVALID_ARGUMENT.

string

Opcjonalnie. Kod regionu CLDR kraju lub regionu adresu. Szczegółowe informacje znajdziesz na stronach https://cldr.unicode.org/ i https://www.unicode.org/cldr/charts/30/extra/territory_information.html. Przykład: „CH” w przypadku Szwajcarii. Jeśli nie podasz kodu regionu, zostanie on wywnioskowany na podstawie adresu. Aby uzyskać najlepszą wydajność, zalecamy dołączenie kodu regionu, jeśli go znasz. Niespójne lub powtarzające się regiony mogą obniżać wydajność, na przykład jeśli addressLines zawiera już region, nie podawaj ponownie kodu regionu w tym polu. Listę obsługiwanych regionów znajdziesz w odpowiedziach na najczęstsze pytania.

string

Kod języka w adresie wejściowym jest zarezerwowany do wykorzystania w przyszłości i dziś jest ignorowany. Interfejs API zwraca adres w języku odpowiednim dla lokalizacji, w której się on znajduje.

string

Opcjonalnie. Kod pocztowy adresu. Nie we wszystkich krajach używa się kodów pocztowych lub tego nie wymaga, ale tam, gdzie są one używane, mogą wymagać dodatkowej weryfikacji w innych częściach adresu (np. weryfikacji stanu/poczty w USA).

string

Opcjonalnie. Dodatkowy kod sortowniczy dla danego kraju. Nie jest ono używane w większości regionów. Ta wartość jest ciągiem znaków typu „CEDEX”, po którym opcjonalnie może występować liczba (np. „CEDEX 7”), lub sama liczba reprezentująca „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (Malawi) lub „wskaźnik urzędu pocztowego” (np. Wybrzeże Kości Słoniowej).

string

Opcjonalnie. Najwyższy podział administracyjny używany w adresach pocztowych kraju lub regionu. Może to być na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie wspólnota autonomiczna (np. „Barcelona”, a nie „Katalonia”). W wielu krajach w adresach pocztowych nie ma obszaru administracyjnego. Na przykład w Szwajcarii to pole powinno pozostać puste.

string

Opcjonalnie. Zwykle odnosi się do miasta/miasteczka w adresie. Przykłady: miasto w Stanach Zjednoczonych, rejon IT, brytyjska poczta. W regionach świata, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, pozostaw pole miejscowości puste i użyj pola addressLines.

string

Opcjonalnie. Dzielnica adresu. Mogą to być np. dzielnice, dystrykty, dystrykty.

string

Wymagany. Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu.

Wartości w polach addressLines nie zawierają informacji o typie i czasami mogą zawierać wiele wartości w pojedynczym polu (np. „Austin, TX”), dlatego kolejność wierszy musi być jasna. Kolejność wierszy adresu powinna być określona jako „zamówienie na koperty” dla kraju/regionu adresu.

Minimalna dozwolona reprezentacja strukturalna adresu obejmuje wszystkie informacje umieszczone w elemencie addressLines. Jeśli pole regionCode nie jest podane, region jest określany na podstawie wierszy adresu.

Utworzenie adresu zawierającego tylko adres addressLines to zalecany sposób obsługi całkowicie nieuporządkowanych adresów (w przeciwieństwie do zgadywania, które części adresu powinny stanowić miejscowości lub obszary administracyjne).

string

Nie ustawiaj tego pola. Interfejs Address Validation API obecnie go nie używa. Mimo że obecnie interfejs API nie będzie odrzucać żądań z tym zestawem pól, informacje zostaną odrzucone i nie będą zwracane w odpowiedzi.

string

Nie ustawiaj tego pola. Interfejs Address Validation API obecnie go nie używa. Mimo że obecnie interfejs API nie będzie odrzucać żądań z tym zestawem pól, informacje zostaną odrzucone i nie będą zwracane w odpowiedzi.

{
  "returnEnglishLatinAddress": boolean
}

boolean

Podgląd: Zwróć google.maps.addressvalidation.v1.Address w języku angielskim. Aby dowiedzieć się więcej, wejdź na google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

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

object (Verdict)

Flagi oceny ogólnej

object (Address)

Informacje o samym adresie, a nie o identyfikatorze geokodu.

object (Geocode)

Informacje o lokalizacji i miejscu, do którego został przekodowany adres.

object (AddressMetadata)

Inne informacje istotne z punktu widzenia dostawy. Nie możemy zagwarantować, że pole metadata będzie w pełni wypełnione dla każdego adresu wysłanego do interfejsu Address Validation API.

object (UspsData)

Dodatkowe oznaczenia dotyczące dostarczenia dostarczone przez USPS. Podana tylko w regionach US i PR.

object (Address)

Wersja testowa: ta funkcja jest w wersji testowej (przed GA). Usługi i funkcje sprzed GA mogą mieć ograniczoną obsługę, a zmiany w tych usługach i funkcjach mogą być niezgodne z ich innymi wersjami. Oferty przed GA są objęte szczegółowymi warunkami korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Adres przetłumaczony na angielski. Jeśli część adresu nie ma tłumaczenia na język angielski, usługa zwraca tę część w innym języku z alfabetem łacińskim. Wyjaśnienie, jak wybierany jest język alternatywny, znajdziesz tutaj. Jeśli część adresu nie ma żadnych tłumaczeń ani transliteracji w języku z alfabetem łacińskim, usługa zwraca tę część w lokalnym języku powiązanym z adresem.

Te dane wyjściowe zostały włączone za pomocą flagi google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Uwaga: pole google.maps.addressvalidation.v1.Address.unconfirmed_component_types w englishLatinAddress i google.maps.addressvalidation.v1.AddressComponent.confirmation_level w englishLatinAddress.address_components nie są wypełnione.

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

enum (Granularity)

Szczegółowość adresu wejściowego. Jest to wynik analizy adresu wejściowego i nie dostarcza żadnych sygnałów weryfikacyjnych. Sygnały weryfikacyjne znajdziesz w sekcji validationGranularity poniżej.

Jeśli np. podany adres zawiera konkretny numer mieszkania, w polu inputGranularity będzie występować wartość SUB_PREMISE. Jeśli nie możemy dopasować numeru mieszkania w bazach danych lub numer mieszkania jest nieprawidłowy, validationGranularity prawdopodobnie wyniesie PREMISE lub mniej.

enum (Granularity)

Poziom szczegółowości, na którym interfejs API może w pełni zweryfikować adres. Na przykład wartość validationGranularity o wartości PREMISE oznacza, że wszystkie komponenty adresu mogą zostać zweryfikowane na poziomie PREMISE lub bardziej przybliżonego.

Wynik weryfikacji składnika adresu można znaleźć w pliku google.maps.addressvalidation.v1.Address.address_components.

enum (Granularity)

Informacje o szczegółowości geocode. Jest to semantyczne określenie dokładnej i dokładnej lokalizacji geograficznej.

Czasami wartość ta może różnić się od wartości podanych wyżej (validationGranularity). Na przykład nasza baza danych może rejestrować istnienie numeru mieszkania, ale nie może zawierać dokładnej lokalizacji tego mieszkania w dużym kompleksie mieszkalnym. W takim przypadku wartość validationGranularity wyniesie SUB_PREMISE, a geocodeGranularity wyniesie PREMISE.

boolean

Adres jest uznawany za ukończony, jeśli nie ma nierozstrzygniętych tokenów ani nieoczekiwanych lub brakujących elementów adresu. Więcej informacji znajdziesz w polach missingComponentTypes, unresolvedTokens i unexpected.

boolean

Co najmniej 1 komponentu adresu nie można skategoryzować ani zweryfikować. Więcej informacji znajdziesz na stronie google.maps.addressvalidation.v1.Address.address_components.

boolean

Co najmniej 1 komponent adresu został wywnioskowany (dodany), którego nie ma w danych wejściowych. Więcej informacji znajdziesz na stronie google.maps.addressvalidation.v1.Address.address_components.

boolean

Zastąpiono co najmniej 1 komponent adresu. Szczegóły znajdziesz na stronie google.maps.addressvalidation.v1.Address.address_components.

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

string

Po przetworzeniu adres, sformatowany jako adres jednowierszowy zgodnie z regułami formatowania adresu obowiązującymi w regionie, w którym znajduje się adres.

object (PostalAddress)

Adres pocztowy podany po zakończeniu przetwarzania.

object (AddressComponent)

Lista nieuporządkowana. Poszczególne składniki adresu sformatowanego i poprawionego adresu wraz z informacjami umożliwiającymi weryfikację. Znajdziesz tam informacje o stanie weryfikacji poszczególnych komponentów.

Komponenty adresu nie są uporządkowane w określony sposób. Nie zakładaj żadnych założeń dotyczących kolejności komponentów adresu na liście.

string

Typy komponentów, które powinny znajdować się w poprawnie sformatowanym adresie pocztowym, ale nie zostały znalezione w danych wejściowych ORAZ nie można wywnioskować. Komponenty tego typu nie występują w atrybutach formattedAddress, postalAddress i addressComponents. W przypadku danych typu ['street_number', 'route'] np. „Boulder, Kolorado, 80301, USA”. Listę możliwych typów znajdziesz tutaj.

string

Typy komponentów, które występują w pliku addressComponents, ale nie udało się potwierdzić ich poprawności. To pole jest podane dla wygody: jego zawartość odpowiada powtórzeniu operacji addressComponents w celu znalezienia typów wszystkich komponentów, w których wartość confirmationLevel nie jest wartością CONFIRMED lub flaga inferred nie jest ustawiona na true. Listę możliwych typów znajdziesz tutaj.

string

Wszelkie wpisane dane wejściowe, których nie udało się rozwiązać. To może być wartość, która nie została rozpoznana jako poprawna część adresu (np. w przypadku takich danych jak „ul. Główna 123235253253, San Francisco, CA 94105”, nierozstrzygnięte tokeny mogą wyglądać jak ["123235253253"], ponieważ nie wyglądają na prawidłowy numer domu).

{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}

object (ComponentName)

Nazwa tego komponentu.

string

Typ komponentu adresu. Listę możliwych typów znajdziesz w tabeli 2. Dodatkowe typy zwracane przez usługę Miejsca.

enum (ConfirmationLevel)

Wskazuje poziom pewności, że komponent jest prawidłowy.

boolean

Wskazuje, że komponent nie był częścią danych wejściowych, ale wywnioskowaliśmy go dla lokalizacji adresu i uważamy, że należy go podać, aby uzyskać pełny adres.

boolean

Wskazuje poprawkę błędu pisowni w nazwie komponentu. Interfejs API nie zawsze oznacza zmiany pisowni między wariantami, np. „wyśrodkuj” na „wyśrodkowany”. Nie zawsze jest też wykrywane typowe błędy pisowni, na przykład gdy zmieniasz nazwę „Pałac Kultury i Nauki” na „Pałac Kultury i Nauki”.

boolean

Wskazuje nazwę komponentu, która została zastąpiona zupełnie inną. Może na przykład być zastąpiony nieprawidłowym kodem pocztowym odpowiadającym danemu adresowi. Nie jest to zmiana kosmetyczna. Komponent wejściowy został zmieniony na inny.

boolean

Wskazuje komponent adresu, który nie powinien znajdować się w adresie pocztowym dla danego regionu. Zachowaj go tylko dlatego, że był częścią naszych danych.

{
  "text": string,
  "languageCode": string
}

string

Tekst nazwy. Na przykład „Piąta Aleja” dla nazwy ulicy lub „1253” dla numeru budynku.

string

Kod języka BCP-47. Ten atrybut nie będzie widoczny, jeśli nazwa komponentu nie jest powiązana z językiem, np. z numerem domu.

{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}

object (LatLng)

Przekodowana geograficznie lokalizacja danych wejściowych.

Korzystanie z identyfikatorów miejsc jest preferowane zamiast używania adresów, współrzędnych szerokości i długości geograficznej lub kodów plus. Używanie współrzędnych do wyznaczanie trasy dojazdu lub obliczanie trasy dojazdu zawsze powoduje przyciągnięcie punktu do drogi znajdującej się najbliżej tych współrzędnych. Nie może to być droga, która szybko lub bezpiecznie prowadzi do miejsca docelowego i może nie znajdować się w pobliżu punktu dostępu do nieruchomości. Dodatkowo, jeśli lokalizacja zostanie kodowana wstecznie, nie ma gwarancji, że zwrócony adres jest zgodny z oryginałem.

object (PlusCode)

Kod plus odpowiadający karcie location.

object (Viewport)

Granice geokodowanego miejsca.

number

Rozmiar miejsca geokodowanego w metrach. Jest to kolejna miara przybliżenia lokalizacji geograficznej, lecz jej rozmiaru fizycznego, a nie semantycznego.

string

Identyfikator PlaceID miejsca, do którego dane geokodowane są przetwarzane.

Więcej informacji o identyfikatorach miejsc znajdziesz tutaj.

string

Typy miejsc, do których dane wejściowe zostały przetworzone geograficznie. Na przykład: ['locality', 'political']. Pełną listę typów znajdziesz tutaj.

{
  "latitude": number,
  "longitude": number
}

number

Szerokość geograficzna w stopniach. Musi mieścić się w zakresie [-90,0, +90,0].

number

Długość geograficzna w stopniach. Musi mieścić się w zakresie [-180,0, +180,0].

{
  "globalCode": string,
  "compoundCode": string
}

string

Globalny (pełny) kod miejsca, np. „9FWM33GV+HQ”, reprezentujący obszar 1/8000 na 1/8000 stopni (ok. 14 x 14 metrów).

string

Kod złożony miejsca, np. „33GV+HQ, Ramberg, Norwegia”, zawierający sufiks kodu globalnego i zastępując prefiks sformatowaną nazwą elementu referencyjnego.

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object (LatLng)

Wymagany. Najniższy punkt widocznego obszaru.

object (LatLng)

Wymagany. Górny punkt widocznego obszaru.

{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}

boolean

Wskazuje, że jest to adres firmy. Jeśli zasada jest nieskonfigurowana, wskazuje, że wartość jest nieznana.

boolean

Wskazuje adres skrytki pocztowej. Jeśli zasada jest nieskonfigurowana, wskazuje, że wartość jest nieznana.

boolean

Wskazuje, że jest to adres zamieszkania. Jeśli zasada jest nieskonfigurowana, wskazuje, że wartość jest nieznana.

{
  "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
}

object (UspsAddress)

Ujednolicony adres USPS.

string

2-cyfrowy kod punktu dostawy

string

Cyfra kontrolna punktu dostawy. Ten numer jest dodawany na końcu kodu kreskowego „delivery_point_barcode” w przypadku skanowania mechanicznego poczty. Dodanie do siebie wszystkich cyfr parametrów delivery_point_barcode, shippingPointCheckDigit, kodu pocztowego i kodu ZIP+4 powinno dać liczbę podzieloną przez 10.

string

Możliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak.

• Y: adres został potwierdzony przez DPV dla podstawowych i dodatkowych numerów.
• N: nie udało się potwierdzić DPV informacji o podstawowym i dodatkowym numerze.
• S: adres został potwierdzony przez DPV tylko dla numeru podstawowego, a dodatkowe informacje o numerze były dostępne, ale nie zostały potwierdzone.
• D: adres został potwierdzony przez DPV tylko dla numeru głównego, ale brakowało informacji o dodatkowym numerze.

string

Przypisy z weryfikacji punktów dostawy. Wiele przypisów może być połączonych w ten sam ciąg.

• AA: adres wejściowy został dopasowany do pliku ZIP+4.
• A1: adres wejściowy nie został dopasowany do pliku ZIP+4
• BB: dopasowane do DPV (wszystkie komponenty)
• CC: nie pasuje numer dodatkowy (obecny, ale nieprawidłowy)
• N1: w adresie w wieżowcu brakuje dodatkowego numeru telefonu
• M1: brak podstawowego numeru
• M3: podstawowy numer jest nieprawidłowy
• P1: brak podanego adresu RR lub numeru pola Centrum pomocy
• P3: wpisany adres PO, RR lub HC Box jest nieprawidłowy
• F1: adres wejściowy został dopasowany do adresu wojskowego
• G1: wpisany adres został dopasowany do ogólnego adresu dostawy
• U1: wpisany adres został dopasowany do unikalnego kodu pocztowego
• PB: adres wejściowy został dopasowany do rekordu PBSA
• RR: potwierdzony adres przez DPV z informacjami PMB
• R1: potwierdzony adres DPV bez informacji PMB
• R7: rekord R777 lub R779 przewoźnika

string

Wskazuje, czy adres firmy należy do agencji CMRA (komercyjnej agencji odbierającej pocztę) – prywatnej firmy, która odbiera pocztę dla klientów. Zwraca pojedynczy znak.

• Y: adres jest w systemie CMRA
• N: adres nie należy do systemu CMRA

string

Czy to miejsce jest puste? Zwraca pojedynczy znak.

• Y: adres jest pusty
• N: adres jest pusty

string

Czy adres jest niedostępny czy aktywny? Żadne adresy statystyczne nie są stale zajęte lub nie są obsługiwane przez USPS. Zwraca pojedynczy znak.

• Y: adres jest nieaktywny
• N: adres jest aktywny

string

Kod trasy przewoźnika. Czteroznakowy kod składający się z 1-literowego prefiksu i 3-cyfrowego oznaczenia trasy.

Prefiksy:

• C: trasa przewoźnika (lub trasa miejska)
• R: trasa wiejska
• H: trasa kontraktu drogowego
• B: Sekcja skrytki pocztowej
• G: ogólna jednostka wyświetlania reklam.

string

Wskaźnik sortowania według stawki przewoźnika.

boolean

Adres dostawy można dopasować, ale plik EWS wskazuje, że wkrótce udostępnimy dopasowanie ścisłe.

string

Główny urząd pocztowy.

string

Główny stan urzędu pocztowego.

string

Skrócone miasto.

string

Kod kraju FIPS.

string

Nazwa hrabstwa.

string

Numer rozszerzonej linii podróży (eLOT).

string

Flaga eLOT rosnąco i malejąco (A/D).

string

Zwrotny kod LACSLink.

string

Wskaźnik LACSLink.

boolean

Kod pocztowy tylko skrytki pocztowej.

string

Przypisy od dopasowywania informacji o ulicy lub wieżowcu do informacji o budynkach. Jeśli nazwa firmy się zgadza, zwracany jest numer dodatkowy.

• A: dopasowanie rekordu SuiteLink, poprawiony adres firmy.
• 00: brak dopasowań, adres firmy nie został poprawiony.

string

Oznaczenie jednostki PMB (Private Mail Box).

string

numer PMB (prywatnej skrzynki pocztowej);

string

Typ rekordu adresu pasujący do wprowadzonego adresu.

• F: FIRMA. Jest to dopasowanie do rejestru firmowego, które stanowi najwłaściwszy poziom dopasowania dla adresu.
• G: DOSTAWA OGÓLNA. Ta wartość odpowiada rekordowi dostawy ogólnej.
• H: BUDOWANIE / Apartament. To dopasowanie do rekordu budynku lub mieszkania.
• P: Skrytka pocztowa. Dopasowanie do skrytki pocztowej.
• R: TRASA WIEDZY lub UMOWA NA DROGU DYSTRYBUTOWYM: to dopasowanie do rekordu Droga lokalna lub Umowa drogowa, dla której mogą być powiązane zakresy numerów pól.
• S: Rekord STREET: dopasowanie do rekordu Street zawierającego prawidłowy podstawowy zakres liczbowy.

boolean

Wskaźnik informujący o znalezieniu adresu domyślnego, ale istnieją bardziej szczegółowe adresy.

string

Komunikat o błędzie pobierania danych USPS. Tę wartość wypełniamy, gdy przetwarzanie USPS zostanie zawieszone z powodu wykrycia sztucznie utworzonych adresów.

Jeśli występuje ten błąd, pola danych USPS mogą nie być wypełnione.

boolean

Wskaźnik informujący o przetworzeniu żądania CASS.

{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}

string

Pierwszy wiersz adresu.

string

Nazwa firmy.

string

Drugi wiersz adresu.

string

Portorykańska nazwa urbanizacji.

string

Miasto + województwo + kod pocztowy.

string

Nazwa miasta.

string

2-literowy kod stanu.

string

Kod pocztowy, np. 10009.

string

4-cyfrowe rozszerzenie kodu pocztowego, np. 5023.