Memahami respons validasi alamat dasar

Address Validation API menyediakan isi respons sebagai objek JSON yang berisi dua properti level atas:

{
  "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"
}

Dokumen ini berfokus pada objek result. Untuk informasi tentang responseID, lihat Menangani alamat yang diperbarui.

Properti verdict

Properti verdict merangkum hasil validasi alamat dan harus menjadi properti pertama yang dievaluasi saat membuat logika pemeriksaan alamat. Properti ini dapat menampilkan berbagai kolom, bergantung pada kualitas alamat output. Misalnya, berikut ini menunjukkan properti verdict alamat berkualitas baik, yang menampilkan 4 kolom untuk permintaan khusus ini:

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

Bagian berikut merangkum semua kolom dalam properti verdict.

Lihat Verdict dalam panduan referensi.

Perincian alamat

Tingkat perincian alamat mengacu pada tingkat detail yang digunakan dalam menentukan spesifikasi alamat atau geocode. Kekhususan alamat dalam respons validationGranularity adalah sinyal utama untuk mengetahui apakah alamat dapat dikirimkan atau tidak.

Properti verdict menampilkan sinyal perincian ini:

  • inputGranularity — Menjelaskan tingkat detail yang diambil dari alamat yang dikirim ke Address Validation API. Tingkat detail alamat dalam permintaan memengaruhi tingkat detail alamat dalam respons validasi. Misalnya, alamat dengan inputGranularity di bawah PREMISE di bawah level biasanya tidak menghasilkan validationGranularity ke level PREMISE.
  • validationGranularity — Tingkat perincian yang dapat digunakan Address Validation API untuk memvalidasi alamat sepenuhnya. Pada umumnya, tingkat perincian PREMISE atau SUB_PREMISE menunjukkan alamat berkualitas yang kemungkinan dapat dikirim.
  • geocodeGranularity — Menjelaskan tingkat detail geocode yang terkait dengan alamat. Misalnya, data Google mungkin menunjukkan adanya nomor apartemen, tetapi bukan lokasi yang tepat untuk apartemen tertentu tersebut dalam kompleks apartemen besar. Dalam hal ini, validationGranularity adalah SUB_PREMISE, tetapi geocodeGranularityisPREMISE`.
Lihat Perincian di panduan referensi.

Kelengkapan alamat

Verdict menampilkan properti addressComplete sebagai sinyal untuk alamat berkualitas tinggi, yang secara khusus berarti tidak memiliki komponen yang hilang, tidak terselesaikan, atau tidak terduga:

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

Jika alamat memiliki komponen yang tidak ada, tidak terselesaikan, atau tidak terduga, kolom akan ditetapkan ke false.

Lihat addressComplete di bagian Verdict dan Address dalam panduan referensi.

Kualitas alamat

Sejumlah kolom yang mungkin menunjukkan masalah pada komponen alamat, atau penyesuaian pada komponen tersebut, seperti komponen alamat yang disimpulkan atau tidak ada. Misalnya, properti verdict berikut menunjukkan alamat dengan komponen yang belum dikonfirmasi dan kolom addressComplete yang tidak ada:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}
Lihat Verdict di panduan referensi.

Properti address dan addressComponent

Properti address menyediakan format untuk alamat yang diproses yang diberikan dalam permintaan, beserta ringkasan alamat tingkat komponen, termasuk bagian alamat yang salah eja, bagian yang salah diganti, dan bagian yang hilang yang disimpulkan.

Lihat Address dalam panduan referensi.

Properti addressComponent adalah subkomponen dari address yang menyediakan listingan mendetail terkait elemen—atau komponen—dari alamat yang telah diproses oleh Address Validation API. API mengidentifikasi setiap kolom komponen yang disediakan berdasarkan nama, jenis, dan tingkat konfirmasinya.

Lihat addressComponent dalam panduan referensi.

Properti geocode

Properti geocode menunjukkan lokasi yang di-geocoding yang terkait dengan alamat input. Properti ini memberikan detail tentang lokasi itu sendiri, seperti ID tempatnya.

Lihat Geocode dalam panduan referensi.

Properti metadata

Properti ini mungkin tidak diisi untuk setiap alamat yang diproses oleh Address Validation API, tetapi menunjukkan apakah alamat tersebut berjenis rumah, bisnis, atau PO Box.

Lihat Cakupan Address Validation API dan referensi untuk Address metadata.

Properti uspsData

Properti ini memberikan informasi yang berguna untuk alamat pos Amerika Serikat. Namun, tidak dijamin bahwa kolom ini akan terisi sepenuhnya untuk setiap alamat yang divalidasi oleh layanan. Oleh karena itu, Anda tidak boleh mengandalkan properti ini sebagai satu-satunya cara untuk memvalidasi alamat, tetapi periksa juga verdict dan address.

Lihat Menangani alamat Amerika Serikat dan referensi untuk UspsData.
Sebelumnya
Mengirim permintaan validasi alamat
Berikutnya
Membuat logika validasi