- Permintaan HTTP
- Isi Permintaan
- Isi respons
- PostalAddress
- LanguageOptions
- ValidationResult
- putusan
- Perincian
- Alamat
- AddressComponent
- ComponentName
- ConfirmationLevel
- Geocode
- LatLng
- PlusCode
- Area pandang
- AddressMetadata
- UspsData
- UspsAddress
Memvalidasi alamat.
Permintaan HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "address": { object ( |
Kolom | |
---|---|
address |
Wajib diisi. Alamat yang sedang divalidasi. Alamat yang tidak berformat harus dikirimkan melalui Panjang total kolom dalam input ini tidak boleh lebih dari 280 karakter. Wilayah yang didukung dapat ditemukan di sini. Nilai Address Validation API mengabaikan nilai dalam |
previousResponseId |
Kolom ini harus kosong untuk permintaan validasi alamat pertama. Jika diperlukan lebih banyak permintaan untuk memvalidasi satu alamat sepenuhnya (misalnya jika perubahan yang dilakukan pengguna setelah validasi awal harus divalidasi ulang), setiap permintaan tindak lanjut harus mengisi kolom ini dengan |
enableUspsCass |
Mengaktifkan mode yang kompatibel dengan USPS CASS. Hal ini hanya memengaruhi kolom Sebaiknya gunakan |
languageOptions |
Opsional. Pratinjau: Fitur ini ada dalam Pratinjau (pra-GA). Produk dan fitur pra-GA mungkin memiliki dukungan terbatas, dan perubahan pada produk serta fitur pra-GA mungkin tidak kompatibel dengan versi pra-GA lainnya. Penawaran Pra-GA tercakup dalam Persyaratan Khusus Layanan Google Maps Platform. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran. Mengaktifkan Address Validation API untuk menyertakan informasi tambahan dalam respons. |
sessionToken |
Opsional. String yang mengidentifikasi sesi Autocomplete untuk tujuan penagihan. Harus berupa string base64 aman dari URL dan nama file dengan panjang maksimal 36 karakter ASCII. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. Sesi dimulai saat pengguna membuat kueri Autocomplete, dan berakhir saat mereka memilih tempat serta panggilan ke Place Details atau Validasi Alamat dilakukan. Setiap sesi dapat memiliki beberapa kueri Autocomplete, diikuti dengan satu permintaan Place Details atau Address Validation. Kredensial yang digunakan untuk setiap permintaan dalam sebuah sesi harus berasal dari project Konsol Google Cloud yang sama. Setelah sesi selesai, token tidak lagi valid; aplikasi Anda harus menghasilkan token baru untuk setiap sesi. Jika parameter Catatan: Validasi Alamat hanya dapat digunakan dalam sesi dengan Autocomplete API (Baru), bukan Autocomplete API. Lihat https://developers.google.com/maps/documentation/places/web-service/session-pricing untuk mengetahui detail selengkapnya. |
Isi respons
Respons terhadap permintaan validasi alamat.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"result": {
object ( |
Kolom | |
---|---|
result |
Hasil validasi alamat. |
responseId |
UUID yang mengidentifikasi respons ini. Jika alamat perlu divalidasi ulang, UUID ini harus menyertai permintaan baru. |
PostalAddress
Merepresentasikan alamat pos, mis. untuk pengiriman pos atau alamat pembayaran. Dengan mempertimbangkan alamat pos, layanan pos dapat mengirimkan item ke suatu tempat, P.O. Box atau yang serupa. Hal ini tidak dimaksudkan untuk membuat model lokasi geografis (jalan, kota, gunung).
Dalam penggunaan umum, alamat akan dibuat melalui input pengguna atau dari mengimpor data yang ada, tergantung pada jenis prosesnya.
Saran tentang input / pengeditan alamat: - Gunakan widget alamat yang mendukung internasionalisasi seperti https://github.com/google/libaddressinput) - Pengguna tidak boleh diberi elemen UI untuk memasukkan atau mengedit kolom di luar negara tempat kolom tersebut digunakan.
Untuk panduan selengkapnya tentang cara menggunakan skema ini, lihat: https://support.google.com/business/answer/6397478
Representasi JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Kolom | |
---|---|
revision |
Revisi skema |
regionCode |
Opsional. Kode wilayah CLDR negara/wilayah alamat. Lihat https://cldr.unicode.org/ dan https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html untuk detailnya. Contoh: "CH" untuk Swiss. Jika kode wilayah tidak diberikan, kode tersebut akan disimpulkan dari alamat. Untuk performa terbaik, sebaiknya sertakan kode wilayah jika Anda mengetahuinya. Memiliki wilayah yang tidak konsisten atau berulang dapat menyebabkan performa yang buruk. Misalnya, jika |
languageCode |
Kode bahasa di alamat input dicadangkan untuk penggunaan di masa mendatang dan diabaikan hari ini. API menampilkan alamat dalam bahasa yang sesuai dengan lokasi alamat tersebut. |
postalCode |
Opsional. Kode pos alamat. Tidak semua negara menggunakan atau mewajibkan keberadaan kode pos, tetapi jika kode pos digunakan, kode pos tersebut dapat memicu validasi tambahan dengan bagian alamat lainnya (misalnya, validasi negara bagian/kode pos di Amerika Serikat). |
sortingCode |
Opsional. Kode pengurutan tambahan khusus negara. Ini tidak digunakan di sebagian besar wilayah. Jika digunakan, nilainya dapat berupa string seperti "CEDEX", secara opsional diikuti dengan angka (mis. "CEDEX 7"), atau hanya angka saja, yang mewakili "kode sektor" (Jamaika), "indikator area pengiriman" (Malawi) atau "indikator kantor pos" (mis. Côte d'Ivoire). |
administrativeArea |
Opsional. Subdivisi administratif tertinggi yang digunakan untuk alamat pos suatu negara atau wilayah. Misalnya, ini dapat berupa negara bagian, provinsi, oblast, atau prefektur. Khususnya, untuk Spanyol, ini adalah provinsi dan bukan komunitas otonom (misalnya "Barcelona" dan bukan "Catalonia"). Banyak negara tidak menggunakan wilayah administratif dalam alamat pos. Mis. di Swiss kolom ini harus dibiarkan tidak terisi. |
locality |
Opsional. Secara umum mengacu pada bagian kota dari alamat tersebut. Contoh: US city, IT comune, UK post city. Di wilayah dunia dengan lokalitas yang tidak didefinisikan dengan baik atau tidak cocok dengan struktur ini, biarkan lokalitas kosong dan gunakan addressLines. |
sublocality |
Opsional. Sublokalitas alamat. Misalnya, ini dapat berupa kawasan, kota besar, distrik. |
addressLines[] |
Wajib diisi. Baris alamat tidak terstruktur yang menggambarkan tingkat alamat yang lebih rendah. |
recipients[] |
Jangan tetapkan kolom ini. Address Validation API saat ini tidak menggunakannya. Meskipun saat ini API tidak akan menolak permintaan dengan kumpulan kolom ini, informasi akan dibuang dan tidak akan dikembalikan dalam respons. |
organization |
Jangan tetapkan kolom ini. Address Validation API saat ini tidak menggunakannya. Meskipun saat ini API tidak akan menolak permintaan dengan kumpulan kolom ini, informasi akan dibuang dan tidak akan dikembalikan dalam respons. |
LanguageOptions
Pratinjau: Fitur ini ada dalam Pratinjau (pra-GA). Produk dan fitur pra-GA mungkin memiliki dukungan terbatas, dan perubahan pada produk serta fitur pra-GA mungkin tidak kompatibel dengan versi pra-GA lainnya. Penawaran Pra-GA tercakup dalam Persyaratan Khusus Layanan Google Maps Platform. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.
Mengaktifkan Address Validation API untuk menyertakan informasi tambahan dalam respons.
Representasi JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
Kolom | |
---|---|
returnEnglishLatinAddress |
Pratinjau: Menampilkan |
ValidationResult
Hasil validasi alamat.
Representasi JSON |
---|
{ "verdict": { object ( |
Kolom | |
---|---|
verdict |
Tanda putusan keseluruhan |
address |
Informasi tentang alamat itu sendiri, bukan geocode. |
geocode |
Informasi tentang lokasi dan tempat yang di-geocode alamat. |
metadata |
Informasi lainnya yang relevan dengan pengiriman. |
uspsData |
Tanda pengiriman tambahan yang disediakan oleh USPS. Hanya disediakan di region |
englishLatinAddress |
Pratinjau: Fitur ini ada dalam Pratinjau (pra-GA). Produk dan fitur pra-GA mungkin memiliki dukungan terbatas, dan perubahan pada produk serta fitur pra-GA mungkin tidak kompatibel dengan versi pra-GA lainnya. Penawaran Pra-GA tercakup dalam Persyaratan Khusus Layanan Google Maps Platform. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran. Alamat diterjemahkan ke dalam bahasa Inggris. Alamat yang diterjemahkan tidak dapat digunakan kembali sebagai input API. Layanan menyediakannya sehingga pengguna dapat menggunakan bahasa asli mereka untuk mengonfirmasi atau menolak validasi alamat asli yang diberikan. Jika bagian dari alamat tidak memiliki terjemahan bahasa Inggris, layanan akan mengembalikan bagian itu dalam bahasa alternatif yang menggunakan skrip Latin. Lihat di sini untuk mengetahui penjelasan tentang cara memilih bahasa alternatif. Jika bagian dari alamat tidak memiliki terjemahan atau transliterasi dalam bahasa yang menggunakan skrip Latin, layanan akan mengembalikan bagian itu dalam bahasa lokal yang terkait dengan alamat itu. Aktifkan output ini menggunakan tanda Catatan: kolom |
Putusan
Ringkasan lengkap hasil validasi alamat dan geocode.
Representasi JSON |
---|
{ "inputGranularity": enum ( |
Kolom | |
---|---|
inputGranularity |
Perincian alamat input. Ini adalah hasil dari penguraian alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat Misalnya, jika alamat input menyertakan nomor apartemen tertentu, |
validationGranularity |
Tingkat perincian yang dapat dipenuhi API untuk sepenuhnya memvalidasi alamat. Misalnya, Per hasil validasi komponen alamat dapat ditemukan di |
geocodeGranularity |
Informasi tentang tingkat perincian Hal ini terkadang dapat berbeda dari |
addressComplete |
Alamat dianggap lengkap jika tidak ada token yang belum terselesaikan, tidak ada komponen alamat yang tidak terduga atau hilang. Jika tidak disetel, nilai tersebut akan menunjukkan bahwa nilainya adalah |
hasUnconfirmedComponents |
Setidaknya satu komponen alamat tidak dapat dikategorikan atau divalidasi, lihat |
hasInferredComponents |
Setidaknya satu komponen alamat disimpulkan (ditambahkan) yang tidak ada dalam input. Lihat |
hasReplacedComponents |
Setidaknya satu komponen alamat diganti, lihat |
Perincian
Berbagai perincian yang dapat dimiliki oleh alamat atau geocode. Ketika digunakan untuk menunjukkan perincian alamat, nilai ini menunjukkan seberapa baik perincian alamat mengidentifikasi tujuan surat. Misalnya, alamat seperti "123 Main Street, Redwood City, CA, 94061" mengidentifikasi PREMISE
dengan nama seperti "Redwood City, CA, 94061" mengidentifikasi LOCALITY
. Namun, jika kita tidak dapat menemukan geocode untuk "123 Main Street" di Redwood City, geocode yang ditampilkan mungkin berupa perincian LOCALITY
meskipun alamatnya lebih terperinci.
Enum | |
---|---|
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 bangunan dari alamat. |
BLOCK |
Alamat atau geocode menunjukkan blok. Hanya digunakan di wilayah yang memiliki pemberian alamat tingkat blok, seperti Jepang. |
ROUTE |
Geocode atau alamat terperinci untuk rute, seperti jalan, jalan, atau jalan tol. |
OTHER |
Semua perincian lainnya, yang dikelompokkan bersama karena tidak dapat dihasilkan. |
Alamat
Detail alamat pascapemrosesan. Pasca-pemrosesan mencakup koreksi bagian alamat yang salah eja, mengganti bagian yang salah, dan menginferensi bagian yang hilang.
Representasi JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
Kolom | |
---|---|
formattedAddress |
Alamat pascapemrosesan, yang diformat sebagai alamat satu baris dengan mengikuti aturan pemformatan alamat di wilayah tempat alamat tersebut berada. |
postalAddress |
Alamat pascapemrosesan yang diwakili sebagai alamat pos. |
addressComponents[] |
Daftar yang tidak diurutkan. Komponen alamat individual dari alamat yang diformat dan dikoreksi, beserta informasi validasi. Ini memberikan informasi tentang status validasi setiap komponen. Komponen alamat tidak diurutkan dengan cara tertentu. Jangan membuat asumsi apa pun mengenai urutan komponen alamat dalam daftar. |
missingComponentTypes[] |
Jenis komponen yang diharapkan ada di alamat surat yang diformat dengan benar, tetapi tidak ditemukan dalam input DAN tidak dapat disimpulkan. Komponen jenis ini tidak ada di |
unconfirmedComponentTypes[] |
Jenis komponen yang ada di |
unresolvedTokens[] |
Setiap token dalam input yang tidak dapat diselesaikan. Input ini mungkin berupa 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 |
AddressComponent
Mewakili komponen alamat, seperti jalan, kota, atau negara bagian.
Representasi JSON |
---|
{ "componentName": { object ( |
Kolom | |
---|---|
componentName |
Nama untuk komponen ini. |
componentType |
Jenis komponen alamat. Lihat Tabel 2: Jenis tambahan yang ditampilkan oleh layanan Places untuk daftar kemungkinan jenis. |
confirmationLevel |
Menunjukkan tingkat kepastian yang kita miliki bahwa komponen tersebut benar. |
inferred |
Menunjukkan bahwa komponen bukan bagian dari input, tetapi kami menyimpulkannya untuk lokasi alamat dan meyakini bahwa komponen tersebut seharusnya diberikan untuk alamat lengkap. |
spellCorrected |
Menunjukkan koreksi terhadap kesalahan ejaan dalam nama komponen. API tidak selalu menandai perubahan dari satu varian ejaan ke varian ejaan lainnya, seperti saat mengubah "pusat" ke "tengah". Peringatan itu juga tidak selalu menandai kesalahan eja yang umum, seperti ketika mengubah kata "Amphitheater Pkwy" ke "Amphitheatre Pkwy". |
replaced |
Menunjukkan nama komponen telah diganti dengan yang sama sekali berbeda, misalnya kode pos yang salah diganti dengan kode pos yang benar untuk alamat tersebut. Ini bukanlah perubahan tampilan, komponen input telah diubah ke yang lain. |
unexpected |
Menunjukkan komponen alamat yang tidak diharapkan ada di alamat pos untuk wilayah yang ditentukan. Kita mempertahankannya hanya karena itu merupakan bagian dari input. |
ComponentName
Wrapper untuk nama komponen.
Representasi JSON |
---|
{ "text": string, "languageCode": string } |
Kolom | |
---|---|
text |
Teks nama. Misalnya, "5th Avenue" untuk nama jalan atau "1253" untuk nomor jalan. |
languageCode |
Kode bahasa BCP-47. Nama ini tidak akan ada jika nama komponen tidak dikaitkan dengan bahasa, seperti nomor jalan. |
ConfirmationLevel
Berbagai kemungkinan nilai untuk tingkat konfirmasi.
Enum | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
CONFIRMED |
Kami dapat memverifikasi bahwa komponen ini ada dan dapat diterima dalam konteks alamat lainnya. |
UNCONFIRMED_BUT_PLAUSIBLE |
Komponen ini tidak dapat dikonfirmasi, tetapi kemungkinan ada. Misalnya, nomor jalan dalam rentang angka valid yang diketahui di sebuah jalan yang tidak memiliki nomor rumah tertentu. |
UNCONFIRMED_AND_SUSPICIOUS |
Komponen ini tidak dikonfirmasi dan mungkin salah. Misalnya, lingkungan yang tidak sesuai dengan alamat lainnya. |
Geocode
Berisi informasi tentang tempat input di-geocode.
Representasi JSON |
---|
{ "location": { object ( |
Kolom | |
---|---|
location |
Lokasi geocode input. Menggunakan ID tempat lebih disukai daripada menggunakan alamat, koordinat lintang/bujur, atau kode plus. Menggunakan koordinat saat mengarahkan rute atau menghitung arah mengemudi akan selalu mengakibatkan titik terikat pada jalan yang paling dekat dengan koordinat tersebut. Jalan ini mungkin bukan jalan yang akan menuju ke tujuan dengan cepat atau aman serta mungkin tidak berada di dekat titik akses ke properti. Selain itu, jika lokasi di-geocoding terbalik, tidak ada jaminan bahwa alamat yang ditampilkan akan cocok dengan aslinya. |
plusCode |
Kode plus yang sesuai dengan |
bounds |
Batas tempat yang di-geocoding. |
featureSizeMeters |
Ukuran tempat yang di-geocode, dalam meter. Ini adalah ukuran lain dari kekasaran lokasi yang di-geocode, namun dalam ukuran fisik, bukan dalam arti semantik. |
placeId |
PlaceID tempat input geocode ini. Untuk informasi selengkapnya tentang ID Tempat, lihat di sini. |
placeTypes[] |
Jenis tempat yang akan di-geocode input. Misalnya, |
LatLng
Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan double untuk mewakili derajat lintang dan derajat bujur. Kecuali jika ditentukan lain, objek ini harus sesuai dengan standar WGS84. Nilai harus berada dalam rentang yang dinormalisasi.
Representasi JSON |
---|
{ "latitude": number, "longitude": number } |
Kolom | |
---|---|
latitude |
Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0]. |
longitude |
Bujur dalam derajat. Harus dalam rentang [-180.0, +180.0]. |
PlusCode
Plus Codes (http://plus.codes) adalah referensi lokasi dengan dua format: kode global yang menentukan persegi panjang berukuran 14 m x 14 m (1/8000 derajat) atau kotak yang lebih kecil, dan kode gabungan, yang mengganti awalan dengan lokasi referensi.
Representasi JSON |
---|
{ "globalCode": string, "compoundCode": string } |
Kolom | |
---|---|
globalCode |
Kode global (penuh) Tempat, seperti "9FWM33GV+HQ", yang mewakili area 1/8000 x 1/8000 derajat (~14 x 14 meter). |
compoundCode |
Kode gabungan tempat, seperti "33GV+HQ, Ramberg, Norwegia", yang berisi akhiran kode global dan mengganti awalan dengan nama berformat dari entitas referensi. |
Area Pandang
Area tampilan lintang-bujur, direpresentasikan sebagai dua titik yang berlawanan secara diagonal dengan low
dan high
. Area pandang dianggap sebagai wilayah tertutup, yaitu menyertakan batasnya. Batas lintang harus berkisar antara -90 hingga 90 derajat inklusif, dan batas bujur harus berkisar antara -180 hingga 180 derajat inklusif. Berbagai kasus meliputi:
Jika
low
=high
, area pandang terdiri dari titik tunggal tersebut.Jika
low.longitude
>high.longitude
, rentang bujur dibalik (area pandang melintasi garis bujur 180 derajat).Jika
low.longitude
= -180 derajat danhigh.longitude
= 180 derajat, area pandang akan menyertakan semua bujur.Jika
low.longitude
= 180 derajat danhigh.longitude
= -180 derajat, rentang bujur kosong.Jika
low.latitude
>high.latitude
, rentang lintang kosong.
low
dan high
harus diisi, dan kotak yang direpresentasikan tidak boleh kosong (seperti yang ditentukan oleh definisi di atas). Area pandang kosong akan menghasilkan error.
Misalnya, area pandang ini sepenuhnya mencakup New York City:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Representasi JSON |
---|
{ "low": { object ( |
Kolom | |
---|---|
low |
Wajib diisi. Titik rendah area pandang. |
high |
Wajib diisi. Titik tinggi area pandang. |
AddressMetadata
Metadata untuk alamat. metadata
tidak dijamin akan terisi penuh untuk setiap alamat yang dikirim ke Address Validation API.
Representasi JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
Kolom | |
---|---|
business |
Menunjukkan bahwa ini adalah alamat bisnis. Jika tidak disetel, nilai akan menunjukkan bahwa nilai tidak diketahui. |
poBox |
Menunjukkan bahwa alamat PO box. Jika tidak disetel, nilai akan menunjukkan bahwa nilai tidak diketahui. |
residential |
Menunjukkan bahwa ini adalah alamat tempat tinggal. Jika tidak disetel, nilai akan menunjukkan bahwa nilai tidak diketahui. |
UspsData
Data USPS untuk alamat. uspsData
tidak dijamin akan terisi penuh untuk setiap alamat PR atau AS yang dikirim ke Address Validation API. Sebaiknya integrasikan kolom alamat cadangan dalam respons jika Anda menggunakan uspsData sebagai bagian utama dari respons.
Representasi JSON |
---|
{
"standardizedAddress": {
object ( |
Kolom | |
---|---|
standardizedAddress |
alamat standar USPS. |
deliveryPointCode |
2 digit kode poin pengiriman |
deliveryPointCheckDigit |
Digit pemeriksaan titik pengiriman. Nomor ini ditambahkan ke akhir delivery_point_barcode untuk email yang dipindai secara mekanis. Menambahkan semua digit delivery_point_barcode, deliveryPointCheckDigit, kode pos, dan ZIP+4 bersama-sama akan menghasilkan angka yang habis dibagi 10. |
dpvConfirmation |
Nilai yang mungkin untuk konfirmasi DPV. Menampilkan satu karakter atau tidak menampilkan nilai.
|
dpvFootnote |
Catatan kaki dari validasi titik pengiriman. Beberapa catatan kaki dapat dirangkai dalam string yang sama.
|
dpvCmra |
Menunjukkan apakah alamatnya adalah CMRA (Commercial Mail Accepted Agency)--bisnis pribadi yang menerima email untuk klien. Menampilkan satu karakter.
|
dpvVacant |
Apakah tempat ini kosong? Menampilkan satu karakter.
|
dpvNoStat |
Apakah ini bukan alamat statistik atau alamat aktif? Tidak ada alamat statistik adalah alamat yang tidak terus ditempati atau alamat yang tidak dilayani oleh USPS. Menampilkan satu karakter.
|
dpvNoStatReasonCode |
Menunjukkan jenis NoStat. Menampilkan kode alasan sebagai int.
|
dpvDrop |
Tanda menunjukkan bahwa email dikirim ke satu tempat yang dapat diterima di suatu situs. Menampilkan satu karakter.
|
dpvThrowback |
Menunjukkan bahwa surat tidak dikirim ke alamat jalan. Menampilkan satu karakter.
|
dpvNonDeliveryDays |
Tanda menunjukkan pengiriman email tidak dilakukan setiap hari dalam seminggu. Menampilkan satu karakter.
|
dpvNonDeliveryDaysValues |
Bilangan bulat yang mengidentifikasi hari gagal tayang. Bisa diinterogasi menggunakan bendera bit: 0x40 – Minggu adalah hari non-pengiriman 0x20 – Senin adalah hari tidak ada pengiriman 0x10 – Selasa adalah hari tidak ada pengiriman 0x08 – Rabu adalah hari tidak ada pengiriman 0x04 – Kamis adalah hari tidak ada pengiriman 0x02 – Jumat adalah hari tidak dikirim |
dpvNoSecureLocation |
Bendera menunjukkan bahwa pintu dapat diakses, tetapi paket tidak akan ditinggalkan karena masalah keamanan. Menampilkan satu karakter.
|
dpvPbsa |
Menunjukkan bahwa alamat cocok dengan data PBSA. Menampilkan satu karakter.
|
dpvDoorNotAccessible |
Tanda menunjukkan alamat yang tidak dapat diketuk oleh USPS untuk mengirimkan email. Menampilkan satu karakter.
|
dpvEnhancedDeliveryCode |
Menunjukkan bahwa lebih dari satu kode pengembalian DPV valid untuk alamat tersebut. Menampilkan satu karakter.
|
carrierRoute |
Kode rute ekspedisi. Kode empat karakter yang terdiri dari awalan satu huruf dan penanda rute tiga digit. Awalan:
|
carrierRouteIndicator |
Indikator pengurutan tarif rute ekspedisi. |
ewsNoMatch |
Alamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa pencocokan persis akan segera tersedia. |
postOfficeCity |
Kota kantor pos utama. |
postOfficeState |
Negara bagian utama kantor pos. |
abbreviatedCity |
Singkatan kota. |
fipsCountyCode |
Kode county FIPS. |
county |
Nama county. |
elotNumber |
Nomor Jalur Perjalanan yang Ditingkatkan (eLOT). |
elotFlag |
Tanda Menaik/Menurun eLOT (A/D). |
lacsLinkReturnCode |
Kode pengembalian LACSLink. |
lacsLinkIndicator |
Indikator LACSLink. |
poBoxOnlyPostalCode |
Kode pos khusus PO Box. |
suitelinkFootnote |
Catatan kaki dari pencocokan data jalan atau gedung tinggi dengan informasi. Jika ditemukan kecocokan nama bisnis, nomor sekunder akan ditampilkan.
|
pmbDesignator |
Penunjuk unit PMB (Private Mail Box). |
pmbNumber |
Nomor PMB (Private Mail Box); |
addressRecordType |
Jenis data alamat yang cocok dengan alamat input.
|
defaultAddress |
Indikator bahwa alamat default ditemukan, tetapi ada alamat yang lebih spesifik. |
errorMessage |
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 saat error ini ada. |
cassProcessed |
Indikator bahwa permintaan telah diproses CASS. |
UspsAddress
Representasi USPS dari alamat di AS.
Representasi JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
Kolom | |
---|---|
firstAddressLine |
Baris alamat pertama. |
firm |
Nama perusahaan. |
secondAddressLine |
Baris alamat kedua. |
urbanization |
Nama urbanisasi Puerto Riko. |
cityStateZipAddressLine |
Kota + negara bagian + kode pos. |
city |
Nama kota. |
state |
Kode negara bagian 2 huruf. |
zipCode |
Kode pos, mis. 10009. |
zipCodeExtension |
Ekstensi kode pos 4 digit mis. 5023. |