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ć do żądania treść żądania JSON, która określa adres do zweryfikowania. Ta 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 określić go jako element w tablicy addressLines:

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

Narzędzie API Explorer umożliwia wysyłanie żądań w czasie rzeczywistym, dzięki czemu możesz zapoznać się z interfejsem API i jego opcjami:

Pola prośby o adres

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

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

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

• regionCode – zalecane. To pole jest opcjonalne, ale jeśli go nie podasz, interfejs Address Validation API wywnioskuje region z adresu. Aby uzyskać najlepsze wyniki, podaj regionCode, jeśli go znasz. Listę obsługiwanych regionów znajdziesz w sekcji Obsługiwane regiony.
• addressLines – wymagane. Tablica z adresami opisującymi niższą strukturę adresu.

Opcja USPS CASS™

United States Postal Service® (USPS®)¹ prowadzi Coding Accuracy Support System (CASS™), aby wspierać i certyfikować dostawców usług weryfikacji adresów.

W przypadku regionów Stanów Zjednoczonych i Portoryko możesz włączyć przetwarzanie CASS, ustawiając w treści żądania wartość enableUspsCass na true. Aby uzyskać najlepsze wyniki podczas korzystania z CASS, podaj adres, który zawiera ulicę i numer domu wraz z miastem, stanem i kodem pocztowym:

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

Wypróbuj

Eksplorator interfejsów API umożliwia wysyłanie przykładowych żądań, dzięki czemu możesz zapoznać się z interfejsem API i jego opcjami.

1. Po prawej stronie strony kliknij ikonę interfejsu API api.

2. Opcjonalnie możesz edytować parametry żądania.

3. Kliknij przycisk Wykonaj. W oknie dialogowym wybierz konto, z którego chcesz wysłać prośbę.

4. W panelu APIs Explorer kliknij ikonę pełnego ekranu fullscreen, aby rozwinąć okno narzędzia.