Package google.maps.addressvalidation.v1

Indeks

Validasi Alamat

Layanan untuk memvalidasi alamat.

MemberikanValidasiValidasi

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

Masukan tentang hasil urutan upaya validasi. Ini harus menjadi panggilan terakhir yang dilakukan setelah urutan panggilan validasi untuk alamat yang sama, dan harus dipanggil setelah transaksi selesai. URL ini hanya boleh dikirim sekali untuk urutan permintaan ValidateAddress yang diperlukan guna memvalidasi alamat sepenuhnya.
ValidasiAlamat

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

Memvalidasi alamat.

Alamat

Detail alamat yang telah diproses ulang. Pasca-pemrosesan termasuk mengoreksi bagian alamat yang salah eja, mengganti bagian yang salah, dan menyimpulkan bagian yang hilang.

Kolom
formatted_address

string

Alamat yang telah diproses sebelumnya, yang diformat sebagai alamat baris tunggal mengikuti aturan format alamat wilayah tempat alamat tersebut berada.
postal_address

PostalAddress

Alamat yang telah diproses yang ditampilkan sebagai alamat pos.
address_components[]

AddressComponent

Daftar tidak berurutan. Komponen alamat individual dari alamat yang diformat dan dikoreksi, beserta informasi validasi. Kolom ini memberikan informasi tentang status validasi masing-masing komponen.

Komponen alamat tidak diurutkan dengan cara tertentu. Jangan membuat asumsi tentang urutan komponen alamat dalam daftar.
missing_component_types[]

string

Jenis komponen yang diharapkan ada di alamat surat yang diformat dengan benar, tetapi tidak ditemukan di input DAN tidak dapat disimpulkan. Komponen jenis ini tidak ada di formatted_address, postal_address, atau address_components. Contohnya mungkin adalah ['street_number', 'route'] untuk input seperti "Boulder, Colorado, 80301, USA". Daftar kemungkinan jenisnya dapat ditemukan di sini.
unconfirmed_component_types[]

string

Jenis komponen yang ada di address_components tetapi tidak dapat dikonfirmasi sebagai benar. Kolom ini disediakan demi kenyamanan: kontennya setara dengan iterasi melalui address_components untuk menemukan jenis semua komponen dengan confirmation_level bukan CONFIRMED atau flag inferred tidak ditetapkan ke true. Daftar kemungkinan jenisnya dapat ditemukan di sini.
unresolved_tokens[]

string

Token apa pun dalam input yang tidak dapat diselesaikan. Ini mungkin merupakan input yang tidak dikenali sebagai bagian alamat yang valid (misalnya dalam input seperti "123235253253 Main St, San Francisco, CA, 94105", token yang belum terselesaikan mungkin terlihat seperti ["123235253253"] karena tidak terlihat seperti nomor jalan yang valid.

AddressComponent

Mewakili komponen alamat, seperti jalan, kota, atau negara bagian.

Kolom
component_name

ComponentName

Nama untuk komponen ini.
component_type

string

Jenis komponen alamat. Lihat Tabel 2: Jenis tambahan yang ditampilkan oleh layanan Places untuk daftar kemungkinan jenis.
confirmation_level

ConfirmationLevel

Menunjukkan tingkat kepastian yang kita miliki bahwa komponen sudah benar.
inferred

bool

Menunjukkan bahwa komponen bukan bagian dari input, tetapi kami menyimpulkannya untuk lokasi alamat dan yakin bahwa komponen tersebut harus disediakan untuk alamat yang lengkap.
spell_corrected

bool

Mengindikasikan ejaan nama komponen yang telah dikoreksi dengan cara yang kecil, misalnya dengan mengalihkan dua karakter yang muncul dalam urutan yang salah. Ini menunjukkan perubahan tampilan.
replaced

bool

Menunjukkan bahwa nama komponen diganti dengan nama yang sama sekali berbeda, misalnya kode pos yang salah diganti dengan yang benar untuk alamat. Ini bukan perubahan kosmetik, komponen input telah diubah menjadi komponen lain.
unexpected

bool

Mengindikasikan komponen alamat yang tidak diharapkan ada di alamat pos untuk wilayah tertentu. Kami mempertahankannya hanya karena merupakan bagian dari input.

Tingkat Konfirmasi

Nilai yang berbeda yang mungkin untuk tingkat konfirmasi.

Enumerasi
CONFIRMATION_LEVEL_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
CONFIRMED Kami dapat memverifikasi bahwa komponen ini ada dan masuk akal dalam konteks alamat lainnya.
UNCONFIRMED_BUT_PLAUSIBLE Komponen ini tidak dapat dikonfirmasi, tetapi masuk akal jika komponen tersebut ada. Misalnya, nomor jalan dalam rentang nomor valid yang diketahui di jalan yang nomor rumah spesifiknya tidak diketahui.
UNCONFIRMED_AND_SUSPICIOUS Komponen ini belum dikonfirmasi dan kemungkinan salah. Misalnya, lingkungan yang tidak cocok dengan sisa alamat.

AddressMetadata

Metadata alamat. metadata tidak dijamin akan terisi penuh untuk setiap alamat yang dikirim ke Address Validation API.

Kolom
business

bool

Menunjukkan bahwa ini adalah alamat bisnis. Jika tidak disetel, menunjukkan bahwa nilai tidak diketahui.
po_box

bool

Menunjukkan bahwa alamat kotak PO. Jika tidak disetel, menunjukkan bahwa nilai tidak diketahui.
residential

bool

Menunjukkan bahwa ini adalah alamat tempat tinggal. Jika tidak disetel, menunjukkan bahwa nilai tidak diketahui.

NamaKomponen

Wrapper untuk nama komponen.

Kolom
text

string

Teks nama. Misalnya, "5th Avenue" untuk nama jalan atau "1253" untuk nomor jalan.
language_code

string

Kode bahasa BCP-47. Nama komponen tidak akan ada jika nama komponen tidak terkait dengan bahasa, seperti nomor jalan.

Geocode

Berisi informasi tentang tempat input di-geocode.

Kolom
location

LatLng

Lokasi input yang di-geocode.

ID tempat lebih disarankan daripada menggunakan alamat, koordinat lintang/bujur, atau kode plus. Menggunakan koordinat saat mengarahkan atau menghitung rute mobil akan selalu mengakibatkan titik dipaskan ke jalan terdekat dengan koordinat tersebut. Ini mungkin bukan jalan yang akan mengarah ke tujuan dengan cepat atau aman dan mungkin tidak dekat dengan titik akses ke properti. Selain itu, jika lokasi di-geocoding terbalik, tidak ada jaminan bahwa alamat yang ditampilkan akan cocok dengan alamat asli.
plus_code

PlusCode

Plus Codes yang sesuai dengan location.
bounds

Viewport

Batas tempat yang di-geocode.
feature_size_meters

float

Ukuran tempat yang di-geocode, dalam meter. Ini adalah ukuran lain dari kekasaran lokasi geocode, tetapi dalam ukuran fisik dan bukan pada makna semantik.
place_id

string

PlaceID tempat input ini melakukan geocoding.

Untuk informasi selengkapnya tentang ID Tempat, lihat di sini.
place_types[]

string

Jenis tempat input di-geocode. Misalnya, ['locality', 'political']. Daftar lengkap jenis dapat ditemukan di sini.

Plus Codes

Plus Codes (http://plus.codes) adalah referensi lokasi dengan dua format: kode global yang menentukan 14mx14m (1/8000 derajat) atau persegi panjang yang lebih kecil, dan kode gabungan, menggantikan awalan dengan lokasi referensi.

Kolom
global_code

string

Kode global (lengkap) tempat, seperti "9FWM33GV+HQ", yang mewakili area 1/8000 x 1/8000 derajat (~14 kali 14 meter).
compound_code

string

Kode gabungan tempat, seperti "33GV+HQ, Ramberg, Norwegia", yang berisi akhiran kode global dan mengganti awalan dengan nama berformat dari entitas referensi.

MenyediakanValidValidFeedbackRequest

Permintaan untuk mengirimkan masukan validasi.

Kolom
conclusion

ValidationConclusion

Wajib diisi. Hasil dari urutan upaya validasi.

Jika kolom ini disetel ke VALIDATION_CONCLUSION_UNSPECIFIED, error INVALID_ARGUMENT akan ditampilkan.
response_id

string

Wajib diisi. ID respons yang menerima masukan ini. Ini harus berupa [response_id][google.maps.addressvalidate.v1.ValidateAddressRequest.response_id] dari respons pertama dalam serangkaian upaya validasi alamat.

Kesimpulan Validasi

Kemungkinan hasil akhir dari urutan permintaan validasi alamat yang diperlukan untuk memvalidasi alamat.

Enumerasi
VALIDATION_CONCLUSION_UNSPECIFIED Nilai ini tidak digunakan. Jika kolom ProvideValidationFeedbackRequest.conclusion ditetapkan ke VALIDATION_CONCLUSION_UNSPECIFIED, error INVALID_ARGUMENT akan ditampilkan.
VALIDATED_VERSION_USED Versi alamat yang ditampilkan oleh Address Validation API digunakan untuk transaksi.
USER_VERSION_USED Versi alamat yang diberikan oleh pengguna digunakan untuk transaksi
UNVALIDATED_VERSION_USED Versi alamat yang dimasukkan setelah upaya validasi terakhir tetapi tidak divalidasi ulang digunakan untuk transaksi.
UNUSED Transaksi diabaikan dan alamatnya tidak digunakan.

MemberikanValidationResponsResponse

Respons untuk masukan validasi.

Respons akan kosong jika masukan berhasil dikirim.

Alamat Usps

Representasi USPS dari alamat di AS.

Kolom
first_address_line

string

Baris alamat pertama.
firm

string

Nama firma.
second_address_line

string

Baris alamat kedua.
urbanization

string

Nama urbanisasi di Puerto Riko.
city_state_zip_address_line

string

Kota + negara bagian + kode pos.
city

string

Nama kota.
state

string

Kode status 2 huruf.
zip_code

string

Kode pos, mis. 10009.
zip_code_extension

string

Ekstensi kode pos 4 digit, mis. 5023.

UspsData

Data USPS untuk alamat. uspsData tidak dijamin akan terisi penuh untuk setiap alamat PR AS atau yang dikirim ke API Validasi Alamat. Sebaiknya integrasikan kolom alamat cadangan dalam respons jika Anda menggunakan uspsData sebagai bagian utama dari respons.

Kolom
standardized_address

UspsAddress

Alamat standar USPS.
delivery_point_code

string

Kode titik pengiriman 2 digit
delivery_point_check_digit

string

Digit pengecek titik pengiriman. Nomor ini ditambahkan ke bagian akhir delivery_point_barcode untuk email yang dipindai secara mekanis. Menambahkan semua digit delivery_point_barcode, delivery_point_check_digit, kode pos, dan ZIP+4 secara bersamaan akan menghasilkan angka yang habis dibagi 10.
dpv_confirmation

string

Nilai yang memungkinkan untuk konfirmasi DPV. Menampilkan satu karakter.

  • Y: Alamat telah dikonfirmasi DPV untuk nomor utama dan sekunder.
  • N: Informasi nomor utama dan sekunder gagal mengonfirmasi DPV.
  • S: Alamat telah dikonfirmasi DPV hanya untuk nomor utama, dan informasi nomor sekunder tidak ada karena dikonfirmasi.
  • D: Alamat hanya dikonfirmasi DPV untuk nomor utama, dan informasi nomor sekunder tidak ada.
dpv_footnote

string

Catatan kaki dari validasi titik pengiriman. Beberapa catatan kaki dapat dirangkai dalam string yang sama.

  • AA: Alamat input cocok dengan file ZIP+4
  • A1: Alamat input tidak cocok dengan file ZIP+4
  • BB: Cocok dengan DPV (semua komponen)
  • CC: Nomor sekunder tidak cocok (saat ini tetapi tidak valid)
  • N1: Alamat sekunder bertingkat tinggi tidak memiliki nomor sekunder
  • M1: Nomor utama tidak ada
  • M3: Nomor utama tidak valid
  • P1: Nomor RR atau HC alamat input tidak ada
  • P3: Nomor alamat PO, RR, atau HC Kotak masukan tidak valid
  • F1: Alamat input yang cocok dengan alamat militer
  • G1: Alamat input cocok dengan alamat pengiriman umum
  • U1: Alamat input cocok dengan kode pos unik
  • PB: Alamat input cocok dengan data PBSA
  • RR: Alamat yang dikonfirmasi DPV dengan informasi PMB
  • R1: Alamat yang dikonfirmasi DPV tanpa informasi PMB
  • R7: Data Rute R777 atau R779 dari Operator
dpv_cmra

string

Menunjukkan apakah alamatnya adalah CMRA (Commercial Mail Recipient Agency)--bisnis pribadi yang menerima email untuk klien. Menampilkan satu karakter.

  • Y: Alamatnya adalah CMRA
  • N: Alamatnya bukan CMRA
dpv_vacant

string

Apakah tempat ini kosong? Menampilkan satu karakter.

  • Y: Alamat kosong
  • N: Alamat tidak kosong
dpv_no_stat

string

Apakah ini alamat statis atau alamat yang aktif? Tidak ada alamat statistik yang tidak terus-menerus terisi atau alamat yang tidak dilayani USPS. Menampilkan satu karakter.

  • Y: Alamat tidak aktif
  • N: Alamat aktif
carrier_route

string

Kode rute jasa kurir. Kode empat karakter yang terdiri dari awalan satu huruf dan penanda rute tiga digit.

Awalan:

  • C: Rute jasa kurir (atau rute kota)
  • R: Rute pedesaan
  • H: Rute Kontrak Jalan Raya
  • B: Bagian Kotak Pos
  • G: Unit pengiriman umum
carrier_route_indicator

string

Indikator urutan tingkat rute jasa kurir.
ews_no_match

bool

Alamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa pencocokan persis akan segera tersedia.
post_office_city

string

Kota kantor pos utama.
post_office_state

string

Negara bagian utama kantor pos.
abbreviated_city

string

Singkatan kota.
fips_county_code

string

Kode county FIPS.
county

string

Nama county.
elot_number

string

Nomor Enhanced Line of Travel (eLOT).
elot_flag

string

Bendera Menaik/Menurun eLOT (A/D).
po_box_only_postal_code

bool

Kode pos hanya PO Box.
pmb_designator

string

Penanda unit PMB (Private Mail Box).
pmb_number

string

Nomor PMB (Private Mail Box);
address_record_type

string

Jenis data alamat yang cocok dengan alamat input.

  • F: FIRM Ini adalah kecocokan dengan Firm Record, yang merupakan tingkat kecocokan terbaik yang tersedia untuk alamat.
  • G: PENGIRIMAN UMUM. Hal ini cocok dengan data Pengiriman Umum.
  • H: MEMBANGUN / APARTEMEN. Hal ini cocok dengan data Gedung atau Apartemen.
  • P: KOTAK POSTINGAN RESMI. Ini adalah kecocokan dengan Kotak Pos.
  • R: RUTE RURAL atau KONTRAK TINGGI: Ini cocok dengan data Rute Pedesaan atau Kontrak Jalan Raya, keduanya mungkin memiliki rentang Nomor Kotak terkait.
  • S: REKAM JEDA: Ini cocok dengan catatan Jalan yang berisi rentang nomor utama yang valid.
default_address

bool

Indikator bahwa alamat default ditemukan, tetapi ada alamat yang lebih spesifik.
error_message

string

Pesan error untuk pengambilan data USPS. Kolom ini diisi saat pemrosesan USPS ditangguhkan karena deteksi alamat yang dibuat secara artifisial.

Kolom data USPS mungkin tidak diisi jika error ini ada.
cass_processed

bool

Indikator bahwa permintaan telah diproses oleh CASS.

ValidateAddressRequest

Permintaan untuk memvalidasi alamat.

Kolom
address

PostalAddress

Wajib diisi. Alamat sedang divalidasi. Alamat yang tidak diformat harus dikirim melalui address_lines.

Panjang total kolom dalam input ini tidak boleh melebihi 280 karakter.

Region yang didukung dapat ditemukan di sini.

Nilai language_code di alamat input disimpan untuk penggunaan di masa mendatang dan akan diabaikan hari ini. Hasil alamat yang divalidasi akan diisi berdasarkan bahasa pilihan untuk alamat yang ditentukan, seperti yang diidentifikasi oleh sistem.

Address Validation API mengabaikan nilai di recipients dan organization. Nilai apa pun dalam kolom tersebut akan dihapus dan tidak ditampilkan. Jangan menyetelnya.
previous_response_id

string

Kolom ini harus kosong untuk permintaan validasi alamat pertama. Jika ada lebih banyak permintaan yang diperlukan untuk memvalidasi satu alamat sepenuhnya (misalnya, jika perubahan yang dilakukan pengguna setelah validasi awal perlu divalidasi ulang), setiap permintaan tindak lanjut harus mengisi kolom ini dengan response_id dari respons pertama dalam urutan validasi.
enable_usps_cass

bool

Mengaktifkan mode yang kompatibel dengan USPS CASS. Ini hanya memengaruhi kolom google.maps.addressvalidation.v1.ValidationResult.usps_data dari google.maps.addressvalidation.v1.ValidationResult. Catatan: untuk permintaan yang diaktifkan USPS CASS untuk alamat di Puerto Riko, google.type.PostalAddress.region_code dari address harus diberikan sebagai "PR", atau google.type.PostalAddress.administrative_area dari address harus diberikan sebagai "Puerto Rico" (tidak peka huruf besar/kecil) atau "PR".

Sebaiknya gunakan address yang dikomponen, atau tentukan setidaknya dua google.type.PostalAddress.address_lines dengan baris pertama berisi nomor dan nama jalan serta baris kedua berisi kota, negara bagian, dan kode pos.

ValidasiAddressAddress

Respons terhadap permintaan validasi alamat.

Kolom
result

ValidationResult

Hasil validasi alamat.
response_id

string

UUID yang mengidentifikasi respons ini. Jika alamat perlu divalidasi ulang, UUID ini harus menyertai permintaan baru.

Hasil Validasi

Hasil validasi alamat.

Kolom
verdict

Verdict

Tanda putusan keseluruhan
address

Address

Informasi tentang alamat itu sendiri, bukan geocode.
geocode

Geocode

Informasi tentang lokasi dan tempat alamat di-geocode.
metadata

AddressMetadata

Informasi lain yang relevan dengan kelayakan pengiriman. metadata tidak dijamin akan terisi penuh untuk setiap alamat yang dikirim ke Address Validation API.
usps_data

UspsData

Flag hasil ekstra yang diberikan oleh USPS. Hanya disediakan di wilayah US dan PR.

Putusan

Ringkasan tingkat tinggi tentang hasil validasi alamat dan geocode.

Kolom
input_granularity

Granularity

Tingkat perincian input pada alamat. Ini adalah hasil dari penguraian alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat validation_granularity di bawah.

Misalnya, jika alamat input menyertakan nomor apartemen tertentu, input_granularity di sini akan berupa SUB_PREMISE. Jika kami tidak dapat mencocokkan nomor apartemen dalam database atau nomor apartemen tidak valid, validation_granularity kemungkinan adalah PREMISE atau lebih rendah.
validation_granularity

Granularity

Tingkat perincian yang dapat divalidasi sepenuhnya oleh API oleh alamat. Misalnya, validation_granularity dari PREMISE menunjukkan semua komponen alamat di tingkat PREMISE atau lebih kasar dapat divalidasi.

Hasil validasi komponen per alamat dapat ditemukan di google.maps.addressvalidation.v1.Address.address_components.
geocode_granularity

Granularity

Informasi tentang tingkat perincian geocode. Hal ini dapat dipahami sebagai makna semantik tentang seberapa kasar atau halus lokasi geocode.

Ini dapat berbeda dengan validation_granularity di atas sesekali. Misalnya, database kami mungkin mencatat keberadaan nomor apartemen, tetapi tidak memiliki lokasi akurat untuk apartemen dalam kompleks apartemen besar. Dalam hal ini, validation_granularity akan menjadi SUB_PREMISE, tetapi geocode_granularity akan menjadi PREMISE.
address_complete

bool

Alamat dianggap lengkap jika tidak ada token yang belum terselesaikan, tidak ada komponen alamat yang tidak terduga atau tidak ada. Lihat kolom missing_component_types, unresolved_tokens, atau unexpected untuk detail selengkapnya.
has_unconfirmed_components

bool

Setidaknya satu komponen alamat tidak dapat dikategorikan atau divalidasi, lihat google.maps.addressvalidation.v1.Address.address_components untuk mengetahui detailnya.
has_inferred_components

bool

Setidaknya satu komponen alamat disimpulkan (ditambahkan) yang tidak ada dalam input, lihat google.maps.addressvalidation.v1.Address.address_components untuk mengetahui detailnya.
has_replaced_components

bool

Setidaknya satu komponen alamat telah diganti, lihat google.maps.addressvalidation.v1.Address.address_components untuk mengetahui detailnya.

Tingkat perincian

Berbagai perincian yang dapat dimiliki alamat atau geocode. Jika digunakan untuk menunjukkan tingkat perincian alamat, nilai ini akan menunjukkan tingkat perincian alamat yang menunjukkan tujuan pengiriman. Misalnya, alamat seperti "123 Main Street, Redwood City, CA, 94061" mengidentifikasi PREMISE, sedangkan nama seperti "Redwood City, CA, 94061" mengidentifikasi LOCALITY. Namun, jika kami tidak dapat menemukan geocode untuk "123 Main Street" di Redwood City, geocode yang ditampilkan mungkin memiliki perincian LOCALITY meskipun alamatnya lebih terperinci.

Enumerasi
GRANULARITY_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
SUB_PREMISE Hasil tingkat di bawah bangunan, seperti apartemen.
PREMISE Hasil tingkat bangunan.
PREMISE_PROXIMITY Geocode yang memperkirakan lokasi tingkat gedung alamat.
BLOCK Alamat atau geocode menunjukkan blok. Hanya digunakan di wilayah yang memiliki alamat tingkat blok, seperti Jepang.
ROUTE Geocode atau alamat terperinci untuk rute, seperti jalan, jalan, atau jalan raya.
OTHER Semua perincian lainnya, yang dikelompokkan bersama karena tidak dapat ditayangkan.