Membuat logika validasi

Dokumen ini menjelaskan proses pembuatan sistem pemeriksaan alamat untuk menangani berbagai respons dari Address Validation API. Panduan ini membahas cara mem-build logika untuk menggunakan respons dengan benar, menyelidiki sinyal lain dari API, serta kapan dan cara meminta informasi selengkapnya kepada pelanggan.

Secara umum, respons API menentukan cara berikut yang harus dilakukan sistem Anda untuk menangani alamat:

  • Perbaiki—alamat berkualitas rendah. Anda harus meminta informasi lebih lanjut.
  • Konfirmasi—alamat berkualitas tinggi, tetapi memiliki perubahan dari alamat input. Anda mungkin meminta konfirmasi.
  • Terima—alamat berkualitas tinggi. Anda dapat menerima alamat yang diberikan.

Tujuan utama

Dokumen ini membantu Anda mengubah sistem untuk menganalisis respons API dengan sebaik mungkin dan menentukan tindakan berikutnya yang akan dilakukan dengan alamat yang diberikan. Pseudocode berikut menggambarkan kemungkinan alur.

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 yang tepat bergantung pada situasi Anda - lihat Panduan penerapan untuk detail selengkapnya. Anda juga dapat menggunakan implementasi open source kami untuk logika ini, yang ada di Extended Component Library.

Ringkasan alur kerja

Tabel di bawah merangkum dua tindakan untuk sistem Anda:

  1. Alur kerja yang akan digunakan berdasarkan perilaku perbaiki, konfirmasi, terima.
  2. Sinyal pertama yang akan diperiksa dari respons. Sinyal yang dijelaskan di sini berasal dari properti verdict dan bukan satu-satunya sinyal yang akan diperiksa, tetapi memberikan indikator awal kualitas alamat. Setiap jenis perilaku sesuai dengan bagian dalam dokumen ini yang menjelaskan sinyal lebih lanjut yang mungkin juga perlu Anda selidiki.
Perilaku sistem Anda
Perbaiki alamat

Respons dari verdict menunjukkan informasi penting yang hilang yang harus diberikan. Alamat yang ditampilkan oleh Address Validation API mungkin tidak memiliki kualitas yang dapat dikirimkan.

Alur kerja

  1. Selidiki komponen alamat jika perlu.
  2. Minta pelanggan untuk memperbaiki masalah alamat.
  3. Minta validasi untuk alamat yang diperbarui.
  4. (Opsional) Kirim permintaan ke endpoint masukan untuk API. Lihat Menangani alamat yang diperbarui.
  5. Lanjutkan dengan alamat.

Sinyal verdict

Salah satu dari hal berikut berlaku:
Konfirmasi alamat

Respons dari verdict menunjukkan alamat yang dapat dikirim, tetapi telah membuat perubahan pada input asli: menyimpulkan data yang telah dikoreksi ejaan, atau data yang dapat dikonfirmasi.

Alur kerja

  1. Koreksi yang diperlukan:
    1. Selidiki komponen alamat jika perlu.
    2. Minta validasi untuk alamat yang diperbarui.
    3. (Opsional) Kirim permintaan ke endpoint masukan untuk API. Lihat Menangani alamat yang diperbarui.
    4. Lanjutkan dengan alamat.
  2. Tidak perlu koreksi:
    1. (Opsional) Kirim permintaan ke endpoint masukan untuk API. Lihat Menangani alamat yang diperbarui.
    2. Lanjutkan dengan alamat.

Sinyal verdict

Semua hal berikut berlaku:

  • validationGranularity berisi ROUTE atau yang lebih baik. Lihat nilai tingkat perincian.
  • addressComplete adalah true.
  • Kolom hasInferredComponents adalah true ATAU Kolom hasReplacedComponents adalah true.
Terima alamat

Respons Address Validation API menunjukkan alamat berkualitas sangat baik.

Alur kerja

Lanjutkan dengan alamat yang ditampilkan.

Sinyal verdict

Semua hal berikut berlaku:

  • validationGranularity berisi PREMISE atau lebih baik. Lihat nilai tingkat perincian.
  • addressComplete adalah true.
  • Tidak ada komponen yang disimpulkan atau diganti.

Panduan implementasi

Saat mendesain cara sistem Anda merespons sinyal dari Address Validation API, rekomendasi berikut dapat membantu Anda membuat model respons yang lebih efektif. Namun, ini hanyalah rekomendasi, jadi perlu diingat bahwa penerapan Anda harus sesuai dengan model bisnis Anda.

Panduan Detail
Tingkat risiko

Pertimbangkan tingkat toleransi untuk situasi Anda saat menyeimbangkan antara meminta koreksi dan menerima alamat seperti yang dimasukkan.

Address Validation API menampilkan berbagai sinyal yang dapat Anda gabungkan dengan tingkat risiko untuk mengoptimalkan proses validasi.

Misalnya, jika alamat memiliki nomor jalan yang belum dikonfirmasi, Anda tetap dapat menerimanya. Di sisi lain, jika operasi bisnis Anda memerlukan presisi alamat yang lebih besar, Anda dapat meminta pengguna. Untuk contoh yang dapat termasuk dalam salah satu kategori tersebut, lihat Nomor jalan non-AS yang belum dikonfirmasi di Menerima alamat - contoh.
Menerima alamat

Sebaiknya izinkan sistem Anda menerima entri asli jika pelanggan tidak merespons perintah.

Dalam kasus ini, pelanggan mungkin telah memasukkan alamat yang tidak ada dalam sistem, seperti untuk bangunan baru.
Berikan masukan

Saat menerbitkan ulang permintaan validasi alamat, Anda juga dapat mengirim permintaan ke endpoint provideValidationFeedback.

Hal ini memungkinkan Google mengetahui bagaimana Anda akhirnya menangani respons akhir. Lihat Menangani alamat yang diperbarui.

Perbaiki alamat

Perbaiki alamat jika hasilnya menunjukkan dengan jelas bahwa alamat tersebut tidak dapat dikirim. Sistem Anda kemudian dapat meminta pelanggan untuk memberikan informasi yang diperlukan, setelah itu Anda menerbitkan ulang alur kerja untuk mendapatkan alamat yang dapat dikirim.

Memperbaiki sinyal

Address Validation API memberikan sejumlah sinyal untuk memberi tahu Anda apakah alamat harus diperbaiki.

1. Tingkat perincian validasi dan komponen yang hilang

Kedua sinyal ini memberikan indikasi terbaik tentang alamat yang bermasalah:

  • Setiap kali kolom validationGranularity adalah OTHER, sistem Anda harus menyelidiki sinyal komponen alamat untuk mempelajari lebih lanjut tempat error terjadi dan cara memperbaikinya.
  • Setiap kali objek address pasca-pemrosesan menampilkan kolom missingComponentTypes, sistem Anda harus memeriksa komponen tersebut. Komponen yang tidak ada juga akan membuat 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 Jika enum tingkat konfirmasi untuk komponen adalah UNCOMFIRMED_AND_SUSPICIOUS, kemungkinan komponen tersebut salah.
Komponen yang belum terselesaikan unresolvedToken adalah bagian dari input yang tidak dikenali sebagai bagian alamat yang valid.

3. Sinyal alamat AS

Kolom tertentu yang hanya berlaku untuk alamat AS memberikan sinyal yang berguna bahwa alamat tersebut tidak dapat dikirim dan harus diperbaiki. Untuk alamat yang memerlukan perbaikan, Anda akan melihat hal berikut:

dpvConfirmation N, D, atau kosong.

Untuk mengetahui detail tentang dpvConfirmation, lihat Menangani alamat Amerika Serikat.

Contoh alamat perbaikan

Mengonfirmasi alamat

Anda mengonfirmasi alamat saat verdict menunjukkan bahwa Address Validation API menyimpulkan atau membuat perubahan pada komponen alamat untuk menghasilkan alamat yang divalidasi. Dalam kasus ini, Anda memiliki alamat yang dapat dikirim, tetapi lebih memilih keyakinan yang lebih besar bahwa alamat yang dihasilkan adalah alamat yang dimaksud oleh pelanggan.

Untuk memberikan perintah yang benar kepada pelanggan, logika Anda akan mengidentifikasi komponen yang ditandai oleh layanan untuk menentukan tindakan atau tanda yang diterapkan API ke komponen, seperti inferred, replaced, atau spellCorrected. Lihat AddressComponent dalam referensi.

Konfirmasi sinyal

Address Validation API memberikan sejumlah sinyal untuk memberi tahu Anda apakah alamat harus dikonfirmasi.

1. Perincian Validasi

validationGranularity ROUTE atau lebih baik dapat diterima, tetapi PREMISE atau SUBPREMISE memberikan sinyal keterkiriman yang lebih kuat.

2. Sinyal lainnya

Saat memutuskan untuk mengonfirmasi entri alamat dengan pelanggan, verdict juga memberikan hal berikut untuk menentukan komponen yang akan diselidiki:

Data yang disimpulkan Jika kolom hasInferredComponents adalah true, Anda tahu bahwa API mengisi informasi yang diperoleh dari komponen alamat lainnya.
Data yang diganti Jika kolom hasReplacedComponents adalah true, API akan mengganti data yang dimasukkan dengan data yang dianggapnya membuat alamat valid.

3. Sinyal alamat AS

Kolom tertentu yang hanya berlaku untuk alamat AS menunjukkan bahwa logika Anda harus mengonfirmasi detail dengan pelanggan. Salah satu dari hal berikut berlaku:

dpvConfirmation S

Untuk mengetahui detail tentang dpvConfirmation, lihat Menangani alamat Amerika Serikat.
Respons alamat Berisi kolom missingComponentType dengan nilai subpremise.

Contoh konfirmasi alamat

Menerima alamat

Anda menerima alamat jika verdict memberikan tingkat keyakinan yang tinggi bahwa alamat dapat dikirim dan dapat digunakan tanpa interaksi pelanggan lebih lanjut dalam proses downstream.

Menerima sinyal

Address Validation API memberikan sejumlah sinyal untuk memberi tahu Anda apakah alamat harus dikonfirmasi.

1. Perincian Validasi

validationGranularity PREMISE atau lebih baik dapat diterima, tetapi dalam beberapa kasus, ROUTE masih menunjukkan alamat yang dapat dikirim.

2. Sinyal lainnya

Verdict untuk alamat berkualitas tinggi juga harus memberikan hal berikut:

  • Tidak ada data yang diganti. Dalam hal ini, hasReplacedComponents: FALSE.
  • Tidak ada komponen yang disimpulkan. Dalam hal ini, hasInferredComponents: FALSE.

3. Sinyal alamat AS

Kolom tertentu yang hanya berlaku untuk alamat AS menunjukkan alamat berkualitas tinggi yang dapat dikirimi paket. Untuk alamat AS yang dapat diterima, Anda akan melihat hal berikut:

dpvConfirmation Y

Untuk mengetahui detail tentang dpvConfirmation, lihat Menangani alamat Amerika Serikat.

Contoh alamat yang dapat diterima

Sebelumnya
Memahami respons dasar