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 niego treść żądania JSON określającego adres do zweryfikowania. 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 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 polu addressLines.

Aby wysyłać pole address do interfejsu Address Verificationation 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 pominiesz, interfejs Address Billingation API ustala region na podstawie adresu. Jednak najlepsze wyniki uzyskasz, dodając regionCode, jeśli go znasz. Listę obsługiwanych regionów znajdziesz w sekcji Obsługiwane regiony.
• addressLines – wymagany. Tablica z adresami opisującymi dolną strukturę adresu.

Przeczytaj sekcję PostalAddress (Adres pocztowy) w przewodniku.

Opcja USPS CASSTM

Amerykański urząd pocztowy® (USPS®)¹ utrzymuje system wsparcia dokładności kodowania (Coding Accuracy Support System (CASSTM)), aby wspierać i certyfikować dostawców usług weryfikacji adresów.

Tylko w przypadku regionów USA i PR możesz włączyć przetwarzanie CASS, ustawiając dla parametru enableUspsCass wartość true w treści żądania. Aby uzyskać najlepsze rezultaty podczas korzystania z systemu CASS, podaj adres, który zawiera ulicę i numer domu, a także miasto, stan i kod pocztowy:

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

Wypróbuj

Eksplorator interfejsów API umożliwia wykonywanie przykładowych żądań, aby ułatwić Ci zapoznanie się z interfejsem API i jego opcjami.

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

2. Opcjonalnie zmodyfikuj treść żądania.

3. Kliknij przycisk Wykonaj. W oknie wybierz konto, które ma zostać użyte do przesłania prośby.

4. W panelu Eksplorator interfejsów API kliknij ikonę rozwijania , aby rozwinąć okno API Explorer.