Wysyłanie prośby o weryfikację adresu

Wyślij żądanie weryfikacji adresu, wysyłając żądanie POST do jednego z tych punktów końcowych:

• validateAddress (REST),
• ValidateAddress (gRPC)

Żądanie powinno też przekazywać treść żądania JSON do żądania definiującego adres do weryfikacji. Poniższa treść żądania zawiera 1 pole i 3 pola podrzędne:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"

Możesz też pominąć locality i podać go jako element w tablicy addressLines:

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

Wypróbuj

Pola żądania adresu

Treść żądania składa się z jednego pola:

• address – pole typu PostalAddress, które musi zawierać co najmniej 1 wpis w języku addressLines.

Gdy wysyłasz pole address do interfejsu Address Validation API, potrzebujesz tylko 1 pola: addressLines. Najprostsze żądanie adresu powinno jednak zawierać te pola podrzędne:

• regionCode – zalecane. To pole jest opcjonalne, ale jeśli zostanie pominięte, interfejs Address Validation API pobierze region na podstawie adresu. Jednak najlepsze wyniki uzyskasz, dodając regionCode, jeśli znasz tę wartość. Listę obsługiwanych regionów znajdziesz w tym artykule.
• addressLines – wymagane. Tablica z adresami opisującymi dolną strukturę adresu.

Zobacz PostalAddress w przewodniku.

Opcja USPS CASSTM

Organizacja United States Postal Service® (USPS®)¹ utrzymuje system wsparcia dokładności kodowania (CASSTM), który wspiera i certyfikuje dostawców weryfikacji adresów.

Tylko w przypadku regionów Stanów Zjednoczonych i PR możesz włączyć przetwarzanie CASS, ustawiając wartość enableUspsCass na true w treści żądania. Aby uzyskać najlepsze wyniki podczas korzystania z CASS, podaj adres zawierający ulicę i numer domu, a także miasto, województwo i kod pocztowy:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

Wypróbuj

API Explorer umożliwia wykonywanie przykładowych żądań, aby zapoznać się z interfejsem API i jego opcjami.

1. Wybierz ikonę interfejsu API () po prawej stronie.

2. Opcjonalnie rozwiń opcję Pokaż parametry standardowe i ustaw parametr fields na maskę pola.

3. Opcjonalnie edytuj Treść żądania.

4. Kliknij przycisk Wykonaj. W oknie wybierz konto, którego chcesz użyć do przesłania prośby.

5. W panelu API Explorer kliknij ikonę rozwijania , aby rozwinąć okno API Explorer.