- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- PostalAddress
- LanguageOptions
- ValidationResult
- Efekt
- Szczegółowość
- Adres
- AddressComponent
- ComponentName
- ConfirmationLevel
- Geokod
- LatLng
- PlusCode
- Widoczny obszar
- AddressMetadata
- UspsData
- UspsAddress
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 ( |
Pola | |
---|---|
address |
To pole jest wymagane. Sprawdzany adres. Niesformatowane adresy należy przesyłać za pomocą parametru Całkowita długość pól w tych danych nie może przekraczać 280 znaków. Listę obsługiwanych regionów znajdziesz tutaj. Wartość Interfejs Address Verification API ignoruje wartości w |
previousResponseId |
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ą |
enableUspsCass |
Włącza tryb zgodności USPS CASS. Ma to wpływ tylko na pole Zalecamy użycie komponentu |
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 |
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 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 ( |
Pola | |
---|---|
result |
Wynik weryfikacji adresu. |
responseId |
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 |
Wersja schematu obiektu |
regionCode |
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 |
languageCode |
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 |
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 |
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 |
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 |
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 |
Opcjonalnie. Dzielnica adresu. Mogą to być np. dzielnice, dystrykty, dystrykty. |
addressLines[] |
To pole jest wymagane. Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu. |
recipients[] |
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 |
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 |
Podgląd: zwróć urządzenie |
ValidationResult
Wynik weryfikacji adresu.
Zapis JSON |
---|
{ "verdict": { object ( |
Pola | |
---|---|
verdict |
Flagi oceny ogólnej |
address |
Informacje o adresie, a nie o geokodzie. |
geocode |
Informacje o lokalizacji i miejscu, do którego został przekodowany adres. |
metadata |
Inne informacje istotne z punktu widzenia dostawy. Nie ma gwarancji, że pole |
uspsData |
Dodatkowe oznaczenia dotyczące dostawy są dostarczane przez USPS. Podano tylko w regionach |
englishLatinAddress |
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 Uwaga: pole |
Wynik
Ogólny przegląd wyniku weryfikacji adresu i kodu geograficznego.
Zapis JSON |
---|
{ "inputGranularity": enum ( |
Pola | |
---|---|
inputGranularity |
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 Jeśli na przykład podany adres zawiera konkretny numer mieszkania, w polu |
validationGranularity |
Poziom szczegółowości, na którym interfejs API może w pełni validate adres. Na przykład wartość Wynik weryfikacji komponentu według adresu można znaleźć w pliku |
geocodeGranularity |
Informacje o szczegółowości Czasem może się różnić od wartości |
addressComplete |
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 |
hasUnconfirmedComponents |
Co najmniej 1 komponentu adresu nie można skategoryzować ani zweryfikować. Więcej informacji znajdziesz na stronie |
hasInferredComponents |
Wywnioskowano (dodano) co najmniej 1 komponent adresu, którego nie było w danych wejściowych. Szczegółowe informacje znajdziesz na stronie |
hasReplacedComponents |
Zastąpiono co najmniej jeden komponent adresu. Szczegółowe informacje znajdziesz na stronie |
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 ( |
Pola | |
---|---|
formattedAddress |
Przetworzony adres w postaci adresu jednowierszowego zgodny z regułami formatowania adresu obowiązującymi w regionie, w którym znajduje się adres. |
postalAddress |
Adres po przetworzeniu danych, który jest widoczny jako adres pocztowy. |
addressComponents[] |
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[] |
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 |
unconfirmedComponentTypes[] |
Typy komponentów obecnych w polu |
unresolvedTokens[] |
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: |
AddressComponent
Reprezentuje komponent adresu, na przykład ulicę, miasto lub stan.
Zapis JSON |
---|
{ "componentName": { object ( |
Pola | |
---|---|
componentName |
Nazwa tego komponentu. |
componentType |
Typ komponentu adresu. Listę możliwych typów znajdziesz w tabeli 2. Dodatkowe typy zwracanych przez usługę Miejsca. |
confirmationLevel |
Wskazuje poziom pewności, że komponent jest prawidłowy. |
inferred |
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 |
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 |
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 |
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 |
Tekst nazwy. Na przykład „Piąta Aleja” dla nazwy ulicy lub „1253” dla numeru budynku. |
languageCode |
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 ( |
Pola | |
---|---|
location |
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 |
Kod plus odpowiadający kontu |
bounds |
Granice miejsca geokodowanego. |
featureSizeMeters |
Wielkość miejsca geokodowanego (w metrach). Jest to kolejna miara przybliżenia geokodowanej lokalizacji, ale jej rozmiaru fizycznego, a nie semantycznego. |
placeId |
Identyfikator miejsca miejsca, do którego dane geograficzne są przesyłane. Więcej informacji na temat identyfikatorów miejsc znajdziesz tutaj. |
placeTypes[] |
Typy miejsc, na które dane wejściowe zostały przekształcone geograficznie. Na przykład: |
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 |
Szerokość geograficzna w stopniach. Musi mieścić się w zakresie [-90,0; +90,0]. |
longitude |
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 |
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 |
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 ( |
Pola | |
---|---|
low |
To pole jest wymagane. Najniższa pozycja widocznego obszaru. |
high |
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 |
Wskazuje, że jest to adres firmy. Jeśli nie jest skonfigurowana, wskazuje, że wartość jest nieznana. |
poBox |
Wskazuje, że adres skrytki pocztowej. Jeśli nie jest skonfigurowana, wskazuje, że wartość jest nieznana. |
residential |
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 ( |
Pola | |
---|---|
standardizedAddress |
Ujednolicony adres USPS. |
deliveryPointCode |
2-cyfrowy kod punktu dostawy |
deliveryPointCheckDigit |
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 |
Możliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak lub nie zwraca żadnej wartości.
|
dpvFootnote |
Przypisy z weryfikacji punktu dostawy. W jednym ciągu może być połączonych wiele przypisów.
|
dpvCmra |
Wskazuje, czy adres to CMRA (Commercial Mail Delivery Agency) – prywatna firma odbierająca pocztę w imieniu klientów. Zwraca pojedynczy znak.
|
dpvVacant |
Czy to miejsce jest puste? Zwraca pojedynczy znak.
|
dpvNoStat |
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.
|
dpvNoStatReasonCode |
Wskazuje typ NoStat. Zwraca kod przyczyny jako int.
|
dpvDrop |
Flaga oznacza, że e-mail jest dostarczany do określonego odbiorcy w witrynie. Zwraca pojedynczy znak.
|
dpvThrowback |
Wskazuje, że poczta nie jest dostarczana na adres. Zwraca pojedynczy znak.
|
dpvNonDeliveryDays |
Oznaczenie flagą oznacza, że poczta nie jest dostarczana codziennie. Zwraca pojedynczy znak.
|
dpvNonDeliveryDaysValues |
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 |
Flaga oznacza, że drzwi są dostępne, ale ze względów bezpieczeństwa przesyłka nie zostanie pozostawiona. Zwraca pojedynczy znak.
|
dpvPbsa |
Wskazuje, że adres został dopasowany do rekordu PBSA. Zwraca pojedynczy znak.
|
dpvDoorNotAccessible |
Flaga wskazuje adresy, pod którymi USPS nie może zapukać do dostarczenia poczty. Zwraca pojedynczy znak.
|
dpvEnhancedDeliveryCode |
Wskazuje, że dla danego adresu prawidłowy jest więcej niż 1 kod zwrotu DPV. Zwraca pojedynczy znak.
|
carrierRoute |
Kod trasy przewoźnika. Czteroznakowy kod składający się z jednoliterowego prefiksu i 3-cyfrowego oznaczenia trasy. Prefiksy:
|
carrierRouteIndicator |
Wskaźnik sortowania szybkości trasy przewoźnika. |
ewsNoMatch |
Adres dostawy można dopasować, ale plik EWS wskazuje, że wkrótce będzie dostępne dopasowanie ścisłe. |
postOfficeCity |
Główny urząd pocztowy. |
postOfficeState |
Główny stan urzędu pocztowego. |
abbreviatedCity |
Skrócona nazwa miasta. |
fipsCountyCode |
Kod kraju FIPS. |
county |
Nazwa hrabstwa. |
elotNumber |
Numer eLOT (ELOT). |
elotFlag |
eLOT rosnąco/malejąco (A/D). |
lacsLinkReturnCode |
Kod zwrotny LACSLink. |
lacsLinkIndicator |
Wskaźnik LACSLink. |
poBoxOnlyPostalCode |
Kod pocztowy obejmujący tylko skrytkę pocztową. |
suitelinkFootnote |
Przypisy od pasującego rekordu ulicy lub wieżowca do informacji o budynku. Jeśli nazwa firmy zostanie znaleziona, zostanie zwrócony numer dodatkowy.
|
pmbDesignator |
Oznaczenie jednostki PMB (Private Mail Box). |
pmbNumber |
numer PMB (Private Mail Box); |
addressRecordType |
Typ rekordu adresu pasującego do wpisanego adresu.
|
defaultAddress |
Wskaźnik informujący, że został znaleziony adres domyślny, ale istnieją bardziej szczegółowe adresy. |
errorMessage |
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 |
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 |
Pierwszy wiersz adresu. |
firm |
Nazwa firmy. |
secondAddressLine |
Drugi wiersz adresu. |
urbanization |
Portorykańska nazwa urbanizacji. |
cityStateZipAddressLine |
Miasto + województwo + kod pocztowy. |
city |
Nazwa miasta. |
state |
Dwuliterowy kod stanu. |
zipCode |
Kod pocztowy, np. 10009. |
zipCodeExtension |
4-cyfrowe rozszerzenie kodu pocztowego, np. 5023. |