AddressValidation class
google.maps.addressValidation.AddressValidation
zajęcia
Klasa statyczna do uzyskiwania dostępu do interfejsów API Address Validation.
Dostęp przez połączenie pod numer const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Metody statyczne | |
|---|---|
fetchAddressValidation |
fetchAddressValidation(request)Parametry:
Zwracana wartość:
Promise<AddressValidation>Sprawdza poprawność adresu. Zobacz https://developers.google.com/maps/documentation/javascript/address-validation/validate-address. |
Właściwości | |
|---|---|
address |
Typ:
Address optionalInformacje o samym adresie, a nie o geokodzie. |
geocode |
Typ:
Geocode optionalInformacje o lokalizacji i miejscu, do którego został przypisany adres. |
metadata |
Typ:
AddressMetadata optionalinne informacje istotne dla dostarczalności. metadata nie musi być w pełni wypełniony w przypadku każdego adresu wysłanego do interfejsu Address Validation API. |
responseId |
Typ:
string optionalIdentyfikator UUID tej odpowiedzi. Jeśli adres wymaga ponownej weryfikacji, do nowej prośby musi być dołączony ten identyfikator UUID. |
uspsData |
Typ:
USPSData optionalDodatkowe flagi dostarczalności udostępniane przez USPS. Dostępne tylko w regionach US i PR. |
verdict |
Typ:
Verdict optionalFlagi ogólnej oceny |
Metody | |
|---|---|
toJSON |
toJSON()Parametry: brak
Zwracana wartość:
ObjectKonwertuje klasę AddressValidation na obiekt JSON o tych samych właściwościach. |
AddressValidationRequest interfejs
google.maps.addressValidation.AddressValidationRequestinterfejs
Interfejs żądania dla AddressValidation.fetchAddressValidation.
Właściwości | |
|---|---|
address |
Typ:
PostalAddressLiteralAdres jest weryfikowany. Nieformatowane adresy należy przesyłać za pomocą PostalAddress.addressLines. |
placeAutocompleteElement optional |
Typ:
PlaceAutocompleteElement optionalJeśli używasz elementu PlaceAutocompleteElement, umieść go tutaj, aby połączyć wywołania interfejsu Address Validation API z tokenem sesji autouzupełniania. |
previousResponseId optional |
Typ:
string optionalTo pole nie może być ustawione w przypadku pierwszej prośby o weryfikację adresu. Jeśli do pełnej weryfikacji jednego adresu potrzebne są kolejne żądania (np. jeśli zmiany wprowadzone przez użytkownika po wstępnej weryfikacji wymagają ponownej weryfikacji), każde kolejne żądanie musi zawierać w tym polu wartość AddressValidation.responseId z pierwszej odpowiedzi w sekwencji weryfikacji. |
sessionToken optional |
Typ:
AutocompleteSessionToken optionalToken identyfikujący sesję autouzupełniania na potrzeby rozliczeń. |
uspsCASSEnabled optional |
Typ:
boolean optionalWłącza tryb zgodny z USPS CASS. Dotyczy to tylko pola AddressValidation.uspsData w AddressValidation. Uwaga: w przypadku żądań dotyczących adresów w Portoryko, które są obsługiwane przez USPS CASS, w polu PostalAddress.regionCode elementu address musi być podana wartość „PR”, a w polu PostalAddress.administrativeArea elementu address musi być podana wartość „Puerto Rico” (bez rozróżniania wielkości liter) lub „PR”. |
Address class
google.maps.addressValidation.Address
zajęcia
Szczegóły przetworzonego adresu. Przetwarzanie końcowe obejmuje poprawianie błędnie napisanych części adresu, zastępowanie nieprawidłowych części i wywnioskowywanie brakujących części.
Dostęp przez połączenie pod numer const {Address} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
components |
Typ:
Array<AddressComponent>Poszczególne komponenty sformatowanego i poprawionego adresu wraz z informacjami o weryfikacji. Zawiera informacje o stanie weryfikacji poszczególnych komponentów. |
formattedAddress |
Typ:
string optionalPrzetworzony adres sformatowany jako adres w jednym wierszu zgodnie z zasadami formatowania adresów obowiązującymi w regionie, w którym znajduje się adres. |
missingComponentTypes |
Typ:
Array<string>Typy komponentów, które powinny znajdować się w prawidłowo sformatowanym adresie pocztowym, ale nie zostały znalezione w danych wejściowych ANI nie można ich było wywnioskować. Komponenty tego typu nie są dostępne w tych krajach: formatted_address, postal_address i address_components. Na przykład ['street_number', 'route'] w przypadku danych wejściowych „Boulder, Colorado, 80301, USA”. Listę możliwych typów znajdziesz tutaj. |
postalAddress |
Typ:
PostalAddress optionalPrzetworzony adres w formie adresu pocztowego. |
unconfirmedComponentTypes |
Typ:
Array<string>Typy komponentów, które znajdują się w address_components, ale nie udało się potwierdzić ich poprawności. To pole jest udostępniane dla wygody użytkowników: jego zawartość jest równoważna z iteracją przez address_components w celu znalezienia typów wszystkich komponentów, w których AddressComponent.confirmationLevel nie jest równe 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 (na przykład w danych wejściowych „123235253253 Main St, San Francisco, CA, 94105” nierozwiązane tokeny mogą wyglądać jak ["123235253253"], ponieważ nie przypominają prawidłowego numeru ulicy. |
AddressComponent class
google.maps.addressValidation.AddressComponent
zajęcia
Reprezentuje pojedynczy składnik adresu (np. nazwę ulicy, miasto).
Dostęp przez połączenie pod numer const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
componentName |
Typ:
string optionalTekst nazwy komponentu. Na przykład „5th Avenue” jako nazwa ulicy lub „1253” jako numer ulicy. |
componentNameLanguageCode |
Typ:
string optionalKod języka BCP-47. Nie będzie on widoczny, jeśli nazwa komponentu nie jest powiązana z językiem, np. w przypadku numeru domu. |
componentType |
Typ:
string optionalTyp komponentu adresu. Listę możliwych typów znajdziesz w tabeli 2: Dodatkowe typy zwracane przez usługę Miejsca. |
confirmationLevel |
Typ:
ConfirmationLevel optionalWskazuje poziom pewności, że komponent jest prawidłowy. |
inferred |
Typ:
booleanJeśli wartość to prawda, ten komponent nie był częścią danych wejściowych, ale został wywnioskowany na podstawie lokalizacji adresu. Uwzględnienie tego komponentu jest zalecane w przypadku pełnego adresu. |
replaced |
Typ:
booleanWskazuje, że nazwa komponentu została zastąpiona zupełnie inną nazwą. Na przykład zastąpienie nieprawidłowego kodu pocztowego prawidłowym kodem pocztowym dla danego adresu. To nie jest zmiana kosmetyczna. Komponent wejściowy został zastąpiony innym. |
spellCorrected |
Typ:
booleanWskazuje poprawkę błędu pisowni w nazwie komponentu. Interfejs API nie zawsze oznacza zmiany z jednej wersji pisowni na inną, np. z „centre” na „center”. |
unexpected |
Typ:
booleanJeśli wartość to „prawda”, ten komponent nie powinien występować w adresie pocztowym w danym regionie. Został zachowany tylko dlatego, że był częścią danych wejściowych. |
AddressMetadata class
google.maps.addressValidation.AddressMetadata
zajęcia
Metadane adresu. Nie ma gwarancji, że w przypadku każdego adresu wysłanego do interfejsu Address Validation API pole AddressMetadata będzie w pełni wypełnione.
Dostęp przez połączenie pod numer const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
business |
Typ:
boolean |
poBox |
Typ:
boolean |
residential |
Typ:
boolean |
ConfirmationLevel stałe
google.maps.addressValidation.ConfirmationLevel
stałe
Różne możliwe wartości wskazujące poziom pewności, że komponent jest prawidłowy.
Dostęp przez połączenie pod numer const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Stałe | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Geocode class
google.maps.addressValidation.Geocode
zajęcia
Zawiera informacje o miejscu, do którego przypisano dane wejściowe za pomocą geokodowania.
Dostęp przez połączenie pod numer const {Geocode} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
bounds |
Typ:
LatLngBounds optionalGranice geokodowanego miejsca. |
featureSizeMeters |
Typ:
number optionalRozmiar zakodowanego geograficznie miejsca w metrach. Jest to kolejny wskaźnik przybliżenia geokodowanej lokalizacji, ale wyrażony w rozmiarze fizycznym, a nie w znaczeniu semantycznym. |
location |
Typ:
LatLngAltitude optionalGeokodowana lokalizacja danych wejściowych. |
placeId |
Typ:
string optionalIdentyfikator miejsca zakodowanego geograficznie. Zalecamy używanie miejsca zamiast adresów, współrzędnych geograficznych lub kodów Plus Code. Użycie współrzędnych do wyznaczania trasy lub obliczania wskazówek dojazdu zawsze spowoduje przypisanie punktu do najbliższej drogi. Może to nie być droga, która szybko lub bezpiecznie prowadzi do miejsca docelowego, ani nie musi znajdować się w pobliżu punktu dostępu do obiektu. Dodatkowo w przypadku geokodowania zwrotnego lokalizacji nie ma gwarancji, że zwrócony adres będzie zgodny z oryginalnym. |
placeTypes |
Typ:
Array<string>Typy miejsc, do których odnosi się wynik geokodowania. Na przykład: ['locality', 'political']. Pełną listę typów znajdziesz w dokumentacji interfejsu Geocoding API. |
plusCode |
Typ:
PlusCode optionalPlus Code odpowiadający atrybutowi location. |
Metody | |
|---|---|
fetchPlace |
fetchPlace()Parametry: brak
Zwracana wartość: brak
Zwraca reprezentację miejsca tego kodu geograficznego. Aby uzyskać pełne informacje o miejscu, należy wywołać funkcję place.fetchFields(). |
Stałe w przypadku szczegółowości
google.maps.addressValidation.Granularity
stałe
Różne poziomy szczegółowości, jakie może mieć adres lub geokod. Gdy te wartości są używane do określania szczegółowości adresu, wskazują, jak szczegółowo adres identyfikuje miejsce docelowe przesyłki. Na przykład adres „ul. Główna 123, Warszawa, 00-000” identyfikuje PREMISE, a „Warszawa, 00-000” identyfikuje LOCALITY. Jeśli jednak nie uda nam się znaleźć geokodu dla adresu „123 Main Street” w Redwood City, zwrócony geokod może mieć LOCALITY, mimo że adres jest bardziej szczegółowy.
Dostęp przez połączenie pod numer const {Granularity} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Stałe | |
|---|---|
BLOCK |
Adres lub geokod wskazuje blok. Używany tylko w regionach, w których stosuje się adresowanie na poziomie bloku, np. w Japonii. |
OTHER |
Pozostałe poziomy szczegółowości, które są grupowane, ponieważ nie można ich dostarczyć. |
PREMISE |
Wynik na poziomie budynku. |
PREMISE_PROXIMITY |
Geokod, który przybliża lokalizację adresu na poziomie budynku. |
ROUTE |
Geokod lub adres jest szczegółowy w odniesieniu do trasy, np. ulicy, drogi lub autostrady. |
SUB_PREMISE |
Wynik na poziomie poniżej budynku, np. mieszkanie. |
Stałe PossibleNextAction
google.maps.addressValidation.PossibleNextAction
stałe
Zawiera interpretacyjne podsumowanie odpowiedzi interfejsu API, które ma pomóc w określeniu potencjalnych działań do podjęcia. To pole jest wyliczane na podstawie innych pól w odpowiedzi interfejsu API i nie należy go traktować jako gwarancji dokładności adresu ani możliwości dostarczenia przesyłki.
Dostęp przez połączenie pod numer const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Stałe | |
|---|---|
ACCEPT |
Odpowiedź API nie zawiera sygnałów, które uzasadniałyby jedną z pozostałych wartości PossibleNextAction. Możesz użyć przetworzonego adresu bez dodatkowego pytania klienta, ale nie gwarantuje to, że adres jest prawidłowy i może nadal zawierać poprawki. To Ty musisz na podstawie własnej oceny ryzyka określić, czy i w jaki sposób poprosić klienta o potwierdzenie. |
CONFIRM |
Co najmniej jedno pole odpowiedzi interfejsu API wskazuje potencjalne drobne problemy z przetworzonym adresem, np. postal_code element adresu był replaced. Zachęcenie klienta do sprawdzenia adresu może pomóc w poprawie jego jakości. |
CONFIRM_ADD_SUBPREMISES |
Odpowiedź interfejsu API wskazuje, że w przetworzonym adresie może brakować podrzędnego lokalu. Zachęcenie klienta do sprawdzenia adresu i rozważenia dodania numeru lokalu może pomóc w poprawie jakości adresu. Adres po przetworzeniu może też mieć inne drobne problemy. Uwaga: ta wartość wyliczeniowa może być zwracana tylko w przypadku adresów w Stanach Zjednoczonych. |
FIX |
Co najmniej jedno pole odpowiedzi interfejsu API wskazuje potencjalny problem z przetworzonym adresem, np. verdict.validation_granularity ma wartość OTHER. Zachęcenie klienta do edycji adresu może pomóc w poprawie jego jakości. |
USPSAddress class
google.maps.addressValidation.USPSAddress
zajęcia
Reprezentacja adresu w Stanach Zjednoczonych w formacie USPS.
Dostęp przez połączenie pod numer const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
city |
Typ:
string optionalNazwa miasta. |
cityStateZipAddressLine |
Typ:
string optionalWiersz adresu zawierający miasto, stan i kod pocztowy. |
firm |
Typ:
string optionalNazwa firmy. |
firstAddressLine |
Typ:
string optionalPierwszy wiersz adresu. |
secondAddressLine |
Typ:
string optionalDrugi wiersz adresu. |
state |
Typ:
string optionalDwuliterowy kod stanu. |
urbanization |
Typ:
string optionalNazwa urbanizacji w Portoryko. |
zipCode |
Typ:
string optionalKod pocztowy, np. „10009”. |
zipCodeExtension |
Typ:
string optional4-cyfrowe rozszerzenie kodu pocztowego, np. „5023”. |
USPSData class
google.maps.addressValidation.USPSData
zajęcia
Dane USPS dotyczące adresu. Nie ma gwarancji, że w przypadku każdego adresu w Stanach Zjednoczonych lub Portoryko przesłanego do interfejsu Address Validation API pole USPSData będzie w pełni wypełnione. Jeśli używasz uspsData jako głównej części odpowiedzi, zalecamy zintegrowanie w niej pól adresu kopii zapasowej.
Dostęp przez połączenie pod numer const {USPSData} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
abbreviatedCity |
Typ:
string optionalSkrócona nazwa miasta. |
addressRecordType |
Typ:
string optionalTyp rekordu adresu, który pasuje do adresu wejściowego. |
carrierRoute |
Typ:
string optionalKod trasy przewoźnika. Czteroznakowy kod składający się z jednoliterowego prefiksu i trzycyfrowego oznaczenia trasy. |
carrierRouteIndicator |
Typ:
string optionalWskaźnik sortowania stawek trasy przewoźnika. |
cassProcessed |
Typ:
booleanWskaźnik, że żądanie zostało przetworzone przez CASS. |
county |
Typ:
string optionalNazwa hrabstwa. |
deliveryPointCheckDigit |
Typ:
string optionalCyfra kontrolna punktu dostawy. Ta liczba jest dodawana na końcu kodu kreskowego punktu dostawy w przypadku poczty skanowanej mechanicznie. Suma wszystkich cyfr w polach delivery_point_barcode, delivery_point_check_digit, postal code i ZIP+4 powinna być podzielna przez 10. |
deliveryPointCode |
Typ:
string optional2-cyfrowy kod punktu dostawy. |
dpvCMRA |
Typ:
string optionalWskazuje, czy adres należy do komercyjnej agencji odbioru poczty (CMRA) – prywatnej firmy odbierającej pocztę dla klientów. Zwraca pojedynczy znak. |
dpvConfirmation |
Typ:
string optionalMożliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak lub nie zwraca żadnej wartości. |
dpvDoorNotAccessible |
Typ:
string optionalFlaga wskazuje adresy, pod którymi USPS nie może zapukać do drzwi, aby dostarczyć pocztę. Zwraca pojedynczy znak. |
dpvDrop |
Typ:
string optionalFlaga oznacza, że poczta jest dostarczana do jednego pojemnika w danej lokalizacji. Zwraca pojedynczy znak. |
dpvEnhancedDeliveryCode |
Typ:
string optionalWskazuje, że dla adresu jest ważny więcej niż jeden kod zwrotu DPV. Zwraca pojedynczy znak. |
dpvFootnote |
Typ:
string optionalPrzypisy z weryfikacji punktu dostawy. W jednym ciągu znaków można połączyć kilka przypisów. |
dpvNonDeliveryDays |
Typ:
string optionalFlaga wskazująca, że dostawa poczty nie jest realizowana codziennie. Zwraca pojedynczy znak. |
dpvNonDeliveryDaysValues |
Typ:
number optionalLiczba całkowita określająca dni, w których nie ma dostawy. Można go sprawdzić 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 optionalFlaga oznacza, że drzwi są dostępne, ale przesyłka nie zostanie pozostawiona ze względu na obawy dotyczące bezpieczeństwa. Zwraca pojedynczy znak. |
dpvNoStat |
Typ:
string optionalWskazuje, czy adres jest adresem bez statystyk, czy adresem aktywnym. Adresy statystyczne to adresy, które nie są stale zajęte lub nie są obsługiwane przez USPS. Zwraca pojedynczy znak. |
dpvNoStatReasonCode |
Typ:
number optionalWskazuje typ NoStat. Zwraca kod przyczyny jako liczbę całkowitą. |
dpvPBSA |
Typ:
string optionalWskazuje, że adres został dopasowany do rekordu PBSA. Zwraca pojedynczy znak. |
dpvThrowback |
Typ:
string optionalWskazuje, że poczta nie jest dostarczana na adres ulicy. Zwraca pojedynczy znak. |
dpvVacant |
Typ:
string optionalWskazuje, czy adres jest pusty. Zwraca pojedynczy znak. |
elotFlag |
Typ:
string optionalFlaga kolejności rosnącej/malejącej eLOT (A/D). |
elotNumber |
Typ:
string optionalNumer ulepszonej linii podróży (eLOT). |
errorMessage |
Typ:
string optionalKomunikat o błędzie podczas pobierania danych USPS. To pole jest wypełniane, gdy przetwarzanie przez USPS jest zawieszone z powodu wykrycia sztucznie utworzonych adresów. |
fipsCountyCode |
Typ:
string optionalKod FIPS hrabstwa. |
hasDefaultAddress |
Typ:
booleanWskaźnik, że znaleziono adres domyślny, ale istnieją bardziej szczegółowe adresy. |
hasNoEWSMatch |
Typ:
booleanAdres dostawy można dopasować, ale plik EWS wskazuje, że dokładne dopasowanie będzie dostępne wkrótce. |
lacsLinkIndicator |
Typ:
string optionalWskaźnik LACSLink. |
lacsLinkReturnCode |
Typ:
string optionalKod zwrotu LACSLink. |
pmbDesignator |
Typ:
string optionalOznaczenie jednostki PMB (Private Mail Box). |
pmbNumber |
Typ:
string optionalNumer PMB (Private Mail Box). |
poBoxOnlyPostalCode |
Typ:
booleanKod pocztowy tylko dla skrytki pocztowej. |
postOfficeCity |
Typ:
string optionalMiasto, w którym znajduje się główny urząd pocztowy. |
postOfficeState |
Typ:
string optionalStan głównego urzędu pocztowego. |
standardizedAddress |
Typ:
USPSAddress optionalZnormalizowany adres USPS. |
suiteLinkFootnote |
Typ:
string optionalprzypisy z dopasowania rekordu ulicy lub wieżowca do informacji o lokalu; Jeśli zostanie znalezione dopasowanie nazwy firmy, zwracany jest numer dodatkowy. |
Verdict class
google.maps.addressValidation.Verdict
zajęcia
Reprezentuje przetworzony adres podany przez użytkownika.
Dostęp przez połączenie pod numer const {Verdict} = await google.maps.importLibrary("addressValidation").
Zobacz Biblioteki w Maps JavaScript API.
Właściwości | |
|---|---|
addressComplete |
Typ:
booleanAdres jest uznawany za kompletny, jeśli nie zawiera nierozwiązanych tokenów ani nieoczekiwanych lub brakujących komponentów. 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 optionalInformacje o szczegółowości Geocode. Można to rozumieć jako semantyczne znaczenie tego, jak przybliżona lub dokładna jest lokalizacja zakodowana geograficznie. |
hasInferredComponents |
Typ:
booleanDodano co najmniej jeden element adresu, którego nie było w danych wejściowych. Więcej informacji znajdziesz w sekcji AddressComponent. |
hasReplacedComponents |
Typ:
boolean optionalZastąpiono co najmniej 1 element adresu – szczegóły znajdziesz w AddressComponent. |
hasUnconfirmedComponents |
Typ:
booleanNie można skategoryzować ani zweryfikować co najmniej 1 elementu adresu. Szczegółowe informacje znajdziesz w sekcji AddressComponent. |
inputGranularity |
Typ:
Granularity optionalSzczegółowość adresu wejściowego. Jest to wynik analizy adresu wejściowego, który nie zawiera żadnych sygnałów weryfikacyjnych. Sygnały weryfikacji znajdziesz w sekcji validationGranularity. |
possibleNextAction |
Typ:
PossibleNextAction optionalMożliwe kolejne działanie, które można wykonać na podstawie innych pól w odpowiedzi interfejsu API. Aby dowiedzieć się więcej, zobacz PossibleNextAction. |
validationGranularity |
Typ:
Granularity optionalPoziom 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 wyższym. |