Address Validation API menyediakan isi respons sebagai JSON yang berisi dua properti tingkat atas:
result
, objek dengan jenisValidationResult
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"
}
Dokumen ini berfokus pada objek result
. Untuk mengetahui informasi tentang
responseID
, lihat Menangani alamat yang diperbarui.
Properti verdict
Properti verdict
meringkas hasil validasi alamat dan
harus menjadi properti pertama yang dievaluasi saat membangun logika pemeriksaan alamat.
Properti dapat menampilkan berbagai kolom, bergantung pada kualitas
alamat output-nya. Misalnya, kode berikut menunjukkan properti verdict
dari sebuah properti
yang berkualitas baik, yang menampilkan 4 kolom untuk permintaan ini:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Bagian berikut meringkas semua kolom di properti verdict
.
Lihat Verdict dalam panduan referensi. |
Perincian alamat
Perincian alamat mengacu pada tingkat detail yang digunakan dalam menentukan
kekhususan alamat atau geocode. Kekhususan alamat di
Respons validationGranularity
adalah sinyal utama untuk mengetahui apakah suatu alamat
hasil kerja/capaiannya.
Properti verdict
menampilkan sinyal perincian berikut:
inputGranularity
— Menjelaskan tingkat detail yang diambil dari yang dikirim ke Address Validation API. Tingkat detail alamat di mempengaruhi tingkat detail alamat dalam respons validasi. Misalnya, alamat denganinputGranularity
di bawahPREMISE
di bawah biasanya tidak menghasilkanvalidationGranularity
hinggaPREMISE
level organisasi.validationGranularity
— Tingkat perincian yang Address Validation API dapat sepenuhnya memvalidasi alamat. Di sebagian besar kasus, tingkat perincianPREMISE
atauSUB_PREMISE
menunjukkan alamat kualitas hasil kerja yang diharapkan.geocodeGranularity
— Menjelaskan tingkat detail geocode yang terkait dengan alamat. Misalnya, catatan Google mungkin menunjukkan keberadaan nomor apartemen, tetapi bukan lokasi tepat untuk nomor tersebut apartemen tertentu dalam kompleks apartemen yang besar. Dalam kasus tersebut,validationGranularity
adalahSUB_PREMISE
, tetapigeocodeGranularity
is
PREMISE`.
Lihat Perincian dalam panduan referensi. |
Kelengkapan alamat
Verdict menampilkan properti addressComplete
sebagai sinyal untuk
yang berkualitas tinggi, yang secara khusus berarti bahwa alamat ini tidak memiliki
komponen yang belum terselesaikan, atau tidak terduga:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Jika alamat memiliki komponen yang hilang, belum terselesaikan, atau tidak terduga,
ditetapkan ke false
.
Lihat addressComplete di
Verdict dan
Alamat di panduan referensi. |
Kualitas alamat
Sejumlah kemungkinan isian menunjukkan
masalah dengan komponen alamat, atau
beberapa penyesuaian, seperti komponen alamat
yang disimpulkan atau hilang. Sebagai
contoh, properti verdict
berikut menunjukkan alamat dengan data yang belum dikonfirmasi
komponen dan kolom addressComplete
yang tidak ada:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Lihat Verdict dalam panduan referensi. |
Properti address
dan addressComponent
Properti address
memberikan pemformatan untuk alamat yang diproses yang diberikan di
permintaan, bersama dengan ringkasan alamat tingkat komponen, termasuk
bagian alamat yang salah eja, bagian yang salah diganti, dan bagian yang disimpulkan tidak ada
suku cadang.
Lihat Address dalam panduan referensi. |
Properti addressComponent
adalah subkomponen dari address
yang menyediakan
daftar elemen—atau komponen—dari alamat yang
Address Validation API telah diproses. API mengidentifikasi setiap komponen
disediakan menurut nama, jenis, dan tingkat konfirmasinya.
Lihat addressComponent dalam panduan referensi. |
Properti geocode
Properti geocode
menunjukkan lokasi geocode yang terkait dengan input
alamat IPv6 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 perumahan, 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 ada jaminan bahwa kolom ini akan terisi penuh untuk setiap alamat yang divalidasi
oleh layanan. Untuk alasan itu, Anda tidak boleh
mengandalkan properti ini karena
satu-satunya cara untuk memvalidasi alamat, tetapi memeriksa verdict
dan
address
.
Lihat Menangani alamat Amerika Serikat dan referensi untuk UspsData .
|