Address Validation

AddressValidation

google.maps.addressValidation.AddressValidation zajęcia

Klasa statyczna umożliwiająca dostęp do interfejsów API AddressValidation.

Aby uzyskać dostęp, zadzwoń pod numer const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

fetchAddressValidation
fetchAddressValidation(request)
Parametry: 
Wartość zwracana:  Promise<AddressValidation>
address
Typ:  Address optional
Informacje o samym adresie, a nie o kodzie geograficznym.
geocode
Typ:  Geocode optional
Informacje o lokalizacji i miejscu, do których został przypisany kod geograficzny adresu.
metadata
Typ:  AddressMetadata optional
Inne informacje dotyczące dostarczalności. Nie ma gwarancji, że pole metadata będzie w pełni wypełnione w przypadku każdego adresu wysłanego do interfejsu Address Validation API.
responseId
Typ:  string optional
Identyfikator UUID, który identyfikuje tę odpowiedź. Jeśli adres wymaga ponownej weryfikacji, do nowej prośby musi być dołączony ten identyfikator UUID.
uspsData
Typ:  USPSData optional
Dodatkowe flagi dostarczalności dostarczane przez USPS. Dostępne tylko w regionach US i PR.
verdict
Typ:  Verdict optional
Flagi ogólnej oceny
toJSON
toJSON()
Parametry: brak
Wartość zwracana:  Object
Konwertuje klasę AddressValidation na obiekt JSON o tych samych właściwościach.

AddressValidationRequest interface

Interfejs google.maps.addressValidation.AddressValidationRequest

Interfejs żądania dla: AddressValidation.fetchAddressValidation.

address
Adres, który jest weryfikowany. Niesformatowane adresy należy przesyłać za pomocą atrybutu PostalAddress.addressLines.
placeAutocompleteElement optional
Typ:  PlaceAutocompleteElement optional
Jeśli używasz elementu PlaceAutocompleteElement, dołącz go tutaj, aby połączyć wywołania interfejsu AddressValidation API z tokenem sesji autouzupełniania.
previousResponseId optional
Typ:  string optional
To pole nie może być ustawione w przypadku pierwszej prośby o weryfikację adresu. Jeśli do pełnej weryfikacji pojedynczego adresu konieczne jest wysłanie większej liczby żądań (np. jeśli zmiany wprowadzone przez użytkownika po początkowej weryfikacji muszą zostać ponownie zweryfikowane), każde kolejne żądanie musi zawierać w tym polu wartość AddressValidation.responseId z pierwszej odpowiedzi w sekwencji weryfikacji.
sessionToken optional
Typ:  AutocompleteSessionToken optional
Token, który identyfikuje sesję autouzupełniania do celów rozliczeniowych.
uspsCASSEnabled optional
Typ:  boolean optional
Włącza tryb zgodny z USPS CASS. Ma to wpływ tylko na pole AddressValidation.uspsData w obiekcie AddressValidation. Uwaga: w przypadku żądań z włączoną usługą USPS CASS dotyczących adresów w Portoryko parametr PostalAddress.regionCode elementu address musi mieć wartość „PR” lub parametr PostalAddress.administrativeArea elementu address musi mieć wartość „Puerto Rico” (wielkość liter nie jest rozróżniana) lub „PR”.

Address class

google.maps.addressValidation.Address zajęcia

Szczegóły przetworzonego adresu. Przetwarzanie końcowe obejmuje poprawianie błędnie zapisanych części adresu, zastępowanie nieprawidłowych części i uzupełnianie brakujących części.

Aby uzyskać dostęp, zadzwoń pod numer const {Address} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

components
Poszczególne komponenty sformatowanego i poprawionego adresu wraz z informacjami o weryfikacji. Zawiera on informacje o stanie weryfikacji poszczególnych komponentów.
formattedAddress
Typ:  string optional
Przetworzony adres sformatowany jako adres jednowierszowy zgodnie z regułami formatowania adresów obowiązującymi w regionie, w którym znajduje się adres.
missingComponentTypes
Typ:  Array<string>
Typy komponentów, które powinny być obecne w prawidłowo sformatowanym adresie pocztowym, ale nie zostały znalezione w danych wejściowych i nie można ich było wywnioskować. Komponenty tego typu nie występują w formatted_address, postal_address ani address_components. Przykład: ['street_number', 'route'] dla danych wejściowych „Boulder, Colorado, 80301, USA”. Listę możliwych typów znajdziesz tutaj.
postalAddress
Typ:  PostalAddress optional
Przetworzony adres przedstawiony jako adres pocztowy.
unconfirmedComponentTypes
Typ:  Array<string>
Typy komponentów, które znajdują się w pliku address_components, ale nie udało się potwierdzić ich poprawności. To pole jest podane dla wygody: jego zawartość odpowiada iteracji przez address_components w celu znalezienia typów wszystkich komponentów, w których AddressComponent.confirmationLevel nie jest ConfirmationLevel.CONFIRMED lub flaga AddressComponent.inferred nie jest ustawiona na true. Listę możliwych typów znajdziesz tutaj.
unresolvedTokens
Typ:  Array<string>
Wszystkie tokeny w danych wejściowych, których nie udało się rozpoznać. Może to być dane wejściowe, które nie zostały rozpoznane jako prawidłowa część adresu (np. w przypadku danych wejściowych takich jak „123235253253 Main St, San Francisco, CA, 94105” nierozpoznane tokeny mogą wyglądać jak ["123235253253"], ponieważ nie przypominają prawidłowego numeru ulicy).

Klasa AddressComponent

google.maps.addressValidation.AddressComponent zajęcia

Reprezentuje pojedynczy element adresu (np. nazwę ulicy, miasto).

Aby uzyskać dostęp, zadzwoń pod numer const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

componentName
Typ:  string optional
Tekst nazwy komponentu. Na przykład „5th Avenue” jako nazwa ulicy lub „1253” jako numer domu.
componentNameLanguageCode
Typ:  string optional
Kod języka w standardzie BCP-47. Nie będzie on widoczny, jeśli nazwa komponentu nie jest powiązana z językiem, np. numer domu.
componentType
Typ:  string optional
Typ komponentu adresu. Listę możliwych typów znajdziesz w Tabeli 2: Dodatkowe typy zwracane przez usługę Miejsca.
confirmationLevel
Typ:  ConfirmationLevel optional
Wskazuje poziom pewności, że komponent jest prawidłowy.
inferred
Typ:  boolean
Jeśli wartość to prawda, ten komponent nie był częścią danych wejściowych, ale został wywnioskowany na podstawie lokalizacji adresu. Zalecamy uwzględnienie tego elementu, aby adres był kompletny.
replaced
Typ:  boolean
Wskazuje, że nazwa komponentu została zastąpiona zupełnie inną. Na przykład zastąpienie nieprawidłowego kodu pocztowego prawidłowym kodem dla danego adresu. To nie jest zmiana kosmetyczna – komponent wejściowy został zmieniony na inny.
spellCorrected
Typ:  boolean
Wskazuje poprawkę błędu pisowni w nazwie komponentu. Interfejs API nie zawsze oznacza zmiany z jednego wariantu pisowni na inny, np. „centre” na „center”.
unexpected
Typ:  boolean
Jeśli wartość to prawda, ten komponent nie powinien być obecny w adresie pocztowym w danym regionie. Został zachowany tylko dlatego, że był częścią danych wejściowych.

Klasa AddressMetadata

google.maps.addressValidation.AddressMetadata zajęcia

Metadane adresu. Nie ma gwarancji, że obiekt AddressMetadata będzie w pełni wypełniony w przypadku każdego adresu wysyłanego do interfejsu Address Validation API.

Aby uzyskać dostęp, zadzwoń pod numer const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

business
Typ:  boolean
poBox
Typ:  boolean
residential
Typ:  boolean

Stałe ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel stałe

Różne możliwe wartości wskazujące poziom pewności, że komponent jest prawidłowy.

Aby uzyskać dostęp, zadzwoń pod numer const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Klasa Geocode

google.maps.addressValidation.Geocode zajęcia

Zawiera informacje o miejscu, do którego został przypisany kod geograficzny.

Aby uzyskać dostęp, zadzwoń pod numer const {Geocode} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

bounds
Typ:  LatLngBounds optional
Granice miejsca, którego dotyczy kod geograficzny.
featureSizeMeters
Typ:  number optional
Rozmiar miejsca z kodem geograficznym w metrach. Jest to kolejna miara dokładności lokalizacji określonej za pomocą kodu geograficznego, ale w rozmiarze fizycznym, a nie w znaczeniu semantycznym.
location
Typ:  LatLngAltitude optional
Geokodowana lokalizacja danych wejściowych.
placeId
Typ:  string optional
Identyfikator miejsca, które zostało poddane geokodowaniu. Zalecamy używanie miejsc, a nie adresów, współrzędnych geograficznych czy kodów Plus Code. Użycie współrzędnych do wyznaczania trasy lub obliczania wskazówek dojazdu zawsze spowoduje przyciągnięcie punktu do drogi najbliższej tym współrzędnym. Może to nie być droga, która szybko lub bezpiecznie prowadzi do miejsca docelowego, i może nie znajdować się w pobliżu punktu dostępu do nieruchomości. Dodatkowo, gdy lokalizacja jest poddawana odwrotnemu geokodowaniu, nie ma gwarancji, że zwrócony adres będzie zgodny z oryginalnym.
placeTypes
Typ:  Array<string>
Typy miejsc, do których przypisano dane wejściowe. Na przykład: ['locality', 'political']. Pełną listę typów znajdziesz w dokumentacji interfejsu Geocoding API.
plusCode
Typ:  PlusCode optional
Plus Code odpowiadający location.
fetchPlace
fetchPlace()
Parametry: brak
Zwracana wartość: brak
Zwraca reprezentację miejsca dla tego kodu geograficznego. Aby uzyskać pełne informacje o miejscu, należy wywołać funkcję place.fetchFields().

Stałe Granularity

google.maps.addressValidation.Granularity stałe

Różne poziomy szczegółowości, które może mieć adres lub kod geograficzny. Gdy te wartości są używane do wskazywania szczegółowości adresu, wskazują, z jaką szczegółowością adres identyfikuje miejsce docelowe przesyłki. Na przykład adres „ul. Główna 123, Warszawa, 00-001” wskazuje PREMISE, a „Warszawa, 00-001” – LOCALITY. Jeśli jednak nie uda nam się znaleźć kodu geograficznego dla adresu „123 Main Street” w Redwood City, zwrócony kod geograficzny może mieć poziom szczegółowości LOCALITY, mimo że adres jest bardziej szczegółowy.

Aby uzyskać dostęp, zadzwoń pod numer const {Granularity} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

BLOCK Adres lub kod geograficzny wskazuje blok. Używany tylko w regionach, w których adresowanie odbywa się na poziomie bloku, np. w Japonii.
OTHER Wszystkie inne poziomy szczegółowości, które są grupowane razem, ponieważ nie można ich wyświetlać.
PREMISE Wynik na poziomie budynku.
PREMISE_PROXIMITY Kod geograficzny, który przybliża lokalizację adresu na poziomie budynku.
ROUTE Kod geograficzny lub adres jest szczegółowy i dotyczy trasy, np. ulicy, drogi lub autostrady.
SUB_PREMISE Wynik na poziomie niższym niż budynek, np. mieszkanie.

Stałe PossibleNextAction

google.maps.addressValidation.PossibleNextAction stałe

Zawiera podsumowanie interpretacyjne odpowiedzi interfejsu API, które ma pomóc w określeniu potencjalnych dalszych działań. To pole jest generowane na podstawie innych pól w odpowiedzi interfejsu API i nie powinno być traktowane jako gwarancja dokładności adresu ani możliwości dostarczenia przesyłki.

Aby uzyskać dostęp, zadzwoń pod numer const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

ACCEPT Odpowiedź interfejsu API nie zawiera sygnałów, które uzasadniałyby jedną z pozostałych wartości PossibleNextAction. Możesz rozważyć użycie przetworzonego adresu bez dalszego pytania klienta, ale nie gwarantuje to, że adres jest prawidłowy, i może on nadal zawierać poprawki. To Ty musisz określić, czy i jak wyświetlać klientowi prośbę, w zależności od własnej oceny ryzyka.
CONFIRM Co najmniej jedno pole odpowiedzi interfejsu API wskazuje na potencjalne drobne problemy z przetworzonym adresem, np. komponent adresu postal_code został replaced. Poproszenie klienta o sprawdzenie adresu może pomóc poprawić jego jakość.
CONFIRM_ADD_SUBPREMISES Odpowiedź interfejsu API wskazuje, że w przetworzonym adresie może brakować informacji o lokalu. Poproszenie klienta o sprawdzenie adresu i rozważenie dodania numeru lokalu może pomóc w poprawieniu jakości adresu. Przetworzony adres może też mieć inne drobne problemy. Uwaga: ta wartość typu wyliczeniowego może być zwracana tylko w przypadku adresów w Stanach Zjednoczonych.
FIX Co najmniej 1 pole odpowiedzi interfejsu API wskazuje na potencjalny problem z przetworzonym adresem, np. verdict.validation_granularity to OTHER. Poproszenie klienta o poprawienie adresu może pomóc poprawić jego jakość.

Klasa USPSAddress

google.maps.addressValidation.USPSAddress zajęcia

Reprezentacja adresu w USA według USPS.

Aby uzyskać dostęp, zadzwoń pod numer const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

city
Typ:  string optional
Nazwa miasta.
cityStateZipAddressLine
Typ:  string optional
Wiersz adresu zawierający miasto, stan i kod pocztowy.
firm
Typ:  string optional
Nazwa firmy.
firstAddressLine
Typ:  string optional
Pierwszy wiersz adresu.
secondAddressLine
Typ:  string optional
Drugi wiersz adresu.
state
Typ:  string optional
Dwuliterowy kod stanu.
urbanization
Typ:  string optional
Nazwa urbanizacji w Portoryko.
zipCode
Typ:  string optional
Kod pocztowy, np. „10009”.
zipCodeExtension
Typ:  string optional
4-cyfrowe rozszerzenie kodu pocztowego, np. „5023”.

Klasa USPSData

google.maps.addressValidation.USPSData zajęcia

Dane USPS dotyczące adresu. Nie ma gwarancji, że dane USPSData będą w pełni wypełnione w przypadku każdego adresu w USA lub Portoryko wysłanego do interfejsu Address Validation API. Jeśli używasz uspsData jako głównej części odpowiedzi, zalecamy zintegrowanie pól adresu zapasowego w odpowiedzi.

Aby uzyskać dostęp, zadzwoń pod numer const {USPSData} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

abbreviatedCity
Typ:  string optional
Skrócona nazwa miasta.
addressRecordType
Typ:  string optional
Typ rekordu adresu, który pasuje do adresu wejściowego.
carrierRoute
Typ:  string optional
Kod trasy przewoźnika. Czteroznakowy kod składający się z jednoliterowego prefiksu i trzycyfrowego oznaczenia trasy.
carrierRouteIndicator
Typ:  string optional
Wskaźnik sortowania stawek tras przewoźnika.
cassProcessed
Typ:  boolean
Wskaźnik, że żądanie zostało przetworzone przez CASS.
county
Typ:  string optional
Nazwa hrabstwa.
deliveryPointCheckDigit
Typ:  string optional
Cyfra kontrolna punktu dostawy. Ta liczba jest dodawana na końcu kodu kreskowego punktu dostawy w przypadku poczty skanowanej mechanicznie. Suma wszystkich cyfr z pól delivery_point_barcode, cyfry kontrolnej punktu doręczenia, kodu pocztowego i ZIP+4 powinna być liczbą podzielną przez 10.
deliveryPointCode
Typ:  string optional
2-cyfrowy kod punktu dostawy.
dpvCMRA
Typ:  string optional
Wskazuje, czy adres jest adresem CMRA (Commercial Mail Receiving Agency) – prywatnej firmy odbierającej pocztę dla klientów. Zwraca pojedynczy znak.
dpvConfirmation
Typ:  string optional
Możliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak lub nie zwraca żadnej wartości.
dpvDoorNotAccessible
Typ:  string optional
Flaga wskazuje adresy, pod którymi USPS nie może zapukać do drzwi, aby dostarczyć pocztę. Zwraca pojedynczy znak.
dpvDrop
Typ:  string optional
Flaga wskazuje, że poczta jest dostarczana do jednej skrzynki w danej lokalizacji. Zwraca pojedynczy znak.
dpvEnhancedDeliveryCode
Typ:  string optional
Wskazuje, że dla adresu prawidłowy jest więcej niż 1 kod zwrotny DPV. Zwraca pojedynczy znak.
dpvFootnote
Typ:  string optional
Przypisy z weryfikacji punktu dostawy. W jednym ciągu znaków można połączyć kilka przypisów.
dpvNonDeliveryDays
Typ:  string optional
Flaga wskazująca, że poczta nie jest dostarczana codziennie. Zwraca pojedynczy znak.
dpvNonDeliveryDaysValues
Typ:  number optional
Liczba całkowita określająca dni, w których dostawa nie jest realizowana. Można go odczytać 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.
dpvNoSecureLocation
Typ:  string optional
Flaga wskazuje, że drzwi są dostępne, ale przesyłka nie zostanie pozostawiona ze względów bezpieczeństwa. Zwraca pojedynczy znak.
dpvNoStat
Typ:  string optional
Wskazuje, czy adres jest adresem bez statystyk czy aktywnym. Adresy bez statystyk to adresy, które nie są stale zajęte, lub adresy, których USPS nie obsługuje. Zwraca pojedynczy znak.
dpvNoStatReasonCode
Typ:  number optional
Wskazuje typ NoStat. Zwraca kod przyczyny jako liczbę całkowitą.
dpvPBSA
Typ:  string optional
Wskazuje, że adres został dopasowany do rekordu PBSA. Zwraca pojedynczy znak.
dpvThrowback
Typ:  string optional
Wskazuje, że poczta nie jest dostarczana na adres pocztowy. Zwraca pojedynczy znak.
dpvVacant
Typ:  string optional
Wskazuje, czy adres jest pusty. Zwraca pojedynczy znak.
elotFlag
Typ:  string optional
Flaga rosnąca/malejąca eLOT (A/D).
elotNumber
Typ:  string optional
Numer eLOT (Enhanced Line of Travel).
errorMessage
Typ:  string optional
Komunikat o błędzie podczas pobierania danych USPS. To pole jest wypełniane, gdy przetwarzanie USPS jest zawieszone z powodu wykrycia sztucznie utworzonych adresów.
fipsCountyCode
Typ:  string optional
Kod FIPS hrabstwa.
hasDefaultAddress
Typ:  boolean
Wskaźnik, że znaleziono adres domyślny, ale istnieją bardziej szczegółowe adresy.
hasNoEWSMatch
Typ:  boolean
Adres dostawy jest możliwy do dopasowania, ale plik EWS wskazuje, że dopasowanie ścisłe będzie wkrótce dostępne.
lacsLinkIndicator
Typ:  string optional
Wskaźnik LACSLink.
lacsLinkReturnCode
Typ:  string optional
Kod zwrotu LACSLink.
pmbDesignator
Typ:  string optional
Oznaczenie jednostki PMB (prywatna skrzynka pocztowa).
pmbNumber
Typ:  string optional
Numer prywatnej skrzynki pocztowej (PMB).
poBoxOnlyPostalCode
Typ:  boolean
Kod pocztowy tylko dla skrytki pocztowej.
postOfficeCity
Typ:  string optional
Miasto, w którym znajduje się główny urząd pocztowy.
postOfficeState
Typ:  string optional
Stan głównego urzędu pocztowego.
standardizedAddress
Typ:  USPSAddress optional
Znormalizowany adres USPS.
suiteLinkFootnote
Typ:  string optional
Przypisy z dopasowania rekordu ulicy lub wieżowca do informacji o apartamencie. Jeśli zostanie znalezione dopasowanie nazwy firmy, zwracany jest numer dodatkowy.

Klasa Verdict

google.maps.addressValidation.Verdict zajęcia

Reprezentuje przetworzony adres podany przez użytkownika.

Aby uzyskać dostęp, zadzwoń pod numer const {Verdict} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.

addressComplete
Typ:  boolean
Adres jest uznawany za kompletny, jeśli nie ma nierozpoznanych tokenów ani nieoczekiwanych lub brakujących komponentów adresu. Jeśli nie jest ustawiona, oznacza to, że wartość to false. Więcej informacji znajdziesz w polach Address.missingComponentTypes, Address.unresolvedTokens lub AddressComponent.unexpected.
geocodeGranularity
Typ:  Granularity optional
Informacje o szczegółowości Geocode. Można to rozumieć jako semantyczne znaczenie tego, jak ogólna lub szczegółowa jest lokalizacja z kodem geograficznym.
hasInferredComponents
Typ:  boolean
Co najmniej 1 komponent adresu został wywnioskowany (czyli dodany), którego nie było w danych wejściowych. Szczegółowe informacje znajdziesz w sekcji AddressComponent.
hasReplacedComponents
Typ:  boolean optional
Co najmniej 1 komponent adresu został zastąpiony – szczegółowe informacje znajdziesz w sekcji AddressComponent.
hasUnconfirmedComponents
Typ:  boolean
Nie można skategoryzować lub zweryfikować co najmniej jednego komponentu adresu. Szczegółowe informacje znajdziesz w sekcji AddressComponent.
inputGranularity
Typ:  Granularity optional
Szczegółowość podanego adresu. Jest to wynik analizy adresu wejściowego i nie zawiera żadnych sygnałów weryfikacji. Sygnały weryfikacji znajdziesz w sekcji validationGranularity.
BetapossibleNextAction
Typ:  PossibleNextAction optional
Możliwe następne działanie do wykonania na podstawie innych pól w odpowiedzi interfejsu API. Aby dowiedzieć się więcej, zobacz PossibleNextAction.
validationGranularity
Typ:  Granularity optional
Poziom szczegółowości, na którym interfejs API może w pełni zweryfikować adres. Na przykład validationGranularity o wartości PREMISE oznacza, że można zweryfikować wszystkie komponenty adresu na poziomie PREMISE i szerszym.