Class AddressValidation
google.maps.addressValidation.AddressValidation
class
library "addressValidation"
Class statis untuk mengakses AddressValidation API.
const {AddressValidation} = await google.maps.importLibrary("addressValidation");
Metode Statis | |
|---|---|
fetchAddressValidation |
fetchAddressValidation(request)Parameter:
Nilai Hasil:
Promise<AddressValidation>Memvalidasi alamat. Lihat https://developers.google.com/maps/documentation/javascript/address-validation/validate-address. |
Properti | |
|---|---|
address
readonly |
Jenis:
Address optionalInformasi tentang alamat itu sendiri, bukan geocode. |
geocode
readonly |
Jenis:
Geocode optionalInformasi tentang lokasi dan tempat yang di-geocoding oleh alamat. |
metadata
readonly |
Jenis:
AddressMetadata optionalInformasi lain yang relevan dengan kemampuan pengiriman. metadata tidak dijamin akan diisi sepenuhnya untuk setiap alamat yang dikirim ke Address Validation API. |
responseId
readonly |
Jenis:
string optionalUUID yang mengidentifikasi respons ini. Jika alamat perlu divalidasi ulang, UUID ini harus disertakan dalam permintaan baru. |
uspsData
readonly |
Jenis:
USPSData optionalFlag kemampuan pengiriman tambahan yang disediakan oleh USPS. Hanya disediakan di region US dan PR. |
verdict
readonly |
Jenis:
Verdict optionalFlag verdict keseluruhan |
Metode | |
|---|---|
Diwarisi:
toJSON
|
Antarmuka AddressValidationRequest
Antarmuka
google.maps.addressValidation.AddressValidationRequest
Antarmuka permintaan untuk AddressValidation.fetchAddressValidation.
Properti | |
|---|---|
address |
Jenis:
PostalAddressLiteralAlamat yang divalidasi. Alamat yang tidak diformat harus dikirimkan melalui PostalAddress.addressLines. |
placeAutocompleteElement
opsional |
Jenis:
PlaceAutocompleteElement optionalJika menggunakan PlaceAutocompleteElement, sertakan di sini untuk menautkan panggilan API AddressValidation dengan token sesi pelengkapan otomatis. |
previousResponseId
opsional |
Jenis:
string optionalKolom ini tidak boleh ditetapkan untuk permintaan Address Validation 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 tindak lanjut harus mengisi kolom ini dengan AddressValidation.responseId dari respons pertama dalam urutan validasi. |
sessionToken
opsional |
Jenis:
AutocompleteSessionToken optionalToken yang mengidentifikasi sesi Autocomplete untuk tujuan penagihan. |
uspsCASSEnabled
opsional |
Jenis:
boolean optionalMengaktifkan mode kompatibel USPS CASS. Hal ini hanya memengaruhi kolom AddressValidation.uspsData dari AddressValidation. Catatan: untuk permintaan yang mengaktifkan 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". |
Class Address
google.maps.addressValidation.Address
class
library "addressValidation"
Detail alamat yang telah diproses. Pascapemrosesan mencakup perbaikan bagian alamat yang salah eja, penggantian bagian yang salah, dan inferensi bagian yang tidak ada.
const {Address} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
components
readonly |
Jenis:
Array<AddressComponent>Komponen alamat individual dari alamat yang diformat dan dikoreksi, beserta informasi validasi. Tindakan ini memberikan informasi tentang status validasi setiap komponen. |
formattedAddress
readonly |
Jenis:
string optionalAlamat yang telah diproses, diformat sebagai alamat satu baris yang mengikuti aturan pemformatan alamat di wilayah tempat alamat tersebut berada. |
missingComponentTypes
readonly |
Jenis:
Array<string>Jenis komponen yang seharusnya ada dalam alamat surat dengan format yang benar, tetapi tidak ditemukan dalam input DAN tidak dapat disimpulkan. Komponen jenis ini tidak ada di formatted_address, postal_address, atau address_components. Contohnya mungkin ['street_number', 'route'] untuk input seperti "Boulder, Colorado, 80301, USA". Daftar kemungkinan jenis dapat ditemukan di sini. |
postalAddress
readonly |
Jenis:
PostalAddress optionalAlamat yang telah diproses dan direpresentasikan sebagai alamat pos. |
unconfirmedComponentTypes
readonly |
Jenis:
Array<string>Jenis komponen yang ada di address_components, tetapi tidak dapat dikonfirmasi kebenarannya. Kolom ini disediakan untuk memudahkan: kontennya setara dengan melakukan iterasi melalui address_components untuk menemukan jenis semua komponen yang AddressComponent.confirmationLevel-nya bukan ConfirmationLevel.CONFIRMED atau flag AddressComponent.inferred-nya tidak ditetapkan ke true. Daftar kemungkinan jenis dapat ditemukan di sini. |
unresolvedTokens
readonly |
Jenis:
Array<string>Token apa pun dalam input yang tidak dapat diselesaikan. Ini mungkin merupakan input yang tidak dikenali sebagai bagian yang valid dari alamat (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. |
Metode | |
|---|---|
Diwarisi:
toJSON
|
Class AddressComponent
google.maps.addressValidation.AddressComponent
class
library "addressValidation"
Mewakili satu komponen alamat (misalnya, nama jalan, kota).
const {AddressComponent} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
componentName
readonly |
Jenis:
string optionalTeks nama komponen. Misalnya, "5th Avenue" untuk nama jalan atau "1253" untuk nomor jalan, |
componentNameLanguageCode
readonly |
Jenis:
string optionalKode bahasa BCP-47. Elemen ini tidak akan ada jika nama komponen tidak terkait dengan bahasa, seperti nomor jalan. |
componentType
readonly |
Jenis:
string optionalJenis komponen alamat. Lihat Tabel 2: Jenis tambahan yang ditampilkan oleh layanan Places untuk mengetahui daftar jenis yang mungkin. |
confirmationLevel
readonly |
Jenis:
ConfirmationLevel optionalMenunjukkan tingkat kepastian bahwa komponen tersebut benar. |
inferred
readonly |
Jenis:
booleanJika benar (true), komponen ini bukan bagian dari input, tetapi disimpulkan untuk lokasi alamat. Sebaiknya sertakan komponen ini untuk alamat lengkap. |
replaced
readonly |
Jenis:
booleanMenunjukkan 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 menjadi komponen lain. |
spellCorrected
readonly |
Jenis:
booleanMenunjukkan koreksi kesalahan ejaan pada nama komponen. API tidak selalu menandai perubahan dari satu varian ejaan ke varian ejaan lainnya, seperti "centre" menjadi "center". |
unexpected
readonly |
Jenis:
booleanJika benar (true), komponen ini tidak diharapkan ada di alamat pos untuk wilayah tertentu. Data ini dipertahankan hanya karena merupakan bagian dari input. |
Class AddressMetadata
google.maps.addressValidation.AddressMetadata
class
library "addressValidation"
Metadata untuk alamat. AddressMetadata tidak dijamin akan diisi sepenuhnya untuk setiap alamat yang dikirim ke Address Validation API.
const {AddressMetadata} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
business
readonly |
Jenis:
boolean |
poBox
readonly |
Jenis:
boolean |
residential
readonly |
Jenis:
boolean |
Metode | |
|---|---|
Diwarisi:
toJSON
|
Konstanta ConfirmationLevel
google.maps.addressValidation.ConfirmationLevel
konstanta
library
"addressValidation"
Berbagai kemungkinan nilai yang menunjukkan tingkat kepastian bahwa komponen tersebut benar.
Konstanta ini juga dapat digunakan sebagai string. Di TypeScript, literal string ditentukan oleh jenis ConfirmationLevelString.
const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");
Konstanta | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Class Geocode
google.maps.addressValidation.Geocode
class
library "addressValidation"
Berisi informasi tentang tempat input di-geocoding.
const {Geocode} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
bounds
readonly |
Jenis:
LatLngBounds optionalBatas tempat yang di-geocode. |
featureSizeMeters
readonly |
Jenis:
number optionalUkuran tempat yang di-geocoding, dalam meter. Ini adalah ukuran lain dari kekasaran lokasi yang di-geocoding, tetapi dalam ukuran fisik, bukan dalam makna semantik. |
location
readonly |
Jenis:
LatLngAltitude optionalLokasi input yang di-geocoding. |
placeId
readonly |
Jenis:
string optionalID Tempat dari tempat yang di-geocode. Sebaiknya gunakan Tempat daripada alamat, koordinat lintang/bujur, atau Plus Codes. Penggunaan koordinat untuk pemilihan rute atau penghitungan rute mobil akan selalu menghasilkan titik yang dipaskan ke jalan terdekat dengan koordinat tersebut. Jalan ini mungkin bukan jalan yang akan mengarah ke tujuan dengan cepat atau aman dan mungkin tidak berada di dekat titik akses ke properti. Selain itu, saat lokasi di-geocoding terbalik, tidak ada jaminan bahwa alamat yang ditampilkan akan cocok dengan alamat aslinya. |
placeTypes
readonly |
Jenis:
Array<string>Jenis tempat yang di-geocoding oleh input. Misalnya, ['locality', 'political']. Daftar lengkap jenis dapat ditemukan di dokumentasi Geocoding API. |
plusCode
readonly |
Jenis:
PlusCode optionalPlus Codes yang sesuai dengan location. |
Metode | |
|---|---|
fetchPlace |
fetchPlace()Parameter: Tidak ada
Nilai Hasil: Tidak ada
Menampilkan representasi Tempat dari Geocode ini. Untuk mendapatkan detail tempat lengkap, panggilan ke place.fetchFields() harus dilakukan. |
Diwarisi:
toJSON
| |
Konstanta Granularitas
google.maps.addressValidation.Granularity
konstanta
library
"addressValidation"
Berbagai tingkat perincian yang dapat dimiliki alamat atau geocode. Jika digunakan untuk menunjukkan perincian alamat, nilai ini menunjukkan seberapa detail alamat mengidentifikasi tujuan pengiriman surat. Misalnya, alamat seperti "123 Main Street, Redwood City, CA, 94061" mengidentifikasi PREMISE, sedangkan alamat 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.
Konstanta ini juga dapat digunakan sebagai string. Di TypeScript, literal string ditentukan oleh jenis GranularityString.
const {Granularity} = await google.maps.importLibrary("addressValidation");
Konstanta | |
|---|---|
BLOCK |
Alamat atau geocode menunjukkan blok. Hanya digunakan di wilayah yang memiliki alamat 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 tingkat bangunan dari alamat. |
ROUTE |
Geocode atau alamat bersifat terperinci hingga ke rute, seperti jalan, jalan raya, atau jalan tol. |
SUB_PREMISE |
Hasil di bawah tingkat bangunan, seperti apartemen. |
PossibleNextAction
google.maps.addressValidation.PossibleNextAction
konstanta
library
"addressValidation"
Menawarkan ringkasan interpretatif dari respons API, yang dimaksudkan untuk membantu menentukan potensi tindakan berikutnya yang harus diambil. Kolom ini berasal dari kolom lain dalam respons API dan tidak boleh dianggap sebagai jaminan akurasi atau pengiriman alamat.
Konstanta ini juga dapat digunakan sebagai string. Di TypeScript, literal string ditentukan oleh jenis PossibleNextActionString.
const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");
Konstanta | |
|---|---|
ACCEPT |
Respons API tidak berisi sinyal yang memerlukan salah satu nilai PossibleNextAction lainnya. Anda dapat mempertimbangkan untuk menggunakan alamat yang telah diproses tanpa meminta konfirmasi lebih lanjut dari pelanggan, meskipun hal ini tidak menjamin bahwa alamat tersebut valid, dan alamat tersebut mungkin masih berisi koreksi. Anda bertanggung jawab untuk menentukan apakah dan cara meminta konfirmasi pelanggan, bergantung pada penilaian risiko Anda sendiri. |
CONFIRM |
Satu atau beberapa kolom respons API menunjukkan potensi masalah kecil pada alamat yang diproses, misalnya komponen alamat postal_code adalah replaced. Meminta pelanggan Anda untuk meninjau alamat dapat membantu meningkatkan kualitas alamat. |
CONFIRM_ADD_SUBPREMISES |
Respons API menunjukkan bahwa alamat yang telah diproses mungkin tidak memiliki sub-premis. Meminta pelanggan untuk meninjau alamat dan mempertimbangkan untuk menambahkan nomor unit dapat membantu meningkatkan kualitas alamat. Alamat yang telah diproses 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 telah diproses, misalnya verdict.validation_granularity adalah OTHER. Meminta pelanggan mengedit alamat dapat membantu meningkatkan kualitas alamat. |
Class USPSAddress
google.maps.addressValidation.USPSAddress
class
library "addressValidation"
Representasi USPS untuk alamat di AS.
const {USPSAddress} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
city
readonly |
Jenis:
string optionalNama kota. |
cityStateZipAddressLine
readonly |
Jenis:
string optionalBaris alamat yang berisi kota, negara bagian, dan kode pos. |
firm
readonly |
Jenis:
string optionalNama firma. |
firstAddressLine
readonly |
Jenis:
string optionalBaris pertama alamat. |
secondAddressLine
readonly |
Jenis:
string optionalBaris kedua alamat. |
state
readonly |
Jenis:
string optionalKode negara bagian 2 huruf. |
urbanization
readonly |
Jenis:
string optionalNama urbanisasi Puerto Riko. |
zipCode
readonly |
Jenis:
string optionalKode pos, misalnya "10009". |
zipCodeExtension
readonly |
Jenis:
string optionalEkstensi kode pos 4 digit, misalnya "5023". |
Metode | |
|---|---|
Diwarisi:
toJSON
|
Class USPSData
google.maps.addressValidation.USPSData
class
library "addressValidation"
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.
const {USPSData} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
abbreviatedCity
readonly |
Jenis:
string optionalKota yang disingkat. |
addressRecordType
readonly |
Jenis:
string optionalJenis data alamat yang cocok dengan alamat input. |
carrierRoute
readonly |
Jenis:
string optionalKode rute ekspedisi. Kode empat karakter yang terdiri dari awalan satu huruf dan penanda rute tiga digit. |
carrierRouteIndicator
readonly |
Jenis:
string optionalIndikator pengurutan tarif rute ekspedisi. |
cassProcessed
readonly |
Jenis:
booleanIndikator bahwa permintaan telah diproses CASS. |
county
readonly |
Jenis:
string optionalNama county. |
deliveryPointCheckDigit
readonly |
Jenis:
string optionalDigit pengecek titik pengiriman. Nomor ini ditambahkan ke akhir delivery_point_barcode untuk surat yang dipindai secara mekanis. Menjumlahkan semua digit delivery_point_barcode, delivery_point_check_digit, kode pos, dan ZIP+4 akan menghasilkan angka yang habis dibagi 10. |
deliveryPointCode
readonly |
Jenis:
string optionalKode titik pengiriman 2 digit. |
dpvCMRA
readonly |
Jenis:
string optionalMenunjukkan apakah alamat tersebut adalah CMRA (Commercial Mail Receiving Agency)--bisnis pribadi yang menerima surat untuk klien. Menampilkan satu karakter. |
dpvConfirmation
readonly |
Jenis:
string optionalNilai yang mungkin untuk konfirmasi DPV. Menampilkan satu karakter atau tidak menampilkan nilai. |
dpvDoorNotAccessible
readonly |
Jenis:
string optionalTanda ini menunjukkan alamat yang tidak dapat dijangkau USPS untuk mengirimkan surat. Menampilkan satu karakter. |
dpvDrop
readonly |
Jenis:
string optionalBendera menunjukkan bahwa surat dikirim ke satu kotak surat di suatu lokasi. Menampilkan satu karakter. |
dpvEnhancedDeliveryCode
readonly |
Jenis:
string optionalMenunjukkan bahwa lebih dari satu kode hasil DPV valid untuk alamat tersebut. Menampilkan satu karakter. |
dpvFootnote
readonly |
Jenis:
string optionalCatatan kaki dari validasi titik pengiriman. Beberapa catatan kaki dapat digabungkan dalam string yang sama. |
dpvNonDeliveryDays
readonly |
Jenis:
string optionalTanda menunjukkan pengiriman surat tidak dilakukan setiap hari dalam seminggu. Menampilkan satu karakter. |
dpvNonDeliveryDaysValues
readonly |
Jenis:
number optionalBilangan bulat yang mengidentifikasi hari non-pengiriman. Nilai ini dapat diinterogasi menggunakan flag bit: 0x40 – Minggu adalah hari non-pengiriman 0x20 – Senin adalah hari non-pengiriman 0x10 – Selasa adalah hari non-pengiriman 0x08 – Rabu adalah hari non-pengiriman 0x04 – Kamis adalah hari non-pengiriman 0x02 – Jumat adalah hari non-pengiriman 0x01 – Sabtu adalah hari non-pengiriman |
dpvNoSecureLocation
readonly |
Jenis:
string optionalBendera menunjukkan pintu dapat diakses, tetapi paket tidak akan ditinggalkan karena masalah keamanan. Menampilkan satu karakter. |
dpvNoStat
readonly |
Jenis:
string optionalMenunjukkan apakah alamat tersebut adalah alamat tanpa statistik atau alamat aktif. Alamat tanpa statistik adalah alamat yang tidak ditempati secara terus-menerus atau alamat yang tidak dilayani oleh USPS. Menampilkan satu karakter. |
dpvNoStatReasonCode
readonly |
Jenis:
number optionalMenunjukkan jenis NoStat. Menampilkan kode alasan sebagai int. |
dpvPBSA
readonly |
Jenis:
string optionalMenunjukkan bahwa alamat cocok dengan data PBSA. Menampilkan satu karakter. |
dpvThrowback
readonly |
Jenis:
string optionalMenunjukkan bahwa surat tidak dikirim ke alamat jalan. Menampilkan satu karakter. |
dpvVacant
readonly |
Jenis:
string optionalMenunjukkan apakah alamat tersebut kosong. Menampilkan satu karakter. |
elotFlag
readonly |
Jenis:
string optionalFlag Naik/Turun eLOT (A/D). |
elotNumber
readonly |
Jenis:
string optionalNomor Enhanced Line of Travel (eLOT). |
errorMessage
readonly |
Jenis:
string optionalPesan error untuk pengambilan data USPS. Kolom ini diisi saat pemrosesan USPS ditangguhkan karena terdeteksi adanya alamat yang dibuat secara buatan. |
fipsCountyCode
readonly |
Jenis:
string optionalKode county FIPS. |
hasDefaultAddress
readonly |
Jenis:
booleanIndikator bahwa alamat default ditemukan, tetapi ada alamat yang lebih spesifik. |
hasNoEWSMatch
readonly |
Jenis:
booleanAlamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa kecocokan persis akan segera tersedia. |
lacsLinkIndicator
readonly |
Jenis:
string optionalIndikator LACSLink. |
lacsLinkReturnCode
readonly |
Jenis:
string optionalKode status LACSLink. |
pmbDesignator
readonly |
Jenis:
string optionalPenanda unit PMB (Private Mail Box). |
pmbNumber
readonly |
Jenis:
string optionalNomor PMB (Private Mail Box). |
poBoxOnlyPostalCode
readonly |
Jenis:
booleanKode pos khusus PO Box. |
postOfficeCity
readonly |
Jenis:
string optionalKota kantor pos utama. |
postOfficeState
readonly |
Jenis:
string optionalNegara bagian kantor pos utama. |
standardizedAddress
readonly |
Jenis:
USPSAddress optionalAlamat standar USPS. |
suiteLinkFootnote
readonly |
Jenis:
string optionalCatatan kaki dari pencocokan data jalan atau gedung tinggi dengan informasi suite. Jika kecocokan nama bisnis ditemukan, nomor sekunder akan ditampilkan. |
Metode | |
|---|---|
Diwarisi:
toJSON
|
Class Verdict
google.maps.addressValidation.Verdict
class
library "addressValidation"
Menunjukkan alamat yang telah diproses pasca-pemrosesan untuk alamat yang diberikan.
const {Verdict} = await google.maps.importLibrary("addressValidation");
Properti | |
|---|---|
addressComplete
readonly |
Jenis:
booleanAlamat dianggap lengkap jika tidak ada token yang belum terselesaikan, tidak ada komponen alamat yang tidak terduga atau tidak ada. Jika tidak ditetapkan, menunjukkan bahwa nilainya adalah false. Lihat kolom Address.missingComponentTypes, Address.unresolvedTokens, atau AddressComponent.unexpected untuk mengetahui detail selengkapnya. |
geocodeGranularity
readonly |
Jenis:
Granularity optionalInformasi tentang perincian Geocode. Hal ini dapat dipahami sebagai makna semantik dari seberapa kasar atau akurat lokasi yang di-geocoding. |
hasInferredComponents
readonly |
Jenis:
booleanSetidaknya satu komponen alamat disimpulkan (yaitu ditambahkan) yang tidak ada dalam input, lihat AddressComponent untuk mengetahui detailnya. |
hasReplacedComponents
readonly |
Jenis:
boolean optionalSetidaknya satu komponen alamat telah diganti - lihat AddressComponent untuk mengetahui detailnya. |
hasUnconfirmedComponents
readonly |
Jenis:
booleanSetidaknya satu komponen alamat tidak dapat dikategorikan atau divalidasi, lihat AddressComponent untuk mengetahui detailnya. |
inputGranularity
readonly |
Jenis:
Granularity optionalPerincian alamat input. Ini adalah hasil penguraian alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat validationGranularity. |
readonly |
Jenis:
PossibleNextAction optionalTindakan berikutnya yang mungkin dilakukan berdasarkan kolom lain dalam respons API. Lihat PossibleNextAction untuk detailnya. |
validationGranularity
readonly |
Jenis:
Granularity optionalTingkat perincian yang dapat divalidasi sepenuhnya oleh API untuk alamat tersebut. Misalnya, validationGranularity dari PREMISE menunjukkan bahwa semua komponen alamat di tingkat PREMISE dan yang lebih luas dapat divalidasi. |