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 mengetahui informasi tentang responseID, lihat Menangani alamat yang diperbarui.

Properti verdict

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

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

Bagian berikut meringkas semua kolom di properti verdict.

Lihat Pernyataan di panduan referensi.

Tingkat perincian alamat

Perincian alamat mengacu pada tingkat detail yang digunakan dalam menentukan kekhususan alamat atau geocode. Kekhususan alamat dalam respons validationGranularity merupakan sinyal utama terkait apakah alamat dapat dikirim atau tidak.

Properti verdict menampilkan sinyal perincian berikut:

  • 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 divalidasi sepenuhnya oleh Address Validation API dari alamat. Pada umumnya, tingkat perincian PREMISE atau SUB_PREMISE menunjukkan alamat kualitas yang kemungkinan dapat diberikan.
  • geocodeGranularity — Menjelaskan tingkat detail geocode yang dikaitkan dengan alamat. Misalnya, data Google mungkin menunjukkan keberadaan nomor apartemen, tetapi bukan lokasi akurat untuk apartemen tertentu tersebut dalam kompleks apartemen yang 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, belum terselesaikan, atau tidak terduga:

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

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

Lihat addressComplete di bagian Pernyataan dan Alamat dalam panduan referensi.

Kualitas alamat

Sejumlah kemungkinan kolom menunjukkan masalah dengan komponen alamat, atau penyesuaian pada kolom 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 Pernyataan di panduan referensi.

Properti address dan addressComponent

Properti address menyediakan pemformatan untuk alamat yang diproses yang diberikan dalam permintaan, bersama dengan ringkasan tingkat komponen alamat, termasuk bagian alamat yang salah eja, bagian yang salah diganti, dan bagian yang tidak ada yang disimpulkan.

Lihat Address di panduan referensi.

Properti addressComponent adalah subkomponen dari address yang menyediakan listingan mendetail untuk 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 di panduan referensi.

Properti geocode

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

Lihat Geocode di panduan referensi.

Properti metadata

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

Lihat Cakupan Address Validation API dan referensi untuk Address metadata.

Properti uspsData

Properti ini memberikan informasi yang bermanfaat untuk alamat pos Amerika Serikat. Namun, tidak dijamin akan terisi penuh 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 di Amerika Serikat dan referensi untuk UspsData.
Sebelumnya
Mengirim permintaan validasi alamat
Berikutnya
Membuat logika validasi