Odpowiedź na podstawowe informacje o weryfikacji adresu

Interfejs Address Validation API udostępnia treść odpowiedzi w postaci pliku JSON który zawiera 2 właściwości najwyższego poziomu:

• result, obiekt typu ValidationResult
• responseID

{
  "result": {
    // Validation verdict.
    "verdict": {},
    // Address details determined by the API.
    "address": {},
    // The geocode generated for the input address.
    "geocode": {},
    // Information indicating if the address is a business, residence, etc.
    "metadata": {},
    // Information about the address from the US Postal Service
    // ("US" and "PR" addresses only).
    "uspsData": {},
  },
  // A unique identifier generated for every request to the API.
  "responseId": "ID"
}

Ten dokument dotyczy obiektu result. Informacje na temat responseID, więcej informacji znajdziesz w sekcji Obsługa zaktualizowanych adresów.

Właściwość verdict

Właściwość verdict podsumowuje wyniki weryfikacji adresu i powinna być pierwszą właściwością do oceny podczas sprawdzania logiki adresu. Właściwość może zwracać różne pola w zależności od jakości adres wyjściowy. Na przykład poniżej widać właściwość verdict elementu adresu o dobrej jakości, który zwraca dla tego konkretnego żądania 4 pola:

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "addressComplete": true
}

W poniższych sekcjach znajdziesz podsumowanie wszystkich pól we właściwości verdict.

Zobacz Efekt.

szczegółowość adresu,

Szczegółowość adresu odnosi się do poziomu szczegółowości używanego do określania dokładności adresu lub kodu geograficznego. Szczegółowość adresu w Odpowiedź validationGranularity to kluczowy sygnał wskazujący, czy adres i można je zrealizować.

Usługa verdict zwraca te sygnały szczegółowości:

• inputGranularity – określa poziom szczegółowości rejestrowanych danych wysłany do interfejsu Address Validation API. Poziom szczegółowości adresu w wpływa na poziom szczegółowości adresu w odpowiedzi weryfikacyjnej. Na przykład adres z wartością inputGranularity poniżej PREMISE poziom zwykle nie skutkuje uzyskaniem wyniku od validationGranularity do PREMISE na poziomie 300%.
• validationGranularity – poziom szczegółowości Interfejs Address Validation API może w pełni zweryfikować adres. W większości przypadków poziom szczegółowości PREMISE lub SUB_PREMISE wskazuje adres jakości które można by było zrealizować.
• geocodeGranularity – określa poziom szczegółowości geokodu powiązane z adresem. Na przykład dane Google mogą wskazywać numer mieszkania, ale nie określona lokalizacja które mieści się w dużym kompleksie mieszkalnym. W takim przypadku validationGranularity to SUB_PREMISE, ale geocodeGranularityisPREMIUM.

Zobacz Szczegółowość w przewodniku.

Kompletność adresu

Wynik zwraca właściwość addressComplete jako sygnał dla wysokiej jakości, czyli zawierają wszystkie niezbędne informacje, nierozstrzygnięte lub nieoczekiwane komponenty:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

Jeśli w adresie brakuje, nierozstrzygnięte lub nieprawidłowe komponenty, pole ma wartość false.

Zobacz addressComplete poniżej Verdict oraz Adres w przewodniku.

Jakość adresu

Wiele możliwych pól oznacza problemy z komponentami adresu lub ich korekty, na przykład domniemane lub brakujące składniki adresu. Dla: Na przykład właściwość verdict poniżej wskazuje adres z niepotwierdzonym adresem i brakujące pole addressComplete:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

Zobacz Wynik w przewodniku.

Właściwości address i addressComponent

Właściwość address umożliwia formatowanie przetworzonego adresu podanego w wraz z podsumowaniem na poziomie komponentu adresu, w tym błędnie napisane części adresu, zastąpiono nieprawidłowe części oraz domniemane brakujące elementy; części składowych.

Zobacz Address w przewodniku.

Właściwość addressComponent to podkomponent właściwości address, który udostępnia szczegółową listę elementów – lub składników adresu – Interfejs API do weryfikacji adresu został przetworzony. Interfejs API identyfikuje każdy komponent. które można podać, podając jego nazwę, typ i poziom potwierdzenia.

Zobacz addressComponent w przewodniku.

Właściwość geocode

Właściwość geocode wskazuje geokodowaną lokalizację powiązaną z danymi wejściowymi. adresu. Ta właściwość zawiera informacje o samej lokalizacji, np. i identyfikatorem miejsca.

Zobacz Geocode w przewodniku.

Właściwość metadata

Może ona nie zostać zapełniona w przypadku każdego adresu przetwarzanego przez Adres API weryfikacji adresów, ale wskazuje, czy adres należy do typu zamieszkania, firmy lub skrytki pocztowej.

Zapoznaj się z sekcją Zasięg interfejsu API do weryfikacji adresów i informacjami o Address metadata.

Właściwość uspsData

Ta usługa zawiera przydatne informacje dotyczące adresów pocztowych w Stanach Zjednoczonych. Nie możemy jednak zagwarantować, że w przypadku każdego zweryfikowanego adresu zostanie ono w pełni wypełnione. przez usługę. Z tego powodu nie należy polegać na tej właściwości jako na potrzeby weryfikacji adresów, ale zamiast tego sprawdź verdict i address.

Zapoznaj się z sekcją Obsługa adresów w Stanach Zjednoczonych i informacjami o UspsData.