Address Validation

Class AddressValidation

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.
fetchAddressValidation
fetchAddressValidation(request)
Parameter: 
Nilai Hasil:  Promise<AddressValidation>
Memvalidasi alamat. Lihat https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.
address
Jenis:  Address optional
Informasi tentang alamat itu sendiri, bukan geocode.
geocode
Jenis:  Geocode optional
Informasi tentang lokasi dan tempat yang di-geocoding oleh alamat.
metadata
Jenis:  AddressMetadata optional
Informasi lain yang relevan dengan kemampuan pengiriman. metadata tidak dijamin akan diisi sepenuhnya untuk setiap alamat yang dikirim ke Address Validation API.
responseId
Jenis:  string optional
UUID yang mengidentifikasi respons ini. Jika alamat perlu divalidasi ulang, UUID ini harus disertakan dalam permintaan baru.
uspsData
Jenis:  USPSData optional
Flag kemampuan pengiriman tambahan yang disediakan oleh USPS. Hanya disediakan di region US dan PR.
verdict
Jenis:  Verdict optional
Flag verdict keseluruhan
toJSON
toJSON()
Parameter:  Tidak ada
Nilai Hasil:  Object
Mengonversi class AddressValidation menjadi objek JSON dengan properti yang sama.

Antarmuka AddressValidationRequest

Antarmuka google.maps.addressValidation.AddressValidationRequest

Antarmuka permintaan untuk AddressValidation.fetchAddressValidation.
address
Alamat yang divalidasi. Alamat yang tidak diformat harus dikirimkan melalui PostalAddress.addressLines.
placeAutocompleteElement optional
Jenis:  PlaceAutocompleteElement optional
Jika menggunakan PlaceAutocompleteElement, sertakan di sini untuk menautkan panggilan API AddressValidation dengan token sesi pelengkapan otomatis.
previousResponseId optional
Jenis:  string optional
Kolom 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 optional
Jenis:  AutocompleteSessionToken optional
Token yang mengidentifikasi sesi Autocomplete untuk tujuan penagihan.
uspsCASSEnabled optional
Jenis:  boolean optional
Mengaktifkan 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

Class google.maps.addressValidation.Address

Detail alamat yang telah diproses. Pascapemrosesan mencakup perbaikan bagian alamat yang salah eja, penggantian bagian yang salah, dan inferensi bagian yang tidak ada.

Akses dengan memanggil const {Address} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
components
Komponen alamat individual dari alamat yang diformat dan dikoreksi, beserta informasi validasi. Tindakan ini memberikan informasi tentang status validasi setiap komponen.
formattedAddress
Jenis:  string optional
Alamat yang telah diproses, diformat sebagai alamat satu baris yang mengikuti aturan pemformatan alamat di wilayah tempat alamat tersebut berada.
missingComponentTypes
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
Jenis:  PostalAddress optional
Alamat yang telah diproses dan direpresentasikan sebagai alamat pos.
unconfirmedComponentTypes
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
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.

Class AddressComponent

Class google.maps.addressValidation.AddressComponent

Mewakili satu komponen alamat (misalnya, nama jalan, kota).

Akses dengan memanggil const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
componentName
Jenis:  string optional
Teks nama komponen. Misalnya, "5th Avenue" untuk nama jalan atau "1253" untuk nomor jalan,
componentNameLanguageCode
Jenis:  string optional
Kode bahasa BCP-47. Elemen ini tidak akan ada jika nama komponen tidak terkait dengan bahasa, seperti nomor jalan.
componentType
Jenis:  string optional
Jenis komponen alamat. Lihat Tabel 2: Jenis tambahan yang ditampilkan oleh layanan Places untuk mengetahui daftar jenis yang mungkin.
confirmationLevel
Jenis:  ConfirmationLevel optional
Menunjukkan tingkat kepastian bahwa komponen tersebut benar.
inferred
Jenis:  boolean
Jika benar (true), komponen ini bukan bagian dari input, tetapi disimpulkan untuk lokasi alamat. Sebaiknya sertakan komponen ini untuk alamat lengkap.
replaced
Jenis:  boolean
Menunjukkan 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
Jenis:  boolean
Menunjukkan koreksi kesalahan ejaan pada nama komponen. API tidak selalu menandai perubahan dari satu varian ejaan ke varian ejaan lainnya, seperti "centre" menjadi "center".
unexpected
Jenis:  boolean
Jika benar (true), komponen ini tidak diharapkan ada di alamat pos untuk wilayah tertentu. Data ini dipertahankan hanya karena merupakan bagian dari input.

Class AddressMetadata

Class google.maps.addressValidation.AddressMetadata

Metadata untuk alamat. AddressMetadata tidak dijamin akan diisi 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.
business
Jenis:  boolean
poBox
Jenis:  boolean
residential
Jenis:  boolean

Konstanta ConfirmationLevel

Konstanta google.maps.addressValidation.ConfirmationLevel

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.
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Class Geocode

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.
bounds
Jenis:  LatLngBounds optional
Batas tempat yang di-geocode.
featureSizeMeters
Jenis:  number optional
Ukuran 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
Jenis:  LatLngAltitude optional
Lokasi input yang di-geocoding.
placeId
Jenis:  string optional
ID 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
Jenis:  Array<string>
Jenis tempat yang di-geocoding oleh input. Misalnya, ['locality', 'political']. Daftar lengkap jenis dapat ditemukan di dokumentasi Geocoding API.
plusCode
Jenis:  PlusCode optional
Plus Codes yang sesuai dengan location.
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.

Konstanta Granularitas

Konstanta google.maps.addressValidation.Granularity

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.

Akses dengan memanggil const {Granularity} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
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

Konstanta google.maps.addressValidation.PossibleNextAction

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.

Akses dengan memanggil const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
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

Class google.maps.addressValidation.USPSAddress

Representasi USPS untuk alamat di AS.

Akses dengan memanggil const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
city
Jenis:  string optional
Nama kota.
cityStateZipAddressLine
Jenis:  string optional
Baris alamat yang berisi kota, negara bagian, dan kode pos.
firm
Jenis:  string optional
Nama firma.
firstAddressLine
Jenis:  string optional
Baris pertama alamat.
secondAddressLine
Jenis:  string optional
Baris kedua alamat.
state
Jenis:  string optional
Kode negara bagian 2 huruf.
urbanization
Jenis:  string optional
Nama urbanisasi Puerto Riko.
zipCode
Jenis:  string optional
Kode pos, misalnya "10009".
zipCodeExtension
Jenis:  string optional
Ekstensi kode pos 4 digit, misalnya "5023".

Class USPSData

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.
abbreviatedCity
Jenis:  string optional
Kota yang disingkat.
addressRecordType
Jenis:  string optional
Jenis data alamat yang cocok dengan alamat input.
carrierRoute
Jenis:  string optional
Kode rute ekspedisi. Kode empat karakter yang terdiri dari awalan satu huruf dan penanda rute tiga digit.
carrierRouteIndicator
Jenis:  string optional
Indikator pengurutan tarif rute ekspedisi.
cassProcessed
Jenis:  boolean
Indikator bahwa permintaan telah diproses CASS.
county
Jenis:  string optional
Nama county.
deliveryPointCheckDigit
Jenis:  string optional
Digit 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
Jenis:  string optional
Kode titik pengiriman 2 digit.
dpvCMRA
Jenis:  string optional
Menunjukkan apakah alamat tersebut adalah CMRA (Commercial Mail Receiving Agency)--bisnis pribadi yang menerima surat untuk klien. Menampilkan satu karakter.
dpvConfirmation
Jenis:  string optional
Nilai yang mungkin untuk konfirmasi DPV. Menampilkan satu karakter atau tidak menampilkan nilai.
dpvDoorNotAccessible
Jenis:  string optional
Tanda ini menunjukkan alamat yang tidak dapat dijangkau USPS untuk mengirimkan surat. Menampilkan satu karakter.
dpvDrop
Jenis:  string optional
Bendera menunjukkan bahwa surat dikirim ke satu kotak surat di suatu lokasi. Menampilkan satu karakter.
dpvEnhancedDeliveryCode
Jenis:  string optional
Menunjukkan bahwa lebih dari satu kode hasil DPV valid untuk alamat tersebut. Menampilkan satu karakter.
dpvFootnote
Jenis:  string optional
Catatan kaki dari validasi titik pengiriman. Beberapa catatan kaki dapat digabungkan dalam string yang sama.
dpvNonDeliveryDays
Jenis:  string optional
Tanda menunjukkan pengiriman surat tidak dilakukan setiap hari dalam seminggu. Menampilkan satu karakter.
dpvNonDeliveryDaysValues
Jenis:  number optional
Bilangan 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
Jenis:  string optional
Bendera menunjukkan pintu dapat diakses, tetapi paket tidak akan ditinggalkan karena masalah keamanan. Menampilkan satu karakter.
dpvNoStat
Jenis:  string optional
Menunjukkan 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
Jenis:  number optional
Menunjukkan jenis NoStat. Menampilkan kode alasan sebagai int.
dpvPBSA
Jenis:  string optional
Menunjukkan bahwa alamat cocok dengan data PBSA. Menampilkan satu karakter.
dpvThrowback
Jenis:  string optional
Menunjukkan bahwa surat tidak dikirim ke alamat jalan. Menampilkan satu karakter.
dpvVacant
Jenis:  string optional
Menunjukkan apakah alamat tersebut kosong. Menampilkan satu karakter.
elotFlag
Jenis:  string optional
Flag Naik/Turun eLOT (A/D).
elotNumber
Jenis:  string optional
Nomor Enhanced Line of Travel (eLOT).
errorMessage
Jenis:  string optional
Pesan error untuk pengambilan data USPS. Kolom ini diisi saat pemrosesan USPS ditangguhkan karena terdeteksi adanya alamat yang dibuat secara buatan.
fipsCountyCode
Jenis:  string optional
Kode county FIPS.
hasDefaultAddress
Jenis:  boolean
Indikator bahwa alamat default ditemukan, tetapi ada alamat yang lebih spesifik.
hasNoEWSMatch
Jenis:  boolean
Alamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa kecocokan persis akan segera tersedia.
lacsLinkIndicator
Jenis:  string optional
Indikator LACSLink.
lacsLinkReturnCode
Jenis:  string optional
Kode status LACSLink.
pmbDesignator
Jenis:  string optional
Penanda unit PMB (Private Mail Box).
pmbNumber
Jenis:  string optional
Nomor PMB (Private Mail Box).
poBoxOnlyPostalCode
Jenis:  boolean
Kode pos khusus PO Box.
postOfficeCity
Jenis:  string optional
Kota kantor pos utama.
postOfficeState
Jenis:  string optional
Negara bagian kantor pos utama.
standardizedAddress
Jenis:  USPSAddress optional
Alamat standar USPS.
suiteLinkFootnote
Jenis:  string optional
Catatan kaki dari pencocokan data jalan atau gedung tinggi dengan informasi suite. Jika kecocokan nama bisnis ditemukan, nomor sekunder akan ditampilkan.

Class Verdict

Class google.maps.addressValidation.Verdict

Menunjukkan alamat yang telah diproses pasca-pemrosesan untuk alamat yang diberikan.

Akses dengan memanggil const {Verdict} = await google.maps.importLibrary("addressValidation").
Lihat Library di Maps JavaScript API.
addressComplete
Jenis:  boolean
Alamat 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
Jenis:  Granularity optional
Informasi tentang perincian Geocode. Hal ini dapat dipahami sebagai makna semantik dari seberapa kasar atau akurat lokasi yang di-geocoding.
hasInferredComponents
Jenis:  boolean
Setidaknya satu komponen alamat disimpulkan (yaitu ditambahkan) yang tidak ada dalam input, lihat AddressComponent untuk mengetahui detailnya.
hasReplacedComponents
Jenis:  boolean optional
Setidaknya satu komponen alamat telah diganti - lihat AddressComponent untuk mengetahui detailnya.
hasUnconfirmedComponents
Jenis:  boolean
Setidaknya satu komponen alamat tidak dapat dikategorikan atau divalidasi, lihat AddressComponent untuk mengetahui detailnya.
inputGranularity
Jenis:  Granularity optional
Perincian alamat input. Ini adalah hasil penguraian alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat validationGranularity.
BetapossibleNextAction
Jenis:  PossibleNextAction optional
Tindakan berikutnya yang mungkin dilakukan berdasarkan kolom lain dalam respons API. Lihat PossibleNextAction untuk detailnya.
validationGranularity
Jenis:  Granularity optional
Tingkat 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.