Dokumen ini menjelaskan proses membangun sistem pemeriksaan alamat untuk menangani berbagai respons dari Address Validation API. Panduan ini mencakup cara membangun logika Anda untuk menggunakan respons dengan benar, guna menyelidiki sinyal lain dari API, serta kapan dan bagaimana Anda meminta informasi lebih lanjut dari pelanggan.
Secara umum, respons API menentukan cara berikut yang harus dilakukan sistem Anda menangani alamat:
- Perbaiki—alamatnya berkualitas rendah. Anda harus meminta informasi selengkapnya.
- Konfirmasi—alamat berkualitas tinggi, tetapi memiliki perubahan dari alamat input. Anda mungkin meminta konfirmasi.
- Setuju—alamat berkualitas tinggi. Anda dapat menyetujui alamat yang diberikan.
Tujuan utama
Dokumen ini akan membantu Anda memodifikasi sistem untuk menganalisis respons API dengan sebaik-baiknya menentukan tindakan selanjutnya yang harus dilakukan dengan alamat yang disediakan. Hal berikut {i>pseudo-code<i} menggambarkan alur yang mungkin.
if (the API response indicates significant problems in the address)
FIX - prompt the user to fix the address
else if (the API response indicates less significant problems in the address)
CONFIRM - confirm with the user that the address is correct
else
ACCEPT - continue with the address returned by the API.
Logika persisnya bergantung pada situasi Anda - lihat Panduan penerapan untuk mengetahui detail selengkapnya. Anda juga dapat menggunakan implementasi {i>open source<i} kami untuk logika ini, yang ada di Extended Component Library.
Ringkasan alur kerja
Tabel di bawah ini merangkum dua tindakan untuk sistem Anda:
- Alur kerja yang akan digunakan berdasarkan perilaku perbaikan, konfirmasi, dan penerimaan.
- Sinyal pertama yang akan diperiksa dari respons. Sinyal
yang dijelaskan di sini berasal dari properti
verdict
dan bukan satu-satunya yang perlu diperiksa, tetapi memberikan indikator awal untuk alamat {i>sandwich<i} itu. Setiap jenis perilaku sesuai dengan bagian dalam dokumen ini menjelaskan sinyal-sinyal lebih lanjut yang mungkin juga perlu Anda selidiki.
Perilaku sistem Anda | |||
---|---|---|---|
Perbaiki alamat |
Respons dari
|
||
Konfirmasi alamat |
Respons dari
|
||
Setujui alamat |
Respons Address Validation API menunjukkan alamat dengan kualitas yang sangat baik.
|
Panduan implementasi
Saat mendesain cara sistem Anda merespons sinyal dari Address Validation API, rekomendasi berikut dapat membantu Anda membuat respons yang lebih efektif model transformer. Namun, ini hanyalah rekomendasi, jadi perhatikan bahwa harus sesuai dengan model bisnis Anda.
Panduan | Detail | |
---|---|---|
Tingkat risiko |
Pertimbangkan tingkat toleransi terhadap situasi Anda ketika menyeimbangkan antara meminta untuk koreksi dan menerima alamat yang dimasukkan. |
Address Validation API menampilkan berbagai sinyal yang dapat Anda gabungkan dengan tingkat risiko untuk mengoptimalkan validasi Anda {i>checkout<i}. Misalnya, jika suatu alamat memiliki nomor jalan yang belum dikonfirmasi, Anda dapat tetap menerimanya. Di sisi lain, jika operasi bisnis Anda memerlukan presisi alamat yang lebih baik, Anda mungkin meminta pengguna. Sebagai contoh yang dapat termasuk dalam salah satu kategori, lihat Nomor jalan yang belum dikonfirmasi di luar AS di bagian Menerima alamat - contoh. |
Terima alamat |
Sebaiknya izinkan sistem Anda menerima entri asli jika pelanggan tidak merespons perintah. |
Dalam kasus ini, pelanggan mungkin telah memasukkan alamat yang tidak ada di sistem, seperti untuk konstruksi baru. |
Berikan masukan |
Saat menerbitkan ulang permintaan validasi alamat, Anda dapat
juga mengirim permintaan ke endpoint |
Hal ini memberi tahu Google bagaimana Anda pada akhirnya menangani respons akhir. Baca bagian Menangani alamat yang diperbarui. |
Perbaiki alamat
Perbaiki alamat jika hasil dengan jelas menunjukkan bahwa alamat tersebut tidak {i>deliverable<i} (hasil kerja) yang baik. Selanjutnya, sistem dapat meminta pelanggan untuk memberikan informasi yang diperlukan informasi, setelah itu Anda menerbitkan ulang alur kerja Anda untuk mendapatkan hasil alamat IPv6
Perbaiki sinyal
Address Validation API menyediakan sejumlah sinyal untuk memberi tahu Anda jika alamat tersebut harus diperbaiki.
1. Perincian validasi dan komponen yang hilang
Kedua sinyal berikut memberikan indikasi terbaik dari alamat yang bermasalah:
- Setiap kali kolom
validationGranularity
adalahOTHER
, sistem Anda seharusnya selidiki sinyal komponen alamat untuk mempelajari lebih lanjut di mana kesalahan terjadi dan bagaimana memperbaikinya. - Setiap kali objek
address
yang diproses kembali menampilkanmissingComponentTypes
, sistem Anda harus memeriksa komponen tersebut. Komponen yang hilang juga menyebabkan alamat tidak lengkap dan tidak dapat dikirim.
2. Sinyal lainnya
Address Validation API juga memberikan sinyal lain untuk membantu mendiagnosis masalah tertentu:
Komponen yang mencurigakan | Saat enum tingkat konfirmasi untuk komponen adalah
UNCOMFIRMED_AND_SUSPICIOUS , kemungkinan komponen tersebut
salah.
|
---|---|
Komponen yang belum di-resolve | unresolvedToken adalah bagian dari input yang tidak dikenali sebagai bagian alamat yang valid. |
3. Sinyal alamat AS
Bidang tertentu yang hanya berlaku untuk alamat di AS memberikan sinyal berguna bahwa alamat ini tidak dapat dituju dan harus diperbaiki. Untuk alamat yang memerlukan diperbaiki, Anda akan melihat yang berikut:
dpvConfirmation
|
Berupa N , D , atau kosong.
|
---|
Untuk mengetahui detail tentang dpvConfirmation
, lihat
Menangani alamat di Amerika Serikat.
Konfirmasi alamat
Anda mengonfirmasi alamat saat verdict menunjukkan bahwa Address Validation API baik yang disimpulkan maupun membuat perubahan pada komponen alamat untuk menghasilkan alamat yang divalidasi. Dalam kasus ini, Anda memiliki alamat pengiriman, tetapi lebih suka keyakinan yang lebih besar bahwa alamat yang dihasilkan adalah alamat yang dituju oleh juga merupakan pelanggan Google Workspace.
Untuk memberikan perintah yang benar kepada pelanggan, logika Anda akan mengidentifikasi
komponen yang ditandai oleh layanan untuk menentukan tindakan atau penanda mana yang ditandai oleh API
diterapkan ke komponen, seperti inferred
, replaced
, atau spellCorrected
.
Lihat AddressComponent dalam referensi.
Konfirmasi sinyal
Address Validation API menyediakan sejumlah sinyal untuk memberi tahu Anda jika alamat harus dikonfirmasi.
1. Perincian Validasi
validationGranularity
yang bernilai ROUTE
atau yang lebih baik dapat diterima, tetapi
PREMISE atau SUBPREMISE memberikan sinyal kemampuan pengiriman yang lebih kuat.
2. Sinyal lainnya
Saat memutuskan untuk mengonfirmasi entri alamat dengan pelanggan, putusan tersebut juga menyediakan hal berikut untuk menentukan komponen apa saja yang perlu diselidiki:
Data yang disimpulkan | Jika kolom hasInferredComponents adalah true ,
Anda tahu bahwa API mengisi informasi yang diperolehnya dari alamat lain
komponen.
|
---|---|
Data yang diganti | Jika kolom hasReplacedComponents adalah true ,
API mengganti data yang dimasukkan dengan data yang dianggap valid untuk membuat alamat tersebut.
|
3. Sinyal alamat AS
Beberapa bidang tertentu yang hanya berlaku untuk alamat di AS menunjukkan bahwa logika Anda harus mengonfirmasi detailnya dengan pelanggan. Salah satu hal berikut berlaku:
dpvConfirmation
|
S
Untuk mengetahui detail tentang |
---|---|
Respons alamat | Berisi kolom missingComponentType dengan nilai
subpremise .
|
Terima alamat
Anda menerima alamat ketika putusan tersebut memberikan tingkat keyakinan tinggi yang alamat dapat dituju dan dapat digunakan tanpa interaksi pelanggan lebih lanjut berada dalam proses downstream.
Terima sinyal
Address Validation API menyediakan sejumlah sinyal untuk memberi tahu Anda jika alamat harus dikonfirmasi.
1. Perincian Validasi
validationGranularity
yang berupa PREMISE
atau lebih dapat diterima, tetapi di beberapa
kasus, ROUTE
masih menunjukkan alamat pengiriman.
2. Sinyal lainnya
Putusan untuk alamat berkualitas tinggi juga harus menampilkan hal berikut:
- Tidak ada data yang diganti. Dalam kasus ini,
hasReplacedComponents: FALSE
. - Tidak ada komponen yang disimpulkan. Dalam kasus ini,
hasInferredComponents: FALSE
.
3. Sinyal alamat AS
Kolom tertentu yang hanya berlaku untuk alamat di AS menunjukkan alamat berkualitas tinggi yang dapat menjadi tujuan pengiriman. Untuk alamat AS yang dapat diterima, Anda akan melihat berikut ini:
dpvConfirmation
|
Y
Untuk mengetahui detail tentang |
---|