AddressValidation class
Class
google.maps.addressValidation.AddressValidation
Class statis untuk mengakses AddressValidation API.
Akses dengan memanggil const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Metode Statis | |
|---|---|
fetchAddressValidation |
fetchAddressValidation(request)Parameter:
Nilai yang Ditampilkan:
Promise<AddressValidation>Memvalidasi alamat. Lihat https://developers.google.com/maps/documentation/javascript/address-validation/validate-address. |
Properti | |
|---|---|
address |
Jenis:
Address optionalInformasi tentang alamat itu sendiri, bukan geocode. |
geocode |
Jenis:
Geocode optionalInformasi tentang lokasi dan tempat yang di-geocoding ke alamat. |
metadata |
Jenis:
AddressMetadata optionalInformasi lain yang relevan dengan kemampuan pengiriman. metadata tidak dijamin akan terisi sepenuhnya untuk setiap alamat yang dikirim ke Address Validation API. |
responseId |
Jenis:
string optionalUUID yang mengidentifikasi respons ini. Jika alamat perlu divalidasi ulang, UUID ini harus disertakan dalam permintaan baru. |
uspsData |
Jenis:
USPSData optionalFlag tambahan terkait kualitas pengiriman yang disediakan oleh USPS. Hanya disediakan di wilayah US dan PR. |
verdict |
Jenis:
Verdict optionalFlag verdict keseluruhan |
Metode | |
|---|---|
toJSON |
toJSON()Parameter: Tidak ada
Nilai yang Ditampilkan:
ObjectMengonversi class AddressValidation menjadi objek JSON dengan properti yang sama. |
Antarmuka AddressValidationRequest
google.maps.addressValidation.AddressValidationRequest
interface
Antarmuka permintaan untuk AddressValidation.fetchAddressValidation.
Properti | |
|---|---|
address |
Jenis:
PostalAddressLiteralAlamat sedang divalidasi. Alamat yang tidak diformat harus dikirimkan melalui PostalAddress.addressLines. |
placeAutocompleteElement optional |
Jenis:
PlaceAutocompleteElement optionalJika menggunakan PlaceAutocompleteElement, sertakan di sini untuk menautkan panggilan AddressValidation API dengan token sesi pelengkapan otomatis. |
previousResponseId optional |
Jenis:
string optionalKolom ini tidak boleh disetel untuk permintaan validasi alamat pertama. Jika diperlukan lebih banyak permintaan untuk memvalidasi satu alamat sepenuhnya (misalnya, jika perubahan yang dilakukan pengguna setelah validasi awal perlu divalidasi ulang), setiap permintaan lanjutan harus mengisi kolom ini dengan AddressValidation.responseId dari respons pertama dalam urutan validasi. |
sessionToken optional |
Jenis:
AutocompleteSessionToken optionalToken yang mengidentifikasi sesi Pelengkapan Otomatis untuk tujuan penagihan. |
uspsCASSEnabled optional |
Jenis:
boolean optionalMengaktifkan mode yang kompatibel dengan CASS USPS. Hal ini hanya memengaruhi kolom AddressValidation.uspsData dari AddressValidation. Catatan: untuk permintaan yang diaktifkan USPS CASS untuk alamat di Puerto Riko, PostalAddress.regionCode dari address harus diberikan sebagai "PR", atau PostalAddress.administrativeArea dari address harus diberikan sebagai "Puerto Rico" (tidak peka huruf besar/kecil) atau "PR". |
Address class
Class
google.maps.addressValidation.Address
Detail alamat yang diproses setelahnya. Pemrosesan pasca-pemetaan mencakup mengoreksi bagian alamat yang salah eja, mengganti bagian yang salah, dan menyimpulkan bagian yang tidak ada.
Akses dengan memanggil const {Address} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
components |
Jenis:
Array<AddressComponent>Komponen alamat individual dari alamat yang diformat dan dikoreksi, beserta informasi validasi. Hal ini memberikan informasi tentang status validasi setiap komponen. |
formattedAddress |
Jenis:
string optionalAlamat yang diproses pasca-pemrosesan, diformat sebagai alamat satu baris yang mengikuti aturan pemformatan alamat di wilayah tempat alamat berada. |
missingComponentTypes |
Jenis:
Array<string>Jenis komponen yang seharusnya ada dalam alamat surat yang diformat dengan benar, tetapi tidak ditemukan dalam input DAN tidak dapat disimpulkan. Komponen jenis ini tidak ada di formatted_address, postal_address, atau address_components. Contohnya adalah ['street_number', 'route'] untuk input seperti "Boulder, Colorado, 80301, USA". Daftar kemungkinan jenis dapat ditemukan di sini. |
postalAddress |
Jenis:
PostalAddress optionalAlamat yang diproses setelahnya ditampilkan sebagai alamat pos. |
unconfirmedComponentTypes |
Jenis:
Array<string>Jenis komponen yang ada di address_components tetapi tidak dapat dikonfirmasi kebenarannya. Kolom ini disediakan untuk memudahkan: isinya setara dengan melakukan iterasi melalui address_components untuk menemukan jenis semua komponen yang AddressComponent.confirmationLevel-nya bukan ConfirmationLevel.CONFIRMED atau tanda AddressComponent.inferred tidak disetel ke true. Daftar kemungkinan jenis dapat ditemukan di sini. |
unresolvedTokens |
Jenis:
Array<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 tidak terselesaikan mungkin terlihat seperti ["123235253253"] karena tidak terlihat seperti nomor jalan yang valid. |
Kelas AddressComponent
Class
google.maps.addressValidation.AddressComponent
Mewakili satu komponen alamat (mis. nama jalan, kota).
Akses dengan memanggil const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
componentName |
Jenis:
string optionalTeks nama komponen. Misalnya, "5th Avenue" untuk nama jalan atau "1253" untuk nomor jalan, |
componentNameLanguageCode |
Jenis:
string optionalKode bahasa BCP-47. Ini tidak akan ada jika nama komponen tidak dikaitkan dengan bahasa, seperti nomor jalan. |
componentType |
Jenis:
string optionalJenis komponen alamat. Lihat Tabel 2: Jenis tambahan yang ditampilkan oleh layanan Places untuk mengetahui daftar kemungkinan jenis. |
confirmationLevel |
Jenis:
ConfirmationLevel optionalMenunjukkan tingkat kepastian bahwa komponen sudah benar. |
inferred |
Jenis:
booleanJika benar, komponen ini bukan bagian dari input, tetapi disimpulkan untuk lokasi alamat. Komponen ini direkomendasikan untuk alamat lengkap. |
replaced |
Jenis:
booleanMenunjukkan bahwa nama komponen diganti dengan nama yang sama sekali berbeda. Misalnya, mengganti kode pos yang salah dengan kode pos yang benar untuk alamat tersebut. Ini bukan perubahan tampilan; komponen input telah diubah ke komponen lain. |
spellCorrected |
Jenis:
booleanMenunjukkan koreksi pada kesalahan ejaan dalam nama komponen. API tidak selalu menandai perubahan dari satu varian ejaan ke varian ejaan lainnya, seperti "centre" menjadi "center". |
unexpected |
Jenis:
booleanJika benar (true), komponen ini tidak diharapkan ada dalam alamat pos untuk wilayah tertentu. Kata ini dipertahankan hanya karena merupakan bagian dari input. |
Kelas AddressMetadata
Class
google.maps.addressValidation.AddressMetadata
Metadata untuk alamat. AddressMetadata tidak dijamin akan terisi sepenuhnya untuk setiap alamat yang dikirim ke Address Validation API.
Akses dengan memanggil const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
business |
Jenis:
boolean |
poBox |
Jenis:
boolean |
residential |
Jenis:
boolean |
Konstanta ConfirmationLevel
google.maps.addressValidation.ConfirmationLevel
konstanta
Berbagai kemungkinan nilai yang menunjukkan tingkat kepastian bahwa komponen tersebut benar.
Akses dengan memanggil const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Konstanta | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Geocode class
Class
google.maps.addressValidation.Geocode
Berisi informasi tentang tempat input di-geocoding.
Akses dengan memanggil const {Geocode} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
bounds |
Jenis:
LatLngBounds optionalBatas tempat yang di-geocoding. |
featureSizeMeters |
Jenis:
number optionalUkuran tempat yang di-geocoding, dalam meter. Ini adalah ukuran lain dari kekasaran lokasi yang di-geocode, tetapi dalam ukuran fisik, bukan dalam makna semantik. |
location |
Jenis:
LatLngAltitude optionalLokasi input yang di-geocoding. |
placeId |
Jenis:
string optionalID Tempat dari tempat yang di-geocoding. Penggunaan Place lebih disarankan daripada menggunakan alamat, koordinat lintang/bujur, atau plus codes. Menggunakan koordinat untuk merutekan atau menghitung petunjuk arah mengemudi akan selalu menghasilkan titik yang disesuaikan dengan jalan terdekat dengan koordinat tersebut. Jalan ini mungkin bukan jalan yang akan mengarah ke tujuan dengan cepat atau aman dan mungkin tidak dekat dengan titik akses ke properti. Selain itu, saat lokasi di-geocode balik, tidak ada jaminan bahwa alamat yang ditampilkan akan cocok dengan alamat asli. |
placeTypes |
Jenis:
Array<string>Jenis tempat yang di-geocoding inputnya. Misalnya, ['locality', 'political']. Daftar lengkap jenis dapat ditemukan di dokumentasi Geocoding API. |
plusCode |
Jenis:
PlusCode optionalPlus Codes yang sesuai dengan location. |
Metode | |
|---|---|
fetchPlace |
fetchPlace()Parameter: Tidak ada
Nilai yang Ditampilkan: Tidak Ada
Menampilkan representasi Place dari Geocode ini. Untuk mendapatkan detail lengkap tempat, panggilan ke place.fetchFields() harus dilakukan. |
Konstanta perincian
google.maps.addressValidation.Granularity
konstanta
Berbagai perincian yang dapat dimiliki alamat atau geocode. Jika digunakan untuk menunjukkan perincian alamat, nilai ini menunjukkan seberapa rinci alamat mengidentifikasi tujuan pengiriman. Misalnya, alamat seperti "123 Main Street, Redwood City, CA, 94061" mengidentifikasi PREMISE, sedangkan sesuatu 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.
Akses dengan memanggil const {Granularity} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Konstanta | |
|---|---|
BLOCK |
Alamat atau geocode menunjukkan blok. Hanya digunakan di wilayah yang memiliki pengalamatan tingkat blok, seperti Jepang. |
OTHER |
Semua perincian lainnya, yang dikelompokkan bersama karena tidak dapat ditayangkan. |
PREMISE |
Hasil tingkat bangunan. |
PREMISE_PROXIMITY |
Geocode yang memperkirakan lokasi alamat di tingkat bangunan. |
ROUTE |
Geocode atau alamat bersifat terperinci ke rute, seperti jalan, jalan raya, atau jalan tol. |
SUB_PREMISE |
Hasil tingkat di bawah bangunan, seperti apartemen. |
Konstanta PossibleNextAction
google.maps.addressValidation.PossibleNextAction
konstanta
Menawarkan ringkasan interpretatif dari respons API, yang dimaksudkan untuk membantu menentukan potensi tindakan selanjutnya yang harus dilakukan. Kolom ini berasal dari kolom lain dalam respons API dan tidak boleh dianggap sebagai jaminan akurasi atau kemampuan pengiriman alamat.
Akses dengan memanggil const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Konstanta | |
|---|---|
ACCEPT |
Respons API tidak berisi sinyal yang menjamin salah satu nilai PossibleNextAction lainnya. Anda dapat mempertimbangkan untuk menggunakan alamat yang telah diproses tanpa meminta pelanggan lebih lanjut, meskipun hal ini tidak menjamin kevalidan alamat, dan alamat mungkin masih berisi koreksi. Anda bertanggung jawab untuk menentukan apakah dan bagaimana cara meminta pelanggan Anda, bergantung pada penilaian risiko Anda sendiri. |
CONFIRM |
Satu atau beberapa kolom respons API menunjukkan potensi masalah kecil pada alamat yang diproses pasca-pemrosesan, misalnya komponen alamat postal_code adalah replaced. Mendorong pelanggan untuk meninjau alamat dapat membantu meningkatkan kualitas alamat. |
CONFIRM_ADD_SUBPREMISES |
Respons API menunjukkan bahwa alamat yang diproses pasca-pemrosesan mungkin tidak memiliki sub-lokasi. Mengarahkan pelanggan untuk meninjau alamat dan mempertimbangkan untuk menambahkan nomor unit dapat membantu meningkatkan kualitas alamat. Alamat yang diproses pasca-pemrosesan juga mungkin memiliki masalah kecil lainnya. Catatan: nilai enum ini hanya dapat ditampilkan untuk alamat AS. |
FIX |
Satu atau beberapa kolom respons API menunjukkan potensi masalah pada alamat yang diproses pasca-pemrosesan, misalnya verdict.validation_granularity adalah OTHER. Mengarahkan pelanggan untuk mengedit alamat dapat membantu meningkatkan kualitas alamat. |
USPSAddress class
Class
google.maps.addressValidation.USPSAddress
Representasi USPS dari alamat AS.
Akses dengan memanggil const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
city |
Jenis:
string optionalNama kota. |
cityStateZipAddressLine |
Jenis:
string optionalBaris alamat yang berisi kota, negara bagian, dan kode pos. |
firm |
Jenis:
string optionalNama perusahaan. |
firstAddressLine |
Jenis:
string optionalBaris pertama alamat. |
secondAddressLine |
Jenis:
string optionalBaris kedua alamat. |
state |
Jenis:
string optionalKode negara bagian 2 huruf. |
urbanization |
Jenis:
string optionalNama urbanisasi Puerto Riko. |
zipCode |
Jenis:
string optionalKode pos, misalnya "10009". |
zipCodeExtension |
Jenis:
string optionalEkstensi kode pos 4 digit, misalnya "5023". |
USPSData class
Class
google.maps.addressValidation.USPSData
Data USPS untuk alamat. USPSData tidak dijamin akan terisi sepenuhnya untuk setiap alamat AS atau PR yang dikirim ke Address Validation API. Sebaiknya integrasikan kolom alamat cadangan dalam respons jika Anda menggunakan uspsData sebagai bagian utama respons.
Akses dengan memanggil const {USPSData} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
abbreviatedCity |
Jenis:
string optionalKota singkat. |
addressRecordType |
Jenis:
string optionalJenis catatan alamat yang cocok dengan alamat input. |
carrierRoute |
Jenis:
string optionalKode rute ekspedisi. Kode empat karakter yang terdiri dari awalan satu huruf dan penentu rute tiga digit. |
carrierRouteIndicator |
Jenis:
string optionalIndikator pengurutan tarif rute ekspedisi. |
cassProcessed |
Jenis:
booleanIndikator bahwa permintaan telah diproses CASS. |
county |
Jenis:
string optionalNama county. |
deliveryPointCheckDigit |
Jenis:
string optionalDigit pengecek titik pengiriman. Nomor ini ditambahkan ke akhir kode batang titik pengiriman untuk surat yang dipindai secara mekanis. Menambahkan semua digit delivery_point_barcode, delivery_point_check_digit, kode pos, dan ZIP+4 akan menghasilkan angka yang dapat dibagi 10. |
deliveryPointCode |
Jenis:
string optionalKode titik pengiriman 2 digit. |
dpvCMRA |
Jenis:
string optionalMenunjukkan apakah alamat tersebut adalah CMRA (Commercial Mail Receiving Agency)--bisnis pribadi yang menerima surat untuk klien. Menampilkan satu karakter. |
dpvConfirmation |
Jenis:
string optionalKemungkinan nilai untuk konfirmasi DPV. Menampilkan satu karakter atau tidak menampilkan nilai. |
dpvDoorNotAccessible |
Jenis:
string optionalTanda menunjukkan alamat yang tidak dapat dikunjungi USPS untuk mengantarkan surat. Menampilkan satu karakter. |
dpvDrop |
Jenis:
string optionalBendera menunjukkan bahwa surat dikirim ke satu wadah di suatu lokasi. Menampilkan satu karakter. |
dpvEnhancedDeliveryCode |
Jenis:
string optionalMenunjukkan bahwa lebih dari satu kode respons DPV valid untuk alamat tersebut. Menampilkan satu karakter. |
dpvFootnote |
Jenis:
string optionalCatatan kaki dari validasi titik pengiriman. Beberapa catatan kaki dapat digabungkan dalam string yang sama. |
dpvNonDeliveryDays |
Jenis:
string optionalTanda menunjukkan bahwa pengiriman surat tidak dilakukan setiap hari dalam seminggu. Menampilkan satu karakter. |
dpvNonDeliveryDaysValues |
Jenis:
number optionalBilangan bulat yang mengidentifikasi hari gagal tayang. Dapat diinterogasi menggunakan flag bit: 0x40 – Hari Minggu adalah hari tidak ada pengiriman 0x20 – Hari Senin adalah hari tidak ada pengiriman 0x10 – Hari Selasa adalah hari tidak ada pengiriman 0x08 – Hari Rabu adalah hari tidak ada pengiriman 0x04 – Hari Kamis adalah hari tidak ada pengiriman 0x02 – Hari Jumat adalah hari tidak ada pengiriman 0x01 – Hari Sabtu adalah hari tidak ada pengiriman |
dpvNoSecureLocation |
Jenis:
string optionalBendera menunjukkan bahwa pintu dapat diakses, tetapi paket tidak akan ditinggalkan karena masalah keamanan. Menampilkan satu karakter. |
dpvNoStat |
Jenis:
string optionalMenunjukkan apakah alamat adalah alamat tanpa statistik atau alamat aktif. Alamat non-stat adalah alamat yang tidak ditempati secara terus-menerus atau alamat yang tidak dilayani oleh USPS. Menampilkan satu karakter. |
dpvNoStatReasonCode |
Jenis:
number optionalMenunjukkan jenis NoStat. Menampilkan kode alasan sebagai int. |
dpvPBSA |
Jenis:
string optionalMenunjukkan bahwa alamat cocok dengan data PBSA. Menampilkan satu karakter. |
dpvThrowback |
Jenis:
string optionalMenunjukkan bahwa surat tidak dikirim ke alamat jalan. Menampilkan satu karakter. |
dpvVacant |
Jenis:
string optionalMenunjukkan apakah alamat kosong. Menampilkan satu karakter. |
elotFlag |
Jenis:
string optionalFlag Menaik/Menurun eLOT (A/D). |
elotNumber |
Jenis:
string optionalNomor Jalur Perjalanan yang Ditingkatkan (eLOT). |
errorMessage |
Jenis:
string optionalPesan error untuk pengambilan data USPS. Kolom ini diisi saat pemrosesan USPS ditangguhkan karena terdeteksi alamat yang dibuat secara artifisial. |
fipsCountyCode |
Jenis:
string optionalKode county FIPS. |
hasDefaultAddress |
Jenis:
booleanIndikator bahwa alamat default ditemukan, tetapi ada alamat yang lebih spesifik. |
hasNoEWSMatch |
Jenis:
booleanAlamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa kecocokan persis akan segera tersedia. |
lacsLinkIndicator |
Jenis:
string optionalIndikator LACSLink. |
lacsLinkReturnCode |
Jenis:
string optionalKode respons LACSLink. |
pmbDesignator |
Jenis:
string optionalPenentu desain unit PMB (Private Mail Box). |
pmbNumber |
Jenis:
string optionalNomor PMB (Private Mail Box). |
poBoxOnlyPostalCode |
Jenis:
booleanKode pos khusus kotak PO. |
postOfficeCity |
Jenis:
string optionalKota kantor pos utama. |
postOfficeState |
Jenis:
string optionalNegara bagian kantor pos utama. |
standardizedAddress |
Jenis:
USPSAddress optionalAlamat standar USPS. |
suiteLinkFootnote |
Jenis:
string optionalCatatan kaki dari pencocokan data jalan atau bangunan tinggi dengan informasi unit. Jika kecocokan nama bisnis ditemukan, nomor sekunder akan ditampilkan. |
Class Verdict
Class
google.maps.addressValidation.Verdict
Mewakili alamat yang diproses setelahnya untuk alamat yang diberikan.
Akses dengan memanggil const {Verdict} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
Properti | |
|---|---|
addressComplete |
Jenis:
booleanAlamat dianggap lengkap jika tidak ada token yang belum terselesaikan, tidak ada komponen alamat yang tidak terduga atau hilang. Jika tidak disetel, menunjukkan bahwa nilainya adalah false. Lihat kolom Address.missingComponentTypes, Address.unresolvedTokens, atau AddressComponent.unexpected untuk mengetahui detail selengkapnya. |
geocodeGranularity |
Jenis:
Granularity optionalInformasi tentang perincian Geocode. Hal ini dapat dipahami sebagai makna semantik seberapa kasar atau akurat lokasi yang di-geocoding. |
hasInferredComponents |
Jenis:
booleanSetidaknya satu komponen alamat disimpulkan (yaitu ditambahkan) yang tidak ada dalam input, lihat AddressComponent untuk mengetahui detailnya. |
hasReplacedComponents |
Jenis:
boolean optionalSetidaknya satu komponen alamat diganti - lihat AddressComponent untuk mengetahui detailnya. |
hasUnconfirmedComponents |
Jenis:
booleanSetidaknya satu komponen alamat tidak dapat dikategorikan atau divalidasi, lihat AddressComponent untuk mengetahui detailnya. |
inputGranularity |
Jenis:
Granularity optionalPerincian alamat input. Ini adalah hasil parsing alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat validationGranularity. |
possibleNextAction |
Jenis:
PossibleNextAction optionalKemungkinan tindakan berikutnya yang harus dilakukan berdasarkan kolom lain dalam respons API. Lihat PossibleNextAction untuk detailnya. |
validationGranularity |
Jenis:
Granularity optionalTingkat perincian yang dapat digunakan API untuk memvalidasi alamat sepenuhnya. Misalnya, validationGranularity PREMISE menunjukkan bahwa semua komponen alamat di tingkat PREMISE dan yang lebih luas dapat divalidasi. |