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)

To pole jest wymagane. Sprawdzany adres. Niesformatowane adresy należy przesyłać za pomocą parametru addressLines.

Całkowita długość pól w tych danych nie może przekraczać 280 znaków.

Listę obsługiwanych regionów znajdziesz tutaj.

Wartość languageCode w adresie wejściowym jest zarezerwowana do wykorzystania w przyszłości i dziś jest ignorowana. Wyniki dotyczące zweryfikowanego adresu zostaną wypełnione na podstawie języka ustawionego przez system dla danego adresu.

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

string

To pole musi być puste w przypadku pierwszego żądania weryfikacji adresu. Jeśli do pełnej weryfikacji pojedynczego adresu potrzeba więcej żądań (np. zmiany wprowadzane przez użytkownika po pierwszej weryfikacji muszą być ponownie zweryfikowane), każde kolejne żądanie musi wypełnić to pole wartością responseId z pierwszej odpowiedzi w sekwencji weryfikacji.
enableUspsCass

boolean

Włącza tryb zgodności USPS CASS. Ma to wpływ tylko na pole google.maps.addressvalidation.v1.ValidationResult.usps_data w google.maps.addressvalidation.v1.ValidationResult. Uwaga: w przypadku żądań z obsługą USPS CASS dla adresów w Portoryko google.type.PostalAddress.region_code z address należy podać jako „PR” lub google.type.PostalAddress.administrative_area dla address należy podać jako „Portoryko” (wielkość liter nie jest rozróżniana) lub „PR”.

Zalecamy użycie komponentu address lub określenie co najmniej 2 elementów google.type.PostalAddress.address_lines, gdzie pierwszy wiersz zawiera numer domu i nazwę, a drugi – miasto, stan i kod pocztowy.
languageOptions

object (LanguageOptions)

Opcjonalnie. Podgląd: ta funkcja jest w wersji testowej (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 są objęte Szczegółowymi warunkami korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Włącza interfejs Address Billingation API, aby uwzględnić w odpowiedzi dodatkowe informacje.
sessionToken

string

Opcjonalnie. Ciąg znaków, który identyfikuje sesję autouzupełniania na potrzeby rozliczeń. Musi to być bezpieczny adres URL i bezpieczny dla nazwy pliku ciąg base64 o długości nie większej niż 36 znaków ASCII. W przeciwnym razie zwracany jest błąd INVALID_ARGUMENT.

Sesja zaczyna się, gdy użytkownik wpisze zapytanie autouzupełniania, a kończy się, gdy wybierze miejsce i prześle żądanie informacji o miejscu lub weryfikacji adresu. Każda sesja może zawierać kilka zapytań autouzupełniania, po których następuje 1 prośba o informacje o miejscu lub o weryfikację adresu. Dane logowania używane w przypadku każdego żądania w ramach sesji muszą należeć do tego samego projektu w konsoli Google Cloud. Po zakończeniu sesji token traci ważność. Aplikacja musi generować nowy token dla każdej sesji. Jeśli parametr sessionToken zostanie pominięty lub ponownie użyjesz tokena sesji, opłata za sesję zostanie naliczona tak, jakby nie podano żadnego tokena sesji (każde żądanie jest rozliczane oddzielnie).

Uwaga: sprawdzania adresu można używać tylko w sesjach z interfejsem Autocomplete (New) API, a nie z interfejsem Autocomplete API. 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, który identyfikuje tę odpowiedź. Jeśli adres wymaga ponownej weryfikacji, ten identyfikator UUID musi dołączyć do nowego żądania.

PostalAddress

Reprezentuje adres pocztowy, np. adres pocztowy lub adres do płatności. Podany adres pocztowy pozwala na dostarczenie paczek do danego lokalu, skrytki pocztowej lub podobnej. Nie służy do modelowania lokalizacji geograficznych (dróg, miast, gór).

W zależności od typu procesu adres zwykle jest tworzony na podstawie danych wejściowych użytkownika lub importu istniejących danych.

Wskazówki dotyczące wpisywania / edytowania adresu: – Używaj widżetu adresu gotowego na internacjonalizację, np. https://github.com/google/libaddressinput. – Użytkownicy nie powinni widzieć elementów interfejsu do wprowadzania lub edytowania pól poza krajami, w których to pole jest używane.

Więcej wskazówek dotyczących używania tego schematu znajdziesz na 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 obiektu PostalAddress. Każda wartość inna niż 0 spowoduje, że interfejs API zwróci błąd INVALID_ARGUMENT.
regionCode

string

Opcjonalnie. Kod regionu CLDR kraju/regionu adresu. Szczegółowe informacje znajdziesz na stronach https://cldr.unicode.org/ i https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH” w przypadku Szwajcarii. Jeśli kod regionu nie zostanie podany, zostanie on określony na podstawie adresu. Aby uzyskać najlepszą wydajność, zalecamy dołączenie kodu regionu, jeśli go znasz. Używanie niespójnych lub powtarzających się regionów może obniżać wydajność, na przykład jeśli addressLines zawiera już region, nie podawaj ponownie kodu regionu w tym polu. Informacje o obsługiwanych regionach znajdziesz w najczęstszych pytaniach.
languageCode

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 właściwym dla jego lokalizacji.
postalCode

string

Opcjonalnie. Kod pocztowy adresu. Nie we wszystkich krajach stosuje się kody pocztowe lub tego nie robią, ale miejsca, w których są stosowane, mogą wymagać dodatkowej weryfikacji w przypadku innych części adresu (np. weryfikacji stanu/poczty w Stanach Zjednoczonych).
sortingCode

string

Opcjonalnie. Dodatkowy kod rozliczeniowy zależny od kraju. Ta opcja nie jest używana w większości regionów. Ta wartość jest ciągiem znaków typu „CEDEX”, opcjonalnie z liczbą (np. „CEDEX 7”), lub tylko liczbą reprezentują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 podgrupa administracyjnej, używana w przypadku adresów pocztowych w kraju lub regionie. Może to być na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie społeczność autonomiczna (np. „Barcelona”, a nie „Katalonia”). W wielu krajach w adresach pocztowych nie ma podanego obszaru administracyjnego. Na przykład w Szwajcarii ten obszar powinien pozostać pusty.
locality

string

Opcjonalnie. Zasadniczo odnosi się do miejscowości lub miejscowości, która znajduje się w adresie. Przykłady: miasto w USA, gmina IT, poczta brytyjska. W regionach świata, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, pozostaw pole rejonu puste i użyj pola addressLines.
sublocality

string

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

string

To pole jest wymagane. Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu.

Ponieważ wartości w polach addressLine nie zawierają informacji o typie i czasami mogą zawierać wiele wartości w pojedynczym polu (np. „Austin, TX”), kolejność wierszy musi być jasna. Kolejność wierszy adresu powinna być zgodna z wartością „koperty” dla kraju/regionu adresu.

Minimalna dozwolona reprezentacja strukturalna adresu obejmuje wszystkie informacje umieszczone w obiekcie addressLines. Jeśli regionCode nie jest podany, 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 (zamiast zgadywania, które części adresu powinny być nazwami miejscowości lub obszarów administracyjnych).
recipients[]

string

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

string

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

LanguageOptions

Podgląd: ta funkcja jest w wersji testowej (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 są objęte Szczegółowymi warunkami korzystania z usługi Google Maps Platform. Więcej informacji znajdziesz w opisach etapu uruchamiania.

Włącza interfejs Address Billingation API, aby uwzględnić w odpowiedzi dodatkowe informacje.

Zapis JSON 
{
  "returnEnglishLatinAddress": boolean
}
Pola
returnEnglishLatinAddress

boolean

Podgląd: zwróć urządzenie 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 oceny ogólnej
address

object (Address)

Informacje o adresie, a nie o geokodzie.
geocode

object (Geocode)

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

object (AddressMetadata)

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

object (UspsData)

Dodatkowe oznaczenia dotyczące dostawy są dostarczane przez USPS. Podano tylko w regionach US i PR.
englishLatinAddress

object (Address)

Podgląd: ta funkcja jest w wersji testowej (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 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 język angielski.

Przetłumaczonych adresów nie można wykorzystywać ponownie jako danych wejściowych przez interfejs API. Usługa zapewnia taką możliwość, dzięki czemu użytkownik może użyć swojego języka ojczystego do potwierdzenia lub odrzucenia pierwotnie podanego adresu.

Jeśli część adresu nie ma tłumaczenia na język angielski, usługa zwraca tę część w języku alternatywnym z alfabetem łacińskim. Informacje o sposobie wyboru języka alternatywnego znajdziesz tutaj. Jeśli część adresu nie ma żadnych tłumaczeń ani transliteracji w języku korzystającym z alfabetu łacińskiego, usługa zwraca tę część w lokalnym języku powiązanym z adresem.

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

Uwaga: pole google.maps.addressvalidation.v1.Address.unconfirmed_component_types w polu englishLatinAddress i google.maps.addressvalidation.v1.AddressComponent.confirmation_level w polu 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 przekazuje żadnych sygnałów weryfikacyjnych. Sygnały weryfikacyjne znajdziesz w sekcji validationGranularity poniżej.

Jeśli na przykład podany adres zawiera konkretny numer mieszkania, w polu inputGranularity wpisz tutaj wartość SUB_PREMISE. Jeśli nie możemy dopasować numeru mieszkania w bazach danych lub numer jest nieprawidłowy, validationGranularity prawdopodobnie będzie miał wartość 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 wynosząca PREMISE oznacza, że wszystkie komponenty adresu mogą być sprawdzane na poziomie PREMISE lub wyższym.

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

enum (Granularity)

Informacje o szczegółowości geocode. Jest to semantyczne oznaczanie dokładności i dokładności geokodowanej lokalizacji.

Czasem może się różnić od wartości validationGranularity powyżej. Na przykład nasza baza danych może rejestrować istnienie numeru mieszkania, ale nie podawać dokładnej lokalizacji tego lokalu 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 uważany za kompletny, jeśli nie ma nierozwiązanych tokenów ani nieoczekiwanych lub brakujących komponentów adresu. Jeśli wartość nie jest skonfigurowana, wskazuje, że wartość to false. Więcej szczegółów znajdziesz w polach missingComponentTypes, unresolvedTokens i unexpected.
hasUnconfirmedComponents

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.
hasInferredComponents

boolean

Wywnioskowano (dodano) co najmniej 1 komponent adresu, którego nie było w danych wejściowych. Szczegółowe informacje znajdziesz na stronie google.maps.addressvalidation.v1.Address.address_components.
hasReplacedComponents

boolean

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

Szczegółowość

Różne poziomy szczegółowości adresu lub geokodu. Wartości te użyte do określenia szczegółowości adresu wskazują poziom szczegółowości adresu miejsca docelowego poczty. Na przykład adres „123 Main Street, Redwood City, CA, 94061” identyfikuje PREMISE, a „Redwood City, CA, 94061” identyfikuje LOCALITY. Jeśli jednak nie uda nam się znaleźć geokodu dla ulicy „Ulica Główna 123” w Warszawie, zwrócony geokod może mieć poziom szczegółowości LOCALITY, mimo że adres jest bardziej szczegółowy.

Wartości w polu enum
GRANULARITY_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
SUB_PREMISE Wynik poniżej poziomu budynku, na przykład mieszkania.
PREMISE Wynik na poziomie budynku.
PREMISE_PROXIMITY Geokod określający lokalizację adresu na poziomie budynku.
BLOCK Adres lub geokod wskazuje blok. Używany tylko w regionach z adresowaniem na poziomie blokowym, np. w Japonii.
ROUTE Geokod lub adres są bardzo szczegółowe, np. obejmuje ulicę, drogę lub autostradę.
OTHER Wszystkie inne szczegóły, które są grupowane, ponieważ są niemożliwe do przesłania.

Adres

Szczegóły przetworzonego adresu. Proces końcowy obejmuje poprawienie błędnie zapisanych części adresu, zastąpienie nieprawidłowych części i wykrycie 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 postaci adresu jednowierszowego zgodny z regułami formatowania adresu obowiązującymi w regionie, w którym znajduje się adres.
postalAddress

object (PostalAddress)

Adres po przetworzeniu danych, który jest widoczny jako adres pocztowy.
addressComponents[]

object (AddressComponent)

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

Komponenty adresu nie są uporządkowane w określony sposób. Nie zakładaj w żaden sposób kolejności komponentów adresu na liście.
missingComponentTypes[]

string

Typy komponentów, które powinny znajdować się w poprawnie sformatowanym adresie pocztowym, ale nie znaleziono w danych wejściowych ORAZ nie można wywnioskować. Komponenty tego typu nie występują w elementach formattedAddress, postalAddress ani addressComponents. Przykładem może być ['street_number', 'route'] w przypadku danych wejściowych, takich jak „Boulder, Kolorado, 80301, USA”. Listę możliwych typów znajdziesz tutaj.
unconfirmedComponentTypes[]

string

Typy komponentów obecnych w polu addressComponents, których nie udało się potwierdzić, że są prawidłowe. To pole zostało dodane dla wygody użytkowników. Jego zawartość jest odpowiednikiem powtórzenia metody 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 wpisane dane wejściowe, których nie udało się rozpoznać. Mogą to być dane, które nie zostały rozpoznane jako prawidłowa część adresu (np. w danych takich jak „ul. Główna 123235253253, San Francisco, CA, 94105”, nierozstrzygnięte tokeny mogą wyglądać tak: ["123235253253"], ponieważ nie wyglądają one na prawidłowy numer budynku.

AddressComponent

Reprezentuje komponent adresu, na przykład ulicę, miasto lub stan.

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 zwracanych 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, ale wywnioskowaliśmy go dla lokalizacji adresu i uważamy, że należy go podać, aby podać pełny adres.
spellCorrected

boolean

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

boolean

wskazuje, że nazwa komponentu została zastąpiona całkowicie inną nazwą (np. nieprawidłowy kod pocztowy został zastąpiony prawidłowym kodem adresu). Nie jest to tylko kosmetyczna zmiana, ponieważ komponent danych wejściowych został zmieniony na inny.
unexpected

boolean

Wskazuje składnik adresu, który nie powinien występować w adresie pocztowym dla danego regionu. Zachowajmy je tylko dlatego, że były częścią danych wejściowych.

ComponentName

Kod nazwy komponentu.

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

string

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

string

Kod języka BCP-47. Ten atrybut nie będzie dostępny, 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 Udało nam się ustalić, czy 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 budynku ze znanego zakresu numerów na ulicy, dla której nie są znane konkretne numery domów.
UNCONFIRMED_AND_SUSPICIOUS Ten komponent nie został potwierdzony i prawdopodobnie jest nieprawidłowy. Może to być na przykład dzielnica, która nie pasuje do reszty adresu.

Geokod

Zawiera informacje o miejscu, do którego dane wejściowe zostały przetworzone geokodem.

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.

Używanie identyfikatorów miejsc jest preferowane zamiast używania adresów, współrzędnych szerokości i długości geograficznej lub kodów plus. Korzystanie ze współrzędnych podczas wyznaczanie trasy 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 celu i nie może znajdować się w pobliżu punktu dostępu do posesji. Ponadto, gdy lokalizacja jest poddawana odwrotnym geokodowi, nie ma gwarancji, że zwrócony adres jest zgodny z pierwotnym adresem.
plusCode

object (PlusCode)

Kod plus odpowiadający kontu location.
bounds

object (Viewport)

Granice miejsca geokodowanego.
featureSizeMeters

number

Wielkość miejsca geokodowanego (w metrach). Jest to kolejna miara przybliżenia geokodowanej lokalizacji, ale jej rozmiaru fizycznego, a nie semantycznego.
placeId

string

Identyfikator miejsca miejsca, do którego dane geograficzne są przesyłane.

Więcej informacji na temat identyfikatorów miejsc znajdziesz tutaj.
placeTypes[]

string

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

LatLng

Obiekt reprezentujący parę szerokości/długości geograficznej. Wartość ta jest wyrażona jako para podwójnej wartości oznaczająca stopnie szerokości i długości geograficznej w stopniach. O ile nie wskazano inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą się mieścić 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 [-180,0, +180,0].

PlusCode

Plus Code (http://plus.codes) to odniesienie do lokalizacji w dwóch formatach: globalny kod definiujący wymiary 14 m x 14 m (1/8000 stopnia) lub mniejszy prostokąt oraz kod złożony, zastępując prefiks adresem referencyjnym.

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

string

Globalny (pełny) kod miejsca, np. „9FWM33GV+HQ”, który reprezentuje obszar o wymiarach 1/8000 x 1/8000 stopnia (ok. 14 x 14 metrów).
compoundCode

string

Kod złożony miejsca, np. „33GV+HQ, Ramberg, Norwegia”, który zawiera sufiks kodu globalnego i zastępuje prefiks sformatowaną nazwą jednostki referencyjnej.

Widoczny obszar

Widoczny obszar o długości i szerokości geograficznej wyrażony jako 2 punkty po przekątnej naprzeciwko low i high. Widoczny obszar jest traktowany jako obszar zamknięty, czyli obejmuje swoją granicę. Granice szerokości geograficznej muszą się mieścić w przedziale od -90 do 90 stopni włącznie, a długość geograficzna – z zakresu od -180 do 180 stopni włącznie. Różne przypadki to m.in.:

  • 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 180 stopni).

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

  • Jeśli low.longitude = 180 stopni, 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ć zarówno pole low, jak i high, a pole reprezentowane nie może być puste (zgodnie z definicjami powyżej). Jeśli widoczny obszar jest pusty, wystąpi błąd.

Na przykład ten widoczny obszar w pełni 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)

To pole jest wymagane. Najniższa pozycja widocznego obszaru.
high

object (LatLng)

To pole jest wymagane. Najwyższy punkt widocznego obszaru.

AddressMetadata

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

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

boolean

Wskazuje, że jest to adres firmy. Jeśli nie jest skonfigurowana, wskazuje, że wartość jest nieznana.
poBox

boolean

Wskazuje, że adres skrytki pocztowej. Jeśli nie jest skonfigurowana, wskazuje, że wartość jest nieznana.
residential

boolean

Wskazuje, że jest to adres miejsca zamieszkania. Jeśli nie jest skonfigurowana, wskazuje, że wartość jest nieznana.

UspsData

Dane USPS dotyczące adresu. Nie możemy zagwarantować, że pole uspsData będzie w pełni wypełnione dla każdego adresu w USA lub instytucji PR wysyłanego przez interfejs Address Verificationation API. Jeśli w odpowiedzi używasz pola uspsData, zalecamy zintegrowanie w odpowiedzi pól zapasowego adresu.

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)

Ujednolicony adres USPS.
deliveryPointCode

string

2-cyfrowy kod punktu dostawy
deliveryPointCheckDigit

string

Cyfra kontrolna punktu dostawy. Ten numer jest dodawany na końcu kodu delivery_point_barcode w przypadku e-maili zeskanowanych mechanicznie. Po dodaniu wszystkich cyfr w polach „delivery_point_barcode”, „deliveryPointCheckDigit” i „zip+4” powinna pojawić się liczba podzielona 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ć DPV podstawowego i dodatkowego numeru telefonu.
  • D: adres został potwierdzony tylko w DPV jako numer główny i brakowało dodatkowych informacji o numerze.
  • S: adres został potwierdzony tylko w DPV dla numeru głównego, a dodatkowe informacje dotyczące numeru były dostępne, ale nie zostały potwierdzone.
  • Y: potwierdzono DPV dla numerów głównych i dodatkowych.
  • Puste: jeśli odpowiedź nie zawiera wartości dpvConfirmation, adres nie został przesłany do potwierdzenia DPV.
dpvFootnote

string

Przypisy z weryfikacji punktu dostawy. W jednym ciągu może być połączonych wiele przypisów.

  • AA: adres wejściowy dopasowany do pliku ZIP+4
  • A1: adres wejściowy nie został dopasowany do pliku ZIP+4
  • BB: dopasowane do DPV (wszystkie komponenty)
  • CC: numer dodatkowy nie pasuje i nie jest wymagany
  • C1: numer dodatkowy nie pasuje, ale jest wymagany
  • N1: w wieżowcu brakuje dodatkowego numeru telefonu
  • M1: brak podstawowego numeru
  • M3: podstawowy numer jest nieprawidłowy
  • P1: brak numeru pola wpisywania adresu PO, RR lub HC
  • P3: wpisany adres PO, RR lub HC Box jest nieprawidłowy.
  • F1: wpisz adres zgodny z adresem wojskowym
  • G1: wpisz adres zgodny z ogólnym adresem dostawy
  • U1: wpisz adres zgodny z unikalnym kodem pocztowym
  • PB: adres wejściowy został dopasowany do rekordu PBSA
  • RR: adres potwierdzony przez firmę DPV z informacjami PMB
  • R1: potwierdzony adres przez DPV bez informacji PMB
  • R7: rekord trasy operatora R777 lub R779
  • IA: zidentyfikowano niedokładny adres
  • TA: numer podstawowy dopasowywany przez odrzucenie końcowej litery alfa
dpvCmra

string

Wskazuje, czy adres to CMRA (Commercial Mail Delivery Agency) – prywatna firma odbierająca pocztę w imieniu klientów. Zwraca pojedynczy znak.

  • Y: adres to CMRA.
  • N: adres nie należy do CMRA
dpvVacant

string

Czy to miejsce jest puste? Zwraca pojedynczy znak.

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

string

Czy jest to adres niedostępny w statystykach czy adres aktywny? Brak adresów statystycznych to adresy, na których nikt nie jest stale zajęty, lub adresy, których USPS nie obsługuje. Zwraca pojedynczy znak.

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

integer

Wskazuje typ NoStat. Zwraca kod przyczyny jako int.

  • 1: IDA (Internal Drop Address) – adresy, które nie otrzymują poczty bezpośrednio z USPS, ale są dostarczane na adres pocztowy, który służy do ich obsługi.
  • 2: CDS – adresy, których nie można jeszcze dostarczyć. Dotyczy to na przykład nowego podziału, w którym zostały określone numery i numery podstawowe, ale nie ma jeszcze struktury obłożenia.
  • 3: kolizja – adresy, których nie potwierdził DPV.
  • 4: CMZ (College, Militaria i inne typy) – kody ZIP + 4 rekordy USPS uwzględnione w danych.
  • 5: zwykłe – wskazuje, że adresy nie są dostarczane, a adresy nie są zaliczane do możliwych przesyłek.
  • 6: dodatkowy wymagany – adres wymaga podania dodatkowych informacji
dpvDrop

string

Flaga oznacza, że e-mail jest dostarczany do określonego odbiorcy w witrynie. Zwraca pojedynczy znak.

  • Y: poczta jest dostarczana do jednego odbioru w witrynie.
  • N: poczta nie jest dostarczana do jednego odbiorcy w witrynie.
dpvThrowback

string

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

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

string

Oznaczenie flagą oznacza, że poczta nie jest dostarczana codziennie. Zwraca pojedynczy znak.

  • Y: poczta nie jest dostarczana codziennie.
  • N: brak oznaczenia, że poczta jest dostarczana codziennie.
dpvNonDeliveryDaysValues

integer

Liczba całkowita określająca dni, w których dostawa nie jest realizowana. Można go przesłuchać za pomocą flag: 0x40 – niedziela jest dniem niedostawy 0x20 – poniedziałek jest dniem niedostawy 0x10 – wtorek oznacza dzień niedostawy 0x08 – środa oznacza dzień niedostawy 0x04 – czwartek jest dniem niedoręczenia 0x02 – piątek to dzień niedostawy 0x02
dpvNoSecureLocation

string

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

  • Y: przesyłka nie zostanie dostarczona ze względów bezpieczeństwa.
  • N: nie ma informacji, ż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ć do dostarczenia poczty. Zwraca pojedynczy znak.

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

string

Wskazuje, że dla danego adresu prawidłowy jest więcej niż 1 kod zwrotu DPV. Zwraca pojedynczy znak.

  • Y: potwierdzono DPV dla numerów głównych i dodatkowych.
  • N: nie udało się potwierdzić DPV podstawowego i dodatkowego numeru telefonu.
  • S: adres został potwierdzony tylko w DPV dla numeru podstawowego, a dodatkowe informacje o numerze były widoczne jako niepotwierdzone lub pominięto jedną końcową literę alfa na numerze podstawowym, aby uzyskać dopasowanie DPV i wymagane informacje dodatkowe.
  • D: adres został potwierdzony tylko w DPV jako numer główny i brakowało dodatkowych informacji o numerze.
  • R: adres potwierdzony, ale przypisany do trasy Phantom R777 i R779, przy czym nie podano adresu dostawy USPS.
carrierRoute

string

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

Prefiksy:

  • C: trasa przewoźnika (lub trasa miejska).
  • R: trasa wiejska
  • H: trasa umowy drogowej
  • B: sekcja skrytki pocztowej
  • G: ogólna jednostka dostawy
carrierRouteIndicator

string

Wskaźnik sortowania szybkości trasy przewoźnika.
ewsNoMatch

boolean

Adres dostawy można dopasować, ale plik EWS wskazuje, że wkrótce będzie dostępne dopasowanie ścisłe.
postOfficeCity

string

Główny urząd pocztowy.
postOfficeState

string

Główny stan urzędu pocztowego.
abbreviatedCity

string

Skrócona nazwa miasta.
fipsCountyCode

string

Kod kraju FIPS.
county

string

Nazwa hrabstwa.
elotNumber

string

Numer eLOT (ELOT).
elotFlag

string

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

boolean

Kod pocztowy obejmujący tylko skrytkę pocztową.
pmbDesignator

string

Oznaczenie jednostki PMB (Private Mail Box).
pmbNumber

string

numer PMB (Private Mail Box);
addressRecordType

string

Typ rekordu adresu pasującego do wpisanego adresu.

  • F: FIRMA. Jest to dopasowanie z rejestrem firmowym, czyli najwyższym poziomem dopasowania dla danego adresu.
  • G: DOSTAWA OGÓLNA. Jest zgodny z rekordem dostawy ogólnej.
  • H: BUDOWANIE / MIEJSCE. Ta wartość pasuje do wpisu dotyczącego budynku lub mieszkania.
  • P: Skrytka pocztowa. Ta skrytka pasuje do skrytki pocztowej.
  • R: TRASY WIELSKOWA lub UMOWA WYSZUKIWANIA: dopasowanie do rekordu drogi na terenie wiejskim lub umowy drogowej. Oba te warunki mogą mieć powiązane zakresy numerów pól.
  • S: REKORD STREET: dopasowanie do wpisu o ulicy zawierającego prawidłowy podstawowy zakres liczbowy.
defaultAddress

boolean

Wskaźnik informujący, że został znaleziony adres domyślny, ale istnieją bardziej szczegółowe adresy.
errorMessage

string

Komunikat o błędzie pobierania danych przez USPS. Ta wartość jest wypełniana, gdy przetwarzanie USPS zostaje zawieszone z powodu wykrywania sztucznie utworzonych adresów.

Gdy występuje ten błąd, pola danych USPS mogą nie być wypełnione.
cassProcessed

boolean

Wskaźnik, że żądanie zostało przetworzone CASS.

UspsAddress

Reprezentacja adresu w Stanach Zjednoczonych przez USPS.

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

4-cyfrowe rozszerzenie kodu pocztowego, np. 5023.