Method: validateAddress

Weryfikuje adres.

Żądanie HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Pola
address

object (PostalAddress)

Wymagane. Trwa weryfikacja adresu. Niesformatowane adresy należy przesyłać za pomocą formularza addressLines.

Łączna długość pól w tych danych nie może przekraczać 280 znaków.

Obsługiwane regiony znajdziesz tutaj.

Wartość languageCode w adresie wejściowym jest zarezerwowana do wykorzystania w przyszłości i dzisiaj jest ignorowana. Wyniki dotyczące zweryfikowanego adresu zostaną zapełnione na podstawie preferowanego języka danego adresu określonego przez system.

Interfejs Address Validation API ignoruje wartości w polach recipients i organization. Wszystkie wartości w tych polach zostaną odrzucone i nie zostaną zwrócone. Nie ustawiaj ich.
previousResponseId

string

W przypadku pierwszego żądania weryfikacji adresu to pole musi być puste. Jeśli do pełnej weryfikacji pojedynczego adresu potrzeba więcej żądań (np. zmiany wprowadzone przez użytkownika po początkowej weryfikacji wymagają ponownej weryfikacji), każde dodatkowe żądanie musi zawierać w tym polu wartość responseId już od pierwszej odpowiedzi w sekwencji weryfikacji.
enableUspsCass

boolean

Włącza tryb zgodności USPS CASS. Dotyczy to tylko pola google.maps.addressvalidation.v1.ValidationResult.usps_data elementu google.maps.addressvalidation.v1.ValidationResult. Uwaga: w przypadku żądań USPS CASS w przypadku adresów w Portoryko pole google.type.PostalAddress.region_code identyfikatora address należy podać jako „PR” lub „google.type.PostalAddress.administrative_area” elementu address należy podać jako „Puerto Rico” (wielkość liter nie ma znaczenia) lub „PR”.

Zalecamy użycie składowego elementu address lub podanie co najmniej 2 elementów google.type.PostalAddress.address_lines, gdzie pierwszy wiersz zawiera numer i nazwę ulicy, a drugi – miasto, województwo i kod pocztowy.
languageOptions

object (LanguageOptions)

Opcjonalnie. Wersja testowa: ta funkcja jest w wersji przedpremierowej (przed GA). Usługi i funkcje przed GA mogą mieć ograniczoną obsługę, a zmiany w takich usługach mogą być niezgodne z ich innymi wersjami. Oferty przed GA podlegają Szczegółowym warunkom korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Włącza interfejs Address Validation API, aby mógł zawierać dodatkowe informacje w odpowiedzi.
sessionToken

string

Opcjonalnie. Ciąg znaków identyfikujący sesję autouzupełniania w celach rozliczeniowych. Musi to być adres URL i nazwa pliku bezpieczny ciąg znaków w formacie base64 o długości maksymalnie 36 znaków ASCII. W przeciwnym razie zwracany jest błąd INVALID_ARGUMENT.

Sesja rozpoczyna się, gdy użytkownik wykona zapytanie autouzupełniania, i kończy się, gdy użytkownik wybierze miejsce i wywoła informacje o miejscu lub weryfikację adresu. Każda sesja może zawierać kilka zapytań autouzupełniania, po których następuje jedno pytanie o informacje o miejscu lub weryfikację adresu. Dane logowania używane w każdym żądaniu w sesji muszą należeć do tego samego projektu w konsoli Google Cloud. Po zakończeniu sesji token straci ważność – aplikacja musi wygenerować nowy token dla każdej sesji. Jeśli parametr sessionToken zostanie pominięty lub użyjesz tokena sesji ponownie, sesja jest obciążana tak, jakby żaden token sesji nie został udostępniony (każde żądanie jest rozliczane oddzielnie).

Uwaga: weryfikacji adresów można używać tylko w sesjach z nowym interfejsem API autouzupełniania, a nie z interfejsem API autouzupełniania. Więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/session-pricing.

Treść odpowiedzi

Odpowiedź na żądanie weryfikacji adresu.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Pola
result

object (ValidationResult)

Wynik weryfikacji adresu.
responseId

string

Identyfikator UUID identyfikujący tę odpowiedź. Jeśli adres wymaga ponownej weryfikacji, identyfikator UUID musi zostać dołączony do nowego żądania.

PostalAddress

Reprezentuje adres pocztowy, np. adres pocztowy lub adres do płatności. Jeśli podasz adres pocztowy, firma pocztowa może dostarczyć przesyłki do lokalu, skrytki pocztowej lub podobnego obiektu. Nie służy on do modelowania lokalizacji geograficznych (dróg, miast, gór).

W większości przypadków adres jest tworzony na podstawie danych wejściowych użytkownika lub importowanych istniejących danych, w zależności od typu procesu.

Porady dotyczące wpisywania / edytowania adresu: – skorzystaj z widżetu z adresem gotowego do internacjonalizacji, np. https://github.com/google/libaddressinput – nie należy wyświetlać użytkownikom elementów interfejsu do wprowadzania lub edytowania pól spoza krajów, w których takie pole jest używane.

Więcej wskazówek dotyczących korzystania z tego schematu znajdziesz na stronie https://support.google.com/business/answer/6397478

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

integer

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

string

Opcjonalnie. Kod regionu CLDR kraju lub regionu adresu. Szczegółowe informacje można znaleźć na stronach https://cldr.unicode.org/ i https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH” oznacza Szwajcarię. Jeśli kod regionu nie zostanie podany, zostanie on ustalony na podstawie adresu. Aby uzyskać najlepszą skuteczność, zalecamy dodanie kodu regionu, jeśli go znasz. Niespójne lub powtarzające się regiony mogą prowadzić do obniżenia skuteczności, np. jeśli addressLines zawiera już region, nie podawaj ponownie kodu regionu w tym polu. Listę obsługiwanych regionów znajdziesz w najczęstszych pytaniach.
languageCode

string

Kod języka w adresie wejściowym jest zarezerwowany do wykorzystania w przyszłości i jest dziś ignorowany. Interfejs API zwraca adres w języku, który odpowiada jego lokalizacji.
postalCode

string

Opcjonalnie. Kod pocztowy adresu. Nie wszystkie kraje używają kodów pocztowych lub ich wymagają, ale tam, gdzie są używane, mogą wymagać dodatkowej weryfikacji obejmującej inne części adresu (np. stan/kod pocztowy w Stanach Zjednoczonych).
sortingCode

string

Opcjonalnie. Dodatkowy kod sortowniczy specyficzny dla kraju. Nie jest on używany w większości regionów. Ta wartość jest ciągiem znaków takim jak „CEDEX”, po którym może następować cyfra (np. „CEDEX 7”), lub samą liczbą oznaczającą „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (Malawi) lub „wskaźnik urzędu pocztowego” (np. Wybrzeże Kości Słoniowej).
administrativeArea

string

Opcjonalnie. Najwyższy podział administracyjny stosowany w przypadku adresów pocztowych kraju lub regionu. Na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie wspólnota autonomiczna (np. „Barcelona”, nie „Katalonia”). Wiele krajów nie używa regionu w adresach pocztowych. Np. w Szwajcarii pole powinno pozostać puste.
locality

string

Opcjonalnie. Zasadniczo odnosi się do części miejscowości lub miejscowości. Przykłady: USA, gmina IT, poczta polska. W regionach, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, pozostaw pole Rejon puste, a następnie użyj addressLines.
sublocality

string

Opcjonalnie. Okręg, w którym znajduje się adres. Na przykład mogą to być dzielnice, dystrykty, okręgi.
addressLines[]

string

Wymagane. Nieuporządkowane wiersze adresu opisujące dolne poziomy adresu.

Wartości w polu addressLines nie zawierają informacji o typie, a czasami w jednym polu mogą znajdować się wiele wartości (np. „Austin, TX”), dlatego ważne jest, aby kolejność wierszy była jasna. Kolejność wierszy adresu powinna być taka sama jak „kolejność w danych koperty” dla kraju lub regionu adresu.

Minimalna dozwolona reprezentacja strukturalna adresu składa się ze wszystkich informacji umieszczonych w polu addressLines. Jeśli regionCode nie zostanie podany, region jest ustalany na podstawie wierszy adresu.

Utworzenie adresu zawierającego tylko ciąg addressLines, a następnie geokodowanie jest zalecanym sposobem obsługi adresów całkowicie nieuporządkowanych (zamiast zgadywania, które części adresu powinny należeć do miejscowości lub obszaru administracyjnego).
recipients[]

string

Unikaj ustawiania tego pola. Interfejs API do weryfikacji adresu obecnie go nie używa. Chociaż obecnie interfejs API nie odrzuca żądań z tym ustawieniem pola, informacje zostaną odrzucone i nie będą zwracane w odpowiedzi.
organization

string

Unikaj ustawiania tego pola. Interfejs API do weryfikacji adresu obecnie go nie używa. Chociaż obecnie interfejs API nie odrzuca żądań z tym ustawieniem pola, informacje zostaną odrzucone i nie będą zwracane w odpowiedzi.

LanguageOptions

Wersja testowa: ta funkcja jest w wersji przedpremierowej (przed GA). Usługi i funkcje przed GA mogą mieć ograniczoną obsługę, a zmiany w takich usługach mogą być niezgodne z ich innymi wersjami. Oferty przed GA podlegają Szczegółowym warunkom korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Włącza interfejs Address Validation API, aby mógł zawierać dodatkowe informacje w odpowiedzi.

Zapis JSON 
{
  "returnEnglishLatinAddress": boolean
}
Pola
returnEnglishLatinAddress

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.

ValidationResult

Wynik weryfikacji adresu.

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

object (Verdict)

Flagi ogólnej oceny
address

object (Address)

Informacje o samym adresie, a nie o kodzie geograficznym.
geocode

object (Geocode)

Informacje o lokalizacji i miejscu, do którego przekodowano dane geograficzne.
metadata

object (AddressMetadata)

Inne informacje istotne z punktu widzenia dostawy. Nie ma gwarancji, że w przypadku każdego adresu wysłanego do interfejsu Address Validation API pole metadata będzie wypełnione w pełni.
uspsData

object (UspsData)

Dodatkowe flagi dostawy dostarczane przez USPS. Jest dostępna tylko w regionach US i PR.
englishLatinAddress

object (Address)

Wersja testowa: ta funkcja jest w wersji przedpremierowej (przed GA). Usługi i funkcje przed GA mogą mieć ograniczoną obsługę, a zmiany w takich usługach mogą być niezgodne z ich innymi wersjami. Oferty przed GA podlegają Szczegółowym warunkom korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Adres przetłumaczony na język angielski.

Przetłumaczonych adresów nie można używać ponownie jako danych wejściowych interfejsu API. Dzięki tej usłudze użytkownik może w swoim języku potwierdzić lub odrzucić poprawność pierwotnie podanego adresu.

Jeśli część adresu nie ma tłumaczenia na język angielski, usługa zwróci tę część w języku alternatywnym używającym alfabetu łacińskiego. Wyjaśnienie wyboru języka alternatywnego znajdziesz tutaj. Jeśli część adresu nie ma żadnych tłumaczeń ani transliteracji w języku używającym alfabetu łacińskiego, usługa zwróci tę część w języku lokalnym powiązanym z adresem.

Włącz te dane wyjściowe za pomocą flagi google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Uwaga: pola 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.

Wynik

Ogólny przegląd wyniku weryfikacji adresu i kodu geograficznego.

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

enum (Granularity)

Szczegółowość adresu wejściowego. Jest to wynik analizy adresu wejściowego i nie daje żadnych sygnałów weryfikacyjnych. Informacje o sygnałach weryfikacji znajdziesz w sekcji validationGranularity poniżej.

Jeśli na przykład podany adres zawiera konkretny numer mieszkania, pole inputGranularity w tym miejscu ma wartość SUB_PREMISE. Jeśli nie możemy dopasować numeru mieszkania w bazie danych lub numer jest nieprawidłowy, validationGranularity prawdopodobnie będzie wynosić PREMISE lub mniej.
validationGranularity

enum (Granularity)

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

Wyniki weryfikacji komponentu według adresu można znaleźć w polu google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Informacje o szczegółowości geocode. Można to rozumieć jako znaczenie semantyczne określające przybliżoną lub dokładną lokalizację geokodowaną.

Ta zasada może się czasami różnić od powyższej procedury validationGranularity. W naszej bazie danych można na przykład rejestrować istnienie numeru mieszkania, ale nie określać jego dokładnej lokalizacji w dużym kompleksie mieszkalnym. W takim przypadku validationGranularity będzie mieć wartość SUB_PREMISE, a geocodeGranularity będzie mieć wartość PREMISE.
addressComplete

boolean

Adres jest uznawany za pełny, jeśli nie ma nierozstrzygniętych tokenów ani niespodziewanych lub brakujących komponentów adresu. Jeśli zasada jest nieskonfigurowana, wartość to false. Więcej informacji znajdziesz w polach missingComponentTypes, unresolvedTokens i unexpected.
hasUnconfirmedComponents

boolean

Nie można sklasyfikować ani zweryfikować co najmniej jednego komponentu adresu. Więcej informacji znajdziesz na stronie google.maps.addressvalidation.v1.Address.address_components.
hasInferredComponents

boolean

Pobrano (dodano) co najmniej 1 komponent adresu, którego nie ma w danych wejściowych. Więcej informacji znajdziesz tutaj: google.maps.addressvalidation.v1.Address.address_components.
hasReplacedComponents

boolean

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

Szczegółowość

Różne poziomy szczegółowości adresu lub geokodu. Wartości te używane do określania szczegółowości adresu wskazują, z jaką dokładnością adres identyfikuje miejsce docelowe poczty. Na przykład adres „123 Main Street, Redwood City, CA, 94061” identyfikuje PREMISE, a na przykład „Redwood City, CA, 94061” wskazuje identyfikator LOCALITY. Jeśli jednak nie możemy znaleźć kodu geograficznego „ulica Główna 123” w Redwood City, zwracany geokod może mieć dokładność LOCALITY, mimo że jest bardziej szczegółowy.

Wartości w polu enum
GRANULARITY_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
SUB_PREMISE Wynik znajdujący się poniżej poziomu budynku, np. mieszkanie.
PREMISE Wynik na poziomie budynku.
PREMISE_PROXIMITY Geokod, który określa przybliżoną lokalizację adresu na poziomie budynku.
BLOCK Adres lub kod geograficzny wskazują blok. Używany tylko w regionach z adresowaniem na poziomie bloku, np. w Japonii.
ROUTE Geokod lub adres są bardzo szczegółowe w odniesieniu do trasy, np. ulicy, drogi lub autostrady.
OTHER Wszystkie inne szczegóły, które są grupowane razem, ponieważ nie są możliwe do dostarczenia.

Adres

Szczegóły przetworzonych adresów. Proces ten obejmuje poprawianie błędnie napisanych części adresu, wymianę nieprawidłowych części oraz ustalanie brakujących części.

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

string

Przetworzony adres w formacie jednowierszowym zgodnie z regułami formatowania adresu obowiązującymi w regionie, w którym się znajduje.
postalAddress

object (PostalAddress)

Adres pocztowy do przetworzenia po przetworzeniu.
addressComponents[]

object (AddressComponent)

Lista nieuporządkowana. Pojedyncze składniki sformatowanego i poprawionego adresu wraz z informacjami dotyczącymi weryfikacji. Znajdziesz tu informacje o stanie weryfikacji poszczególnych komponentów.

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

string

Typy komponentów, które powinny znajdować się w prawidłowo sformatowanym adresie pocztowym, ale nie zostały znalezione w danych wejściowych ORAZ nie można ich określić. Komponenty tego typu nie występują w środowiskach formattedAddress, postalAddress i addressComponents. Przykładem może być ['street_number', 'route'] dla danych wejściowych, takich jak „Boulder, Kolorado, 80301, USA”. Listę możliwych typów znajdziesz tutaj.
unconfirmedComponentTypes[]

string

Typy komponentów, które występują w polu addressComponents, ale nie udało się potwierdzić ich poprawności. To pole zostało udostępnione dla wygody: jego zawartość jest równoważna iteracja z polecenia addressComponents w celu znalezienia typów wszystkich komponentów, dla których confirmationLevel nie ma wartości CONFIRMED lub flaga inferred nie jest ustawiona na true. Listę możliwych typów znajdziesz tutaj.
unresolvedTokens[]

string

Wszystkie tokeny w danych wejściowych, których nie udało się znaleźć. Może to być wartość, która nie została rozpoznana jako prawidłowa część adresu. Na przykład w przypadku danych wejściowych takich jak „123235253253 Main St, San Francisco, CA, 94105”, nierozpoznane tokeny mogą wyglądać jak ["123235253253"], ponieważ nie wygląda to na prawidłowy numer ulicy.

AddressComponent

Reprezentuje komponent adresu, np. ulicę, miasto lub województwo.

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

object (ComponentName)

Nazwa tego komponentu.
componentType

string

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

enum (ConfirmationLevel)

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

boolean

Wskazuje, że komponent nie był częścią danych wejściowych, ale wywnioskowaliśmy, że jest to lokalizacja adresu i uważamy, że należy go podać w przypadku pełnego adresu.
spellCorrected

boolean

Wskazuje poprawkę błędu pisowni w nazwie komponentu. Interfejs API nie zawsze oznacza zmiany z jednej wersji pisowni na inny, na przykład przy zmianie wartości „centre” na „center”. Nie zawsze oznacza to również częste błędy pisowni, np. „Amphitheater Pkwy” na „Amphitheatre Pkwy”.
replaced

boolean

Wskazuje, że nazwa komponentu została zastąpiona zupełnie inną – np. nieprawidłowy kod pocztowy został zastąpiony kodem poprawnym dla adresu. Nie jest to zmiana wyglądu. Komponent wejściowy został zmieniony na inny.
unexpected

boolean

Wskazuje komponent adresu, którego nie powinno się znajdować w adresie pocztowym w danym regionie. Zostały przez nas zachowane tylko dlatego, że stanowiły część tych danych.

ComponentName

Opakowanie nazwy komponentu.

Zapis JSON 
{
  "text": string,
  "languageCode": string
}
Pola
text

string

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

string

Kod języka BCP-47. Nie pojawi się, jeśli nazwa komponentu nie jest powiązana z językiem, np. z numerem domu.

ConfirmationLevel

Różne możliwe wartości poziomów potwierdzenia.

Wartości w polu enum
CONFIRMATION_LEVEL_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
CONFIRMED Mogliśmy potwierdzić, że ten komponent istnieje i czy ma sens w kontekście reszty adresu.
UNCONFIRMED_BUT_PLAUSIBLE Nie udało się potwierdzić tego komponentu, ale prawdopodobnie istnieje. Może to być na przykład numer domu mieszczący się w określonym prawidłowym zakresie numerów na ulicy, na której nie są znane konkretne numery domów.
UNCONFIRMED_AND_SUSPICIOUS Ten komponent nie został potwierdzony i prawdopodobnie jest nieprawidłowy. Przykładem może być dzielnica, która nie pasuje do podanego adresu.

Geokod

Zawiera informacje o miejscu, na które dane zostały zmapowane.

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

object (LatLng)

Geokodowana lokalizacja danych wejściowych.

Preferowanym sposobem używania identyfikatora miejsca jest stosowanie adresów, współrzędnych geograficznych oraz kodów plus. Używanie współrzędnych do wyznaczania tras lub wyznaczania tras dojazdu zawsze powoduje przyciągnięcie punktu do drogi znajdującej się najbliżej tych współrzędnych. Nie musi to być droga, która szybko lub bezpiecznie prowadzi do miejsca docelowego, i nie musi znajdować się w pobliżu punktu dostępu do nieruchomości. Jeśli lokalizacja jest geokodowana w odwrotnym zapisie, nie ma gwarancji, że zwrócony adres będzie zgodny z oryginałem.
plusCode

object (PlusCode)

Plus Code odpowiadający atrybutowi location.
bounds

object (Viewport)

Granice miejsca objętego geokodowaniem.
featureSizeMeters

number

Wielkość miejsca objętego geokodem (w metrach). Jest to kolejna miara niedokładności geokodowanej lokalizacji, ale w kontekście fizycznym, a nie semantycznym.
placeId

string

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

Więcej informacji o identyfikatorach miejsc znajdziesz tutaj.
placeTypes[]

string

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

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Jest ona wyrażona jako para podwójnej precyzji reprezentująca stopnie szerokości i długości geograficznej. O ile nie wskazano inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą mieścić się w znormalizowanych zakresach.

Zapis JSON 
{
  "latitude": number,
  "longitude": number
}
Pola
latitude

number

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

number

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

PlusCode

Plus Code (http://plus.codes) to odniesienie do lokalizacji w 2 formatach: kod globalny definiujący rozmiar 14 m x 14 m lub mniejszy prostokątny oraz kod złożony, zastępując prefiks lokalizacją referencyjną.

Zapis JSON 
{
  "globalCode": string,
  "compoundCode": string
}
Pola
globalCode

string

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

string

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

Widoczny obszar

Widoczny obszar o długości i szerokości geograficznej reprezentowany jako dwa przeciwstawne punkty: low i high po przekątnej. Widoczny obszar jest uważany za obszar zamknięty, czyli obejmujący swoją granicę. Granice szerokości geograficznej muszą mieścić się w przedziale od -90 do 90 stopni włącznie, a długość geograficzna musi się mieścić w przedziale od -180 do 180 stopni włącznie. Różne przypadki:

  • Jeśli low = high, widoczny obszar składa się z tego pojedynczego punktu.

  • Jeśli low.longitude > high.longitude, zakres długości geograficznej jest odwrócony (widoczny obszar przecina linię długości geograficznej 180 stopni).

  • Jeśli low.longitude = -180 stopni, a high.longitude = 180 stopni, widoczny obszar obejmuje wszystkie długości geograficzne.

  • Jeśli low.longitude = 180 stopni, a high.longitude = -180 stopni, zakres długości geograficznej jest pusty.

  • Jeśli low.latitude > high.latitude, zakres szerokości geograficznej jest pusty.

Musisz wypełnić pola low i high, a reprezentowane pole nie może być puste (zgodnie z definicjami powyżej). Pusty obszar spowoduje wystąpienie błędu.

Na przykład ten widoczny obszar w całości obejmuje Nowy Jork:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Zapis JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Pola
low

object (LatLng)

Wymagane. Najniższy punkt widocznego obszaru.
high

object (LatLng)

Wymagane. Najwyższy punkt widocznego obszaru.

AddressMetadata

Metadane adresu. Nie ma gwarancji, że w przypadku każdego adresu wysłanego do interfejsu Address Validation API pole metadata będzie wypełnione w pełni.

Zapis JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Pola
business

boolean

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

boolean

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

boolean

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

UspsData

Dane USPS dotyczące adresu. Nie ma gwarancji, że pole uspsData będzie wypełnione w całości w przypadku każdego adresu w Stanach Zjednoczonych lub kraju, który został wysłany do interfejsu Address Validation API. Jeśli jako główną część odpowiedzi używasz pola uspsData, zalecamy zintegrowanie w odpowiedzi pól zapasowego adresu URL.

Zapis JSON 
{
  "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
}
Pola
standardizedAddress

object (UspsAddress)

Ustandaryzowany adres USPS.
deliveryPointCode

string

2-cyfrowy kod punktu dostawy
deliveryPointCheckDigit

string

Cyfra kontrolna punktu dostawy. Ta liczba jest dodawana na końcu parametru delivery_point_barcode w przypadku poczty skanowanej mechanicznie. Po dodaniu wszystkich cyfr kodu kreskowego_punktu_dostarczania, deliveryPointCheckDigit, kodu pocztowego i ZIP+4 powinno się wyświetlić liczbę podzieloną przez 10.
dpvConfirmation

string

Możliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak lub nie zwraca żadnej wartości.

  • N: nie udało się potwierdzić informacji o numerze głównym ani o numerze pomocniczym.
  • D: adres został potwierdzony tylko w przypadku numeru głównego, a brakowało drugiego numeru.
  • S: adres został potwierdzony tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były dostępne, ale nie zostały potwierdzone.
  • Y: adres został potwierdzony jako DPV jako numer główny i wszystkie numery dodatkowe.
  • Puste: jeśli odpowiedź nie zawiera wartości dpvConfirmation, oznacza to, że adres nie został przesłany w celu potwierdzenia DPV.
dpvFootnote

string

Przypisy z weryfikacji punktu dostawy. W tym samym ciągu znaków może być wiele przypisów.

  • AA: adres wejściowy pasujący do pliku ZIP+4
  • A1: adres wejściowy nie został dopasowany do pliku ZIP+4
  • BB: dopasowanie do DPV (wszystkie komponenty)
  • CC: numer dodatkowy nie został dopasowany i nie jest wymagany
  • C1: numer dodatkowy nie pasuje, ale jest wymagany
  • N1: brak dodatkowego numeru w adresie wieżowca
  • M1: brak głównego numeru
  • M3: nieprawidłowy numer podstawowy
  • P1: brak numeru skrytki, numeru RR lub numeru skrytki w Centrum pomocy
  • P3: podany adres PO, RR lub numer skrytki pomocy jest nieprawidłowy
  • F1: adres wejściowy pasujący do adresu wojskowego
  • G1: adres wejściowy pasujący do ogólnego adresu dostawy
  • U1: adres wejściowy dopasowany do unikalnego kodu pocztowego
  • PB: adres wejściowy pasujący do rekordu PBSA
  • RR: potwierdzony adres firmy zewnętrznej z informacjami o PMB
  • R1: potwierdzony adres firmy zewnętrznej bez informacji o PMB
  • R7: rekord trasy R777 lub R779 operatora
  • IA: zidentyfikowano świadomy adres
  • TA: liczba podstawowa dopasowana przez usunięcie końcowej litery alfa
dpvCmra

string

Wskazuje, czy adres należy do agencji zajmującej się dostarczaniem poczty e-mail (CMRA) – prywatnej firmy, która odbiera pocztę w imieniu klientów. Zwraca pojedynczy znak.

  • Y: adres jest zgodny z CMRA
  • N: adres nie jest zgodny z CMRA
dpvVacant

string

Czy to miejsce jest puste? Zwraca pojedynczy znak.

  • Y: adres jest pusty
  • N: adres nie jest pusty
dpvNoStat

string

Czy to jest adres bez danych statystycznych czy aktywny? Adresy bez statystyk to takie, które nie są stale zajęte lub nie są obsługiwane przez USPS. Zwraca pojedynczy znak.

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

integer

Wskazuje typ NoStat. Zwraca kod przyczyny w postaci liczby całkowitej.

  • 1: IDA (wewnętrzny adres zwrotny) – adresy, które nie otrzymują poczty bezpośrednio z USPS, ale są dostarczane na adres pocztowy, który jest dla nich obsługiwany.
  • 2: CDS – adresy, których nie można jeszcze dostarczyć. Przykładem może być nowy podział, w którym określono działki i numery główne, ale nie ma jeszcze budynku przeznaczonego na obłożenie.
  • 3: kolizja – adresy, które w rzeczywistości nie są potwierdzone przez DPV.
  • 4: kod CMZ (szkoły wyższe, wojskowe i inne) – plik ZIP + 4 rekordy USPS zostały dołączone do danych.
  • 5: zwykła przesyłka – oznacza, że adresy nie są dostarczane, a adresy nie są liczone jako możliwe dostawy.
  • 6: dodatkowy wymagany – adres wymaga informacji dodatkowych.
dpvDrop

string

Flaga wskazuje, że poczta jest dostarczana do jednej skrzynki odbiorczej w witrynie. Zwraca pojedynczy znak.

  • Y: e-mail jest dostarczany do jednej skrzynki, którą można odbierać w witrynie.
  • N: e-mail nie jest dostarczany do jednego, który można otworzyć w witrynie.
dpvThrowback

string

Wskazuje, że poczta nie jest dostarczana na adres. Zwraca pojedynczy znak.

  • Y: poczta nie zostanie dostarczona na adres.
  • N: poczta jest dostarczana na adres.
dpvNonDeliveryDays

string

Flaga oznacza, że poczta nie jest dostarczana każdego dnia tygodnia. Zwraca pojedynczy znak.

  • Y: poczta nie jest dostarczana każdego dnia tygodnia.
  • N: brak informacji o tym, że poczta nie jest dostarczana każdego dnia tygodnia.
dpvNonDeliveryDaysValues

integer

Liczba całkowita określająca dni niedostarczenia. Można sprawdzać je przy użyciu flag bitowych: 0 x 40 – niedziela to dzień niedostarczenia 0x20 – poniedziałek to dzień niedostarczenia 0x10 – wtorek to dzień niedostarczenia 0x08 – środa to dzień niedoręczenia 0x04 – czwartek to dzień niedoręczenia 0x02 – piątek to dzień niedoręczenia 0x02 – piątek to dzień niedoręczenia 0x01
dpvNoSecureLocation

string

Flaga wskazuje, że drzwi są dostępne, ale paczka nie zostanie pozostawiona ze względów bezpieczeństwa. Zwraca pojedynczy znak.

  • Y: ze względów bezpieczeństwa przesyłka nie zostanie pozostawiona.
  • N: nie oznacza, że pakiet nie zostanie pozostawiony ze względów bezpieczeństwa.
dpvPbsa

string

Wskazuje, że adres został dopasowany do rekordu PBSA. Zwraca pojedynczy znak.

  • Y: adres został dopasowany do rekordu PBSA.
  • N: adres nie został dopasowany do rekordu PBSA.
dpvDoorNotAccessible

string

Flaga wskazuje adresy, pod którymi USPS nie może zapukać w celu dostarczenia poczty. Zwraca pojedynczy znak.

  • Y: drzwi są niedostępne.
  • N: brak informacji o tym, że drzwi są niedostępne.
dpvEnhancedDeliveryCode

string

Wskazuje, że dla danego adresu prawidłowy jest więcej niż 1 kod zwrotny od dostawcy zewnętrznego. Zwraca pojedynczy znak.

  • Y: adres został potwierdzony jako DPV jako numer główny i wszystkie numery dodatkowe.
  • N: nie udało się potwierdzić informacji o numerze głównym ani o numerze pomocniczym.
  • S: adres został potwierdzony tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były dostępne, ale nie zostały potwierdzone, lub pominięto pojedynczy końcowy znak alfa dotyczący numeru podstawowego w celu dopasowania DPV i wymagane były dodatkowe informacje.
  • D: adres został potwierdzony tylko w przypadku numeru głównego, a brakowało drugiego numeru.
  • R: adres potwierdzony, ale przypisany do trasy fantomowej R777 i R779 oraz dostawy przez USPS nie jest podany.
carrierRoute

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: droga wiejska
  • H: trasa zakontraktowana na autostradę
  • B: Sekcja skrytki pocztowej
  • G: ogólna jednostka dostawy
carrierRouteIndicator

string

Wskaźnik sortowania stawki przewoźnika.
ewsNoMatch

boolean

Adres dostawy jest możliwy do dopasowania, ale plik EWS wskazuje, że dopasowanie ścisłe będzie wkrótce dostępne.
postOfficeCity

string

Główny urząd pocztowy.
postOfficeState

string

Główny stan poczty.
abbreviatedCity

string

Skrócone miasto.
fipsCountyCode

string

Kod kraju FIPS.
county

string

Nazwa hrabstwa.
elotNumber

string

numeru rozszerzonego linii podróży (eLOT).
elotFlag

string

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

boolean

Kod pocztowy tylko w przypadku skrytki pocztowej.
pmbDesignator

string

Oznaczenie jednostki PMB (Private Mail Box).
pmbNumber

string

Numer PMB (Private Mail Box);
addressRecordType

string

Typ rekordu adresowego, który pasuje do wejściowego adresu.

  • F: FIRMA. Jest to dopasowanie do rekordu firmy, czyli najlepszego możliwego poziomu dopasowania dla adresu.
  • G: DOSTAWA OGÓLNA. To jest dopasowanie do ogólnego rekordu dostawy.
  • H: BUDŻET / MIEJSCE. To jest dopasowanie do danych o budynku lub mieszkaniu.
  • P: SKRZYNKA POCZTOWA. To odpowiednik skrytki pocztowej.
  • R: TRASA RUCHOWA lub UMOWA DUŻĄ DROGĄ: wskazuje dopasowanie do rekordu drogi wiejskiej lub umowy drogowej, które mogą mieć powiązane zakresy numerów skrzynek.
  • S: REKORD ULICY: dopasowanie do rekordu ulicy, który zawiera prawidłowy podstawowy zakres numerów.
defaultAddress

boolean

Wskazuje, że znaleziono adres domyślny, ale istnieją bardziej szczegółowe adresy.
errorMessage

string

Komunikat o błędzie pobierania danych przez USPS. To pole jest wypełniane, gdy przetwarzanie przez USPS zostanie zawieszone z powodu wykrycia sztucznie utworzonych adresów.

Ten błąd może powodować, że pola danych USPS mogą nie być wypełnione.
cassProcessed

boolean

Wskazuje, że żądanie zostało przetworzone przez CASS.

UspsAddress

Dokument przesyłany przez USPS z adresu w Stanach Zjednoczonych.

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

string

Pierwszy wiersz adresu.
firm

string

Nazwa firmy.
secondAddressLine

string

Drugi wiersz adresu.
urbanization

string

Portorykańska nazwa urbanizacji.
cityStateZipAddressLine

string

Miasto, województwo + kod pocztowy.
city

string

Nazwa miasta.
state

string

Dwuliterowy kod stanu.
zipCode

string

Kod pocztowy, np. 10009.
zipCodeExtension

string

Czterocyfrowe rozszerzenie kodu pocztowego, np. 5023.