Package google.maps.addressvalidation.v1

Indeks

AddressValidation

Usługa weryfikacji adresów.

ProvideValidationFeedback

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

Informacje o wyniku sekwencji prób weryfikacji. To powinno być ostatnie wywołanie po sekwencji wywołań weryfikujących ten sam adres. Wywołanie to powinno nastąpić po zakończeniu transakcji. Należy go wysłać tylko raz w przypadku sekwencji ValidateAddress żądań potrzebnych do pełnej weryfikacji adresu.

ValidateAddress

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

Sprawdzanie poprawności adresu.

Adres

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

Pola
formatted_address

string

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

Uwaga: format tego adresu może być inny niż format adresu w polu postal_address. Na przykład postal_address zawsze reprezentuje kraj jako 2-literowy region_code, np. „US” lub „NZ”. W tym polu używa się dłuższej formy nazwy kraju, np. „USA” lub „Nowa Zelandia”.

postal_address

PostalAddress

Adres po przetworzeniu w postaci adresu pocztowego.

address_components[]

AddressComponent

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

Elementy adresu nie są uporządkowane w określony sposób. Nie należy zakładać kolejności elementów adresu na liście.

missing_component_types[]

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 sekcjach formatted_address, postal_address ani address_components. 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.

unconfirmed_component_types[]

string

Typy komponentów obecnych w address_components, których poprawności nie udało się potwierdzić. To pole jest dostępne dla wygody użytkowników. Jego zawartość jest równoważna z przeszukiwaniem address_components w celu znalezienia typów wszystkich komponentów, w których confirmation_level nie jest CONFIRMED lub flaga inferred nie jest ustawiona na true. Listę możliwych typów znajdziesz tutaj.

unresolved_tokens[]

string

Wszystkie tokeny w danych wejściowych, których nie udało się rozwiązać. Możliwe, że wpisana wartość nie została rozpoznana jako prawidłowa część adresu. Na przykład w przypadku danych wejściowych takich jak „Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US” nierozwiązane tokeny mogą wyglądać tak: ["Parcel", "0000123123", "&", "0000456456"].

AddressComponent

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

Pola
component_name

ComponentName

Nazwa tego komponentu.

component_type

string

Typ elementu adresu. Listę dostępnych typów znajdziesz w tabeli 2: Dodatkowe typy zwracane przez usługę Miejsca.

confirmation_level

ConfirmationLevel

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

inferred

bool

Wskazuje, że element nie był częścią danych wejściowych, ale udało nam się go odgadnąć na podstawie lokalizacji adresu i uważamy, że powinien być podany w ramach pełnego adresu.

spell_corrected

bool

Wskazuje poprawkę do nieprawidłowego zapisu nazwy 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 też oznacza błędy w pisownię, np. gdy zmienisz „Amphitheater Pkwy” na „Amphitheatre Pkwy”.

replaced

bool

Wskazuje, że nazwa komponentu została zastąpiona zupełnie inną nazwą, np. nieprawidłowy kod pocztowy został zastąpiony kodem właściwym dla adresu. To nie jest zmiana kosmetyczna, ponieważ komponent wejściowy został zastąpiony innym.

unexpected

bool

Wskazuje element adresu, który nie powinien występować w adresie pocztowym w danym regionie. Zachowaliśmy go tylko dlatego, że był częścią danych wejściowych.

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ć obecności tego komponentu, ale jest prawdopodobne, że 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. Może to być na przykład dzielnica, która nie pasuje do reszty adresu.

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.

Pola
business

bool

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

po_box

bool

Wskazuje, że adres jest adresem skrytki pocztowej. Jeśli nie jest ustawiona, oznacza, że wartość jest nieznana.

residential

bool

Wskazuje, że jest to adres zamieszkania. Jeśli nie jest ustawiona, oznacza, że wartość jest nieznana.

NazwaKomponentu

Otoczka dla nazwy komponentu.

Pola
text

string

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

language_code

string

Kod języka BCP-47. Nie będzie ona widoczna, jeśli nazwa komponentu nie jest powiązana z językiem, np. numer domu.

Geokodowanie

Zawiera informacje o miejscu, do którego został zgeokodowany podany tekst.

Pola
location

LatLng

Geokodowana lokalizacja danych wejściowych.

Zalecamy używanie identyfikatorów miejsc zamiast adresów, współrzędnych geograficznych czy kodów Plus Code. 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. Droga może nie prowadzić szybko ani bezpiecznie do miejsca docelowego i może nie znajdować się w pobliżu punktu dostępu do obiektu. Ponadto w przypadku odwrotnego kodowania geograficznego nie ma gwarancji, że zwrócony adres będzie zgodny z pierwotnym.

plus_code

PlusCode

Plus Code odpowiadający location.

bounds

Viewport

Granice miejsca powiązanego z danymi geograficznymi.

feature_size_meters

float

Wielkość zgeokodowanego miejsca w metrach. Jest to kolejny wskaźnik dokładności zgeokodowanej lokalizacji, ale w przypadku rozmiaru fizycznego, a nie znaczenia semantycznego.

place_id

string

Identyfikator miejsca, do którego ten geokodowany przez ten input adres.

Więcej informacji o identyfikatorach miejsc znajdziesz tutaj.

place_types[]

string

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

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 i funkcjach 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.

Umożliwia interfejsowi Address Validation API uwzględnienie dodatkowych informacji w odpowiedzi.

Pola
return_english_latin_address

bool

Podgląd: zwraca google.maps.addressvalidation.v1.Address w języku angielskim. Więcej informacji znajdziesz w artykule google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

PlusCode

Kod Plus Code (http://plus.codes) to odniesienie do lokalizacji w 2 formatach: kod globalny określający prostokąt o wymiarach 14 × 14 m (1/8000 stopnia) lub mniejszy oraz kod złożony, który zastępuje prefiks lokalizacją odniesienia.

Pola
global_code

string

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

compound_code

string

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

ProvideValidationFeedbackRequest

Prośba o przesłanie opinii weryfikacyjnej.

Pola
conclusion

ValidationConclusion

Wymagane. Wynik sekwencji prób weryfikacji.

Jeśli to pole ma wartość VALIDATION_CONCLUSION_UNSPECIFIED, zwracany jest błąd INVALID_ARGUMENT.

response_id

string

Wymagane. Identyfikator odpowiedzi, której dotyczy opinia. Powinien to być parametr [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] z pierwszej odpowiedzi w serii prób weryfikacji adresu.

Podsumowanie weryfikacji

Możliwe końcowe wyniki sekwencji żądań weryfikacji adresu potrzebnych do zweryfikowania adresu.

Wartości w polu enum
VALIDATION_CONCLUSION_UNSPECIFIED Ta wartość nie jest używana. Jeśli pole ProvideValidationFeedbackRequest.conclusion ma wartość VALIDATION_CONCLUSION_UNSPECIFIED, zwracany jest błąd INVALID_ARGUMENT.
VALIDATED_VERSION_USED Wersja adresu zwrócona przez interfejs Address Validation API została użyta do transakcji.
USER_VERSION_USED Wersja adresu podana przez użytkownika, która została użyta do zrealizowania transakcji
UNVALIDATED_VERSION_USED W transakcji użyto wersji adresu, która została wpisana po ostatnim udanym sprawdzeniu, ale nie została ponownie zweryfikowana.
UNUSED Transakcja została przerwana, a adres nie został użyty.

ProvideValidationFeedbackResponse

Ten typ nie ma pól.

Odpowiedź na opinię weryfikacyjną.

Jeśli opinia została przesłana, odpowiedź jest pusta.

UspsAddress

Adres w Stanach Zjednoczonych według USPS.

Pola
first_address_line

string

Pierwszy wiersz adresu.

firm

string

Nazwa firmy.

second_address_line

string

Drugi wiersz adresu.

urbanization

string

Nazwa portorykańskiej aglomeracji miejskiej.

city_state_zip_address_line

string

Miasto, województwo + kod pocztowy.

city

string

Nazwa miasta.

state

string

2-literowy kod stanu.

zip_code

string

Kod pocztowy, np. 10009.

zip_code_extension

string

4-cyfrowy kod pocztowy, np. 5023.

UspsData

Dane USPS dla adresu. Nie można zagwarantować, że parametr uspsData będzie w pełni wypełniony w przypadku każdego adresu w Stanach Zjednoczonych lub Portoryko wysłanego do interfejsu Address Validation API. Jeśli w odpowiedzi używasz danych uspsData jako głównej części odpowiedzi, zalecamy zintegrowanie pól adresu zapasowego.

Pola
standardized_address

UspsAddress

Znormalizowany adres USPS.

delivery_point_code

string

2-cyfrowy kod punktu dostawy

delivery_point_check_digit

string

Cyfra kontrolna punktu dostawy. Ta liczba jest dodawana na końcu kodu kreskowego delivery_point_barcode w przypadku skanowania poczty w sposób automatyczny. Dodanie wszystkich cyfr z delivery_point_barcode, delivery_point_check_digit, postal_code i ZIP+4 powinno dać liczbę podzielną przez 10.

dpv_confirmation

string

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

  • N: nie udało się potwierdzić informacji o numerze głównym ani dodatkowym za pomocą DPV.
  • D: adres został potwierdzony w DPV tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były niekompletne.
  • S: adres został potwierdzony w usłudze DPV tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były dostępne, ale nie zostały potwierdzone.
  • Y: adres został potwierdzony przez dostawcę usług w przypadku numeru głównego i dodatkowych numerów.
  • Pusty: jeśli odpowiedź nie zawiera wartości dpv_confirmation, adres nie został przesłany do potwierdzenia przez dostawcę.
dpv_footnote

string

Uwagi dotyczące weryfikacji punktu dostawy. W tym samym ciągu 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 został znaleziony, ale jest wymagany
  • N1: brak numeru dodatkowego w adresie budynku
  • 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: podany adres jest zgodny z adresem wojskowym
  • G1: adres podany przez użytkownika jest zgodny z adresem dostawy ogólnym
  • U1: adres wejściowy dopasowany do unikalnego kodu pocztowego
  • PB: adres wejściowy dopasowany do rekordu PBSA
  • RR: adres potwierdzony przez DPV z informacjami z PMB
  • R1: adres potwierdzony w DPV bez informacji z PMB
  • R7: rekord trasy R777 lub R779 operatora
  • IA: zidentyfikowano adres e-mail osoby, która została poinformowana
  • TA: numer główny dopasowany przez odrzucenie ostatniej litery alfabetu
dpv_cmra

string

Wskazuje, czy adres jest CMRA (Commercial Mail Receiving Agency) – prywatną firmą odbierającą pocztę dla klientów. Zwraca pojedynczy znak.

  • Y: adres jest adresem CMRA
  • N: adres nie jest adresem CMRA
dpv_vacant

string

Czy to miejsce jest puste? Zwraca pojedynczy znak.

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

string

Czy to adres bez statystyk czy aktywny? Adresy bez statystyk to adresy, które nie są stale zajęte lub adresy, których USPS nie obsługuje. Zwraca pojedynczy znak.

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

int32

Wskazuje typ NoStat. Zwraca kod przyczyny jako int.

  • 1: IDA (Internal Drop Address) – adresy, na które nie są wysyłane przesyłki bezpośrednio z USPS, ale są dostarczane na adresy dostawy, które je obsługują.
  • 2: CDS – adresy, które nie są jeszcze dostępne do dostarczenia. Może to być na przykład nowy podział, w którym określono już działki i numery główne, ale nie ma jeszcze struktury dla zamieszkania.
  • 3: kolizja – adresy, które w rzeczywistości nie są potwierdzone przez DPV.
  • 4: CMZ (uczelnie, wojsko i inne typy) – kody pocztowe i 4 rekordy USPS uwzględnione w danych.
  • 5: Regular – wskazuje adresy, na które nie dotarła przesyłka. Adresy te nie są liczone jako możliwe dostawy.
  • 6: wymagane informacje dodatkowe – adres wymaga dodatkowych informacji.
dpv_drop

string

Flaga wskazuje, że wiadomość została dostarczona do jednego urządzenia na stronie. Zwraca pojedynczy znak.

  • Y: poczta jest dostarczana do jednego adresata w witrynie.
  • N: poczta nie jest dostarczana do jednego miejsca odbioru w witrynie.
dpv_throwback

string

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

  • Y: poczta nie jest dostarczana na adres ulicy.
  • N: przesyłka jest dostarczana na adres do korespondencji.
dpv_non_delivery_days

string

Flaga wskazuje, że dostawa poczty nie jest realizowana w każdy dzień tygodnia. Zwraca pojedynczy znak.

  • Y: dostawa poczty nie odbywa się codziennie.
  • N: brak informacji o tym, że dostawa poczty nie jest realizowana codziennie.
dpv_non_delivery_days_values

int32

Liczba całkowita określająca dni niedostarczenia. Można go przeszukiwać za pomocą flag bitowych: 0x40 – niedziela jest dniem bez dostawy 0x20 – poniedziałek jest dniem bez dostawy 0x10 – wtorek jest dniem bez dostawy 0x08 – środa jest dniem bez dostawy 0x04 – czwartek jest dniem bez dostawy 0x02 – piątek jest dniem bez dostawy 0x01 – sobota jest dniem bez dostawy

dpv_no_secure_location

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 paczka nie zostanie pozostawiona.
  • N: brak informacji o tym, że paczka nie zostanie pozostawiona ze względów bezpieczeństwa.
dpv_pbsa

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

string

Flaga wskazuje adresy, pod którymi USPS nie może zapukać do drzwi, aby dostarczyć przesyłkę. Zwraca pojedynczy znak.

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

string

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

  • Y: adres został potwierdzony przez dostawcę usług w przypadku numeru głównego i dodatkowych numerów.
  • N: nie udało się potwierdzić informacji o numerze głównym ani dodatkowym za pomocą usługi DPV.
  • S: adres został potwierdzony w ramach weryfikacji danych osobowych tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były obecne, ale nie zostały potwierdzone. Albo też w numerze głównym usunięto jedną literę, aby dopasować dane osobowe i wymagane informacje dodatkowe.
  • D: adres został potwierdzony przez dostawcę tylko w przypadku numeru głównego, a informacje o numerze dodatkowym były niekompletne.
  • R: adres został potwierdzony, ale został przypisany do fikcyjnej trasy R777 i R779, a usługa USPS nie została wybrana.
carrier_route

string

Kod trasy przewoźnika. Czterozyłowy kod składający się z jednoliterowego prefiksu i trzycyfrowego wskaźnika trasy.

Prefiksy:

  • C: trasa przewoźnika (lub trasa miejska).
  • R: trasa wiejska
  • H: trasa zakontraktowana na autostradę
  • B: sekcja skrzynki pocztowej
  • G: ogólna jednostka dostawy
carrier_route_indicator

string

Wskaźnik sortowania stawki przewoźnika.

ews_no_match

bool

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

post_office_city

string

Główny urząd pocztowy w mieście.

post_office_state

string

Stan głównego urzędu pocztowego.

abbreviated_city

string

Skrót nazwy miasta.

fips_county_code

string

Kod FIPS hrabstwa.

county

string

Nazwa powiatu.

elot_number

string

Numer rozszerzonej linii podróży (eLOT).

elot_flag

string

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

po_box_only_postal_code

bool

Kod pocztowy tylko dla skrzynki pocztowej.

pmb_designator

string

PMB (Private Mail Box) – identyfikator jednostki.

pmb_number

string

Numer PMB (Private Mail Box);

address_record_type

string

Typ rekordu adresu pasującego do adresu wejściowego.

  • F: FIRMA. Jest to dopasowanie do rekordu firmy, czyli najlepszego możliwego poziomu dopasowania dla adresu.
  • G: OGÓLNA DOSTAWA. Jest to dopasowanie do rekordu ogólnego.
  • H: BUDYNKI / MIESZKANIA. Dopasowanie do rekordu budynku lub mieszkania.
  • P: Skrzynka pocztowa. Pasuje do skrzynki pocztowej.
  • R: TRASA RUCHOWA lub UMOWA DROGA: dopasowanie do rekordu drogi wiejskiej lub umowy drogowej, które mogą mieć powiązane zakresy numerów skrzynek.
  • S: RECORD STREET: to dopasowanie do rekordu ulicy zawierającego prawidłowy podstawowy zakres numerów.
default_address

bool

Wskaźnik, że znaleziono adres domyślny, ale istnieją bardziej szczegółowe adresy.

error_message

string

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

W przypadku wystąpienia tego błędu pola danych USPS mogą nie zostać wypełnione.

cass_processed

bool

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

ValidateAddressRequest

Prośba o weryfikację adresu.

Pola
address

PostalAddress

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

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

Obsługiwane regiony znajdziesz tutaj.

Wartość language_code w adresie wejściowym jest zarezerwowana na przyszłość i jest ignorowana. Walidowany adres zostanie wypełniony na podstawie preferowanego języka danego adresu, jak to zostało zidentyfikowane przez system.

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

previous_response_id

string

W przypadku pierwszego żądania weryfikacji adresu to pole musi być puste. Jeśli do pełnej weryfikacji jednego adresu potrzebne jest więcej żądań (np. jeśli zmiany wprowadzone przez użytkownika po początkowej weryfikacji wymagają ponownej weryfikacji), to w każdym kolejnym żądaniu należy wypełnić to pole wartością response_id z pierwszej odpowiedzi w sekwencji weryfikacji.

enable_usps_cass

bool

Włącza tryb zgodny z USPS CASS. Dotyczy to tylko pola google.maps.addressvalidation.v1.ValidationResult.usps_data w elementach google.maps.addressvalidation.v1.ValidationResult. Uwaga: w przypadku żądań USPS CASS w przypadku adresów w Portoryko pole google.type.PostalAddress.region_code funkcji 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 komponentu address lub podanie co najmniej 2 wartości google.type.PostalAddress.address_lines, z których pierwsza zawiera numer i nazwę ulicy, a druga – miasto, województwo i kod pocztowy.

language_options

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

Umożliwia interfejsowi Address Validation API uwzględnienie dodatkowych informacji w odpowiedzi.

session_token

string

Opcjonalnie: Ciąg tekstowy identyfikujący sesję automatycznego uzupełniania na potrzeby rozliczeń. Musi być bezpiecznym ciągiem znaków w formacie base64, który może zawierać maksymalnie 36 znaków ASCII. W przeciwnym razie zwracany jest błąd DOCUMENT_AR.

Sesja rozpoczyna się, gdy użytkownik wysyła zapytanie do funkcji autouzupełniania, a kończy, gdy wybierze miejsce i wywoła funkcję Szczegóły miejsca lub Weryfikacja adresu. Każda sesja może zawierać wiele zapytań autouzupełniania, po których następuje jedno żądanie Szczegółów miejsca lub weryfikacji adresu. Identyfikatory zastosowane do każdego żądania w ramach sesji muszą należeć do tego samego projektu w Google Cloud Console. 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 jeśli token sesji zostanie użyty ponownie, sesja zostanie obciążona tak, jakby nie podano tokena sesji (za każde żądanie naliczana jest opłata).

Uwaga: weryfikacji adresu można używać tylko w sesjach z interfejsem Autocomplete API (New), a nie Autocomplete API. Więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/session-pricing.

ValidateAddressResponse

Odpowiedź na prośbę o weryfikację adresu.

Pola
result

ValidationResult

Wynik weryfikacji adresu.

response_id

string

Identyfikator UUID, który identyfikuje tę odpowiedź. Jeśli adres wymaga ponownej weryfikacji, ten identyfikator UUID musi zostać dołączony do nowej prośby.

ValidationResult

Wynik weryfikacji adresu.

Pola
verdict

Verdict

Flagi ogólnej oceny

address

Address

Informacje o samym adresie, a nie o jego geokodze.

geocode

Geocode

Informacje o lokalizacji i miejscu, do których został zakodowany adres.

metadata

AddressMetadata

inne informacje istotne dla skuteczności przesyłania. Nie można mieć pewności, że parametr metadata będzie w pełni wypełniony w przypadku każdego adresu wysłanego do interfejsu Address Validation API.

usps_data

UspsData

Dodatkowe flagi dostawy dostarczane przez USPS. Dostępne tylko w regionach US i PR.

english_latin_address

Address

Wersja testowa: 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 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 język angielski.

Przetłumaczone adresy nie mogą być ponownie używane jako dane wejściowe API. Usługa udostępnia je, aby użytkownik mógł potwierdzić lub zaprzeczyć weryfikacji pierwotnie podanego adresu w jego ojczystym języku.

Jeśli część adresu nie ma tłumaczenia na język angielski, usługa zwraca tę część w innym języku, który używa alfabetu łacińskiego. Wyjaśnienie wyboru języka alternatywnego znajdziesz tutaj. Jeśli część adresu nie ma tłumaczenia ani transliteracji w języku korzystającym z alfabetu łacińskiego, usługa zwraca tę część w języku lokalnym powiązanym z adresem.

Aby włączyć to wyjście, użyj parametru google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

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

Wynik

Ogólne omówienie wyniku weryfikacji adresu i geokodu.

Pola
input_granularity

Granularity

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

Jeśli na przykład adres wejściowy zawiera konkretny numer mieszkania, wartość input_granularity będzie miała postać SUB_PREMISE. Jeśli nie uda nam się dopasować numeru mieszkania w bazach danych lub jeśli numer mieszkania jest nieprawidłowy, wartość validation_granularity będzie prawdopodobnie równa PREMISE lub mniejsza.

validation_granularity

Granularity

Poziom szczegółowości, na którym interfejs API może w pełni weryfikować adres. Na przykład validation_granularity PREMISE wskazuje, że można sprawdzić wszystkie elementy adresu na poziomie PREMISE lub bardziej ogólnym.

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

geocode_granularity

Granularity

Informacje o szczegółowości geocode. Może to być rozumiane jako semantyczne znaczenie tego, jak ogólna lub szczegółowa jest zgeokodowana lokalizacja.

Czasami może się on różnić od podanego powyżej validation_granularity. 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 validation_granularity będzie równe SUB_PREMISE, a geocode_granularity będzie równe PREMISE.

address_complete

bool

Adres jest uznawany za pełny, jeśli nie ma nierozstrzygniętych tokenów ani niespodziewanych lub brakujących komponentów adresu. Jeśli nie zostanie ustawiony, oznacza to, że wartość to false. Więcej informacji znajdziesz w polach missing_component_types, unresolved_tokens lub unexpected.

has_unconfirmed_components

bool

Co najmniej jednego elementu adresu nie można zaklasyfikować ani zweryfikować. Szczegółowe informacje znajdziesz w dokumentacji google.maps.addressvalidation.v1.Address.address_components.

has_inferred_components

bool

W przypadku co najmniej jednego elementu adresu została wywnioskowana (dodana) informacja, która nie była podana w danych wejściowych. Szczegółowe informacje znajdziesz w dokumentacji google.maps.addressvalidation.v1.Address.address_components.

has_replaced_components

bool

Zmieniono co najmniej 1 element adresu. Szczegółowe informacje znajdziesz w sekcji google.maps.addressvalidation.v1.Address.address_components.

Szczegółowość

Różne poziomy szczegółowości, jakie może mieć adres lub kod geograficzny. Gdy są używane do określenia dokładności adresu, wskazują, z jaką dokładnością adres wskazuje miejsce docelowe przesyłki. Na przykład adres „123 Main Street, Redwood City, CA, 94061” wskazuje na PREMISE, a „Redwood City, CA, 94061” na LOCALITY. Jeśli jednak nie uda nam się znaleźć geokodu dla adresu „123 Main Street” w Redwood City, 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 znajdujący się poniżej poziomu budynku, np. mieszkanie.
PREMISE Wynik na poziomie budynku.
PREMISE_PROXIMITY geokod, który w przybliżeniu określa lokalizację adresu na poziomie budynku.
BLOCK Adres lub geokod wskazują blok. Używany tylko w regionach, w których adresowanie odbywa się 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.