Address Validation

AddressValidation

klasa google.maps.addressValidation.AddressValidation
biblioteka "addressValidation"

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

const {AddressValidation} = await google.maps.importLibrary("addressValidation");
fetchAddressValidation
fetchAddressValidation(request)
Parametry:
Wartość zwracana: Promise<AddressValidation>
address
readonly
Typ: Address optional
Informacje o samym adresie, a nie o kodzie geograficznym.
geocode
readonly
Typ: Geocode optional
Informacje o lokalizacji i miejscu, do których został przypisany kod geograficzny adresu.
metadata
readonly
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
readonly
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
readonly
Typ: USPSData optional
Dodatkowe flagi dostarczalności dostarczane przez USPS. Dostępne tylko w regionach US i PR.
verdict
readonly
Typ: Verdict optional
Flagi ogólnej oceny
Dziedziczone: toJSON

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.
internalUsageAttributionIds
opcjonalne
Typ: Iterable<string> optional
Identyfikatory używane do przypisywania wywołań do konkretnych pakietów lub bibliotek OSS.
placeAutocompleteElement
opcjonalne
Jeśli używasz elementu PlaceAutocompleteElement, dołącz go tutaj, aby połączyć wywołania interfejsu AddressValidation API z tokenem sesji autouzupełniania.
previousResponseId
opcjonalne
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
opcjonalne
Token, który identyfikuje sesję autouzupełniania do celów rozliczeniowych.
uspsCASSEnabled
opcjonalne
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

klasa google.maps.addressValidation.Address
biblioteka "addressValidation"

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.

const {Address} = await google.maps.importLibrary("addressValidation");
components
readonly
Poszczególne komponenty sformatowanego i poprawionego adresu wraz z informacjami o weryfikacji. Zawiera on informacje o stanie weryfikacji poszczególnych komponentów.
formattedAddress
readonly
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
readonly
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
readonly
Typ: PostalAddress optional
Przetworzony adres przedstawiony jako adres pocztowy.
unconfirmedComponentTypes
readonly
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
readonly
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).
Dziedziczone: toJSON

Klasa AddressComponent

klasa google.maps.addressValidation.AddressComponent
biblioteka "addressValidation"

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

const {AddressComponent} = await google.maps.importLibrary("addressValidation");
componentName
readonly
Typ: string optional
Tekst nazwy komponentu. Na przykład „5th Avenue” jako nazwa ulicy lub „1253” jako numer domu.
componentNameLanguageCode
readonly
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
readonly
Typ: string optional
Typ komponentu adresu. Listę możliwych typów znajdziesz w Tabeli 2: Dodatkowe typy zwracane przez usługę Miejsca.
confirmationLevel
readonly
Typ: ConfirmationLevel optional
Wskazuje poziom pewności, że komponent jest prawidłowy.
inferred
readonly
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
readonly
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
readonly
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
readonly
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

klasa google.maps.addressValidation.AddressMetadata
biblioteka "addressValidation"

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.

const {AddressMetadata} = await google.maps.importLibrary("addressValidation");
business
readonly
Typ: boolean
poBox
readonly
Typ: boolean
residential
readonly
Typ: boolean
Dziedziczone: toJSON

Stałe ConfirmationLevel

stałe google.maps.addressValidation.ConfirmationLevel
biblioteka "addressValidation"

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

Te stałe mogą być też używane jako ciągi znaków. W języku TypeScript literały ciągów znaków są definiowane przez typ ConfirmationLevelString.

const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Klasa Geocode

klasa google.maps.addressValidation.Geocode
biblioteka "addressValidation"

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

const {Geocode} = await google.maps.importLibrary("addressValidation");
bounds
readonly
Typ: LatLngBounds optional
Granice miejsca, którego dotyczy kod geograficzny.
featureSizeMeters
readonly
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
readonly
Typ: LatLngAltitude optional
Geokodowana lokalizacja danych wejściowych.
placeId
readonly
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
readonly
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
readonly
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().
Dziedziczone: toJSON

Stałe Granularity

stałe google.maps.addressValidation.Granularity
biblioteka "addressValidation"

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.

Te stałe mogą być też używane jako ciągi znaków. W języku TypeScript literały ciągów znaków są definiowane przez typ GranularityString.

const {Granularity} = await google.maps.importLibrary("addressValidation");
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

stałe google.maps.addressValidation.PossibleNextAction
biblioteka "addressValidation"

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.

Te stałe mogą być też używane jako ciągi znaków. W języku TypeScript literały ciągów znaków są definiowane przez typ PossibleNextActionString.

const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");
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

klasa google.maps.addressValidation.USPSAddress
biblioteka "addressValidation"

Reprezentacja adresu w USA według USPS.

const {USPSAddress} = await google.maps.importLibrary("addressValidation");
city
readonly
Typ: string optional
Nazwa miasta.
cityStateZipAddressLine
readonly
Typ: string optional
Wiersz adresu zawierający miasto, stan i kod pocztowy.
firm
readonly
Typ: string optional
Nazwa firmy.
firstAddressLine
readonly
Typ: string optional
Pierwszy wiersz adresu.
secondAddressLine
readonly
Typ: string optional
Drugi wiersz adresu.
state
readonly
Typ: string optional
Dwuliterowy kod stanu.
urbanization
readonly
Typ: string optional
Nazwa urbanizacji w Portoryko.
zipCode
readonly
Typ: string optional
Kod pocztowy, np. „10009”.
zipCodeExtension
readonly
Typ: string optional
4-cyfrowe rozszerzenie kodu pocztowego, np. „5023”.
Dziedziczone: toJSON

Klasa USPSData

klasa google.maps.addressValidation.USPSData
biblioteka "addressValidation"

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.

const {USPSData} = await google.maps.importLibrary("addressValidation");
abbreviatedCity
readonly
Typ: string optional
Skrócona nazwa miasta.
addressRecordType
readonly
Typ: string optional
Typ rekordu adresu, który pasuje do adresu wejściowego.
carrierRoute
readonly
Typ: string optional
Kod trasy przewoźnika. Czteroznakowy kod składający się z jednoliterowego prefiksu i trzycyfrowego oznaczenia trasy.
carrierRouteIndicator
readonly
Typ: string optional
Wskaźnik sortowania stawek tras przewoźnika.
cassProcessed
readonly
Typ: boolean
Wskaźnik, że żądanie zostało przetworzone przez CASS.
county
readonly
Typ: string optional
Nazwa hrabstwa.
deliveryPointCheckDigit
readonly
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
readonly
Typ: string optional
2-cyfrowy kod punktu dostawy.
dpvCMRA
readonly
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
readonly
Typ: string optional
Możliwe wartości potwierdzenia DPV. Zwraca pojedynczy znak lub nie zwraca żadnej wartości.
dpvDoorNotAccessible
readonly
Typ: string optional
Flaga wskazuje adresy, pod którymi USPS nie może zapukać do drzwi, aby dostarczyć pocztę. Zwraca pojedynczy znak.
dpvDrop
readonly
Typ: string optional
Flaga wskazuje, że poczta jest dostarczana do jednej skrzynki w danej lokalizacji. Zwraca pojedynczy znak.
dpvEnhancedDeliveryCode
readonly
Typ: string optional
Wskazuje, że dla adresu prawidłowy jest więcej niż 1 kod zwrotny DPV. Zwraca pojedynczy znak.
dpvFootnote
readonly
Typ: string optional
Przypisy z weryfikacji punktu dostawy. W jednym ciągu znaków można połączyć kilka przypisów.
dpvNonDeliveryDays
readonly
Typ: string optional
Flaga wskazująca, że poczta nie jest dostarczana codziennie. Zwraca pojedynczy znak.
dpvNonDeliveryDaysValues
readonly
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
readonly
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
readonly
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
readonly
Typ: number optional
Wskazuje typ NoStat. Zwraca kod przyczyny jako liczbę całkowitą.
dpvPBSA
readonly
Typ: string optional
Wskazuje, że adres został dopasowany do rekordu PBSA. Zwraca pojedynczy znak.
dpvThrowback
readonly
Typ: string optional
Wskazuje, że poczta nie jest dostarczana na adres pocztowy. Zwraca pojedynczy znak.
dpvVacant
readonly
Typ: string optional
Wskazuje, czy adres jest pusty. Zwraca pojedynczy znak.
elotFlag
readonly
Typ: string optional
Flaga rosnąca/malejąca eLOT (A/D).
elotNumber
readonly
Typ: string optional
Numer eLOT (Enhanced Line of Travel).
errorMessage
readonly
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
readonly
Typ: string optional
Kod FIPS hrabstwa.
hasDefaultAddress
readonly
Typ: boolean
Wskaźnik, że znaleziono adres domyślny, ale istnieją bardziej szczegółowe adresy.
hasNoEWSMatch
readonly
Typ: boolean
Adres dostawy jest możliwy do dopasowania, ale plik EWS wskazuje, że dopasowanie ścisłe będzie wkrótce dostępne.
lacsLinkIndicator
readonly
Typ: string optional
Wskaźnik LACSLink.
lacsLinkReturnCode
readonly
Typ: string optional
Kod zwrotu LACSLink.
pmbDesignator
readonly
Typ: string optional
Oznaczenie jednostki PMB (prywatna skrzynka pocztowa).
pmbNumber
readonly
Typ: string optional
Numer prywatnej skrzynki pocztowej (PMB).
poBoxOnlyPostalCode
readonly
Typ: boolean
Kod pocztowy tylko dla skrytki pocztowej.
postOfficeCity
readonly
Typ: string optional
Miasto, w którym znajduje się główny urząd pocztowy.
postOfficeState
readonly
Typ: string optional
Stan głównego urzędu pocztowego.
standardizedAddress
readonly
Typ: USPSAddress optional
Znormalizowany adres USPS.
suiteLinkFootnote
readonly
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.
Dziedziczone: toJSON

Klasa Verdict

klasa google.maps.addressValidation.Verdict
biblioteka "addressValidation"

Reprezentuje przetworzony adres podany przez użytkownika.

const {Verdict} = await google.maps.importLibrary("addressValidation");
addressComplete
readonly
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
readonly
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
readonly
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
readonly
Typ: boolean optional
Co najmniej 1 komponent adresu został zastąpiony – szczegółowe informacje znajdziesz w sekcji AddressComponent.
hasUnconfirmedComponents
readonly
Typ: boolean
Nie można skategoryzować lub zweryfikować co najmniej jednego komponentu adresu. Szczegółowe informacje znajdziesz w sekcji AddressComponent.
inputGranularity
readonly
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
readonly
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
readonly
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.