Method: validateAddress

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 (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Kolom
address

object (PostalAddress)

Wajib. Alamat yang sedang divalidasi. Alamat yang tidak berformat harus dikirim melalui addressLines.

Panjang total kolom dalam input ini tidak boleh lebih dari 280 karakter.

Wilayah yang didukung dapat ditemukan di sini.

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

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

previousResponseId

string

Bidang 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 perlu divalidasi ulang), setiap permintaan tindak lanjut harus mengisi kolom ini dengan responseId dari respons pertama dalam urutan validasi.

enableUspsCass

boolean

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 mengaktifkan CASS USPS 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 Riko" (tidak peka huruf besar/kecil) atau "PR".

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

languageOptions

object (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 informasi selengkapnya, lihat deskripsi tahap peluncuran.

Mengaktifkan Address Validation API untuk menyertakan informasi tambahan dalam respons.

sessionToken

string

Opsional. String yang mengidentifikasi sesi Autocomplete untuk tujuan penagihan. Harus berupa string base64 yang aman untuk 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 melakukan panggilan ke Place Details atau Validasi Alamat. Setiap sesi dapat memiliki beberapa kueri Autocomplete, diikuti dengan satu permintaan Place Details atau Validasi Alamat. Kredensial yang digunakan untuk setiap permintaan dalam suatu sesi harus berasal dari project Konsol Google Cloud yang sama. Setelah sesi selesai, token tidak lagi valid; aplikasi Anda harus membuat token baru untuk setiap sesi. Jika parameter sessionToken dihilangkan, atau jika Anda menggunakan kembali token sesi, sesi tersebut dikenai biaya seolah-olah tidak ada token sesi yang diberikan (setiap permintaan ditagih secara terpisah).

Catatan: Validasi Alamat hanya dapat digunakan dalam sesi dengan API Autocomplete (Baru), bukan Autocomplete API. Lihat https://developers.google.com/maps/documentation/places/web-service/session-pricing untuk detail selengkapnya.

Isi respons

Respons terhadap permintaan validasi alamat.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Kolom
result

object (ValidationResult)

Hasil validasi alamat.

responseId

string

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

PostalAddress

Mewakili alamat pos, mis. untuk pengiriman pos atau alamat pembayaran. Seperti alamat pos, layanan pos dapat mengirimkan item ke lokasi, P.O. Box, atau yang serupa. Aplikasi 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, bergantung pada jenis prosesnya.

Saran terkait input / pengeditan alamat: - Gunakan widget alamat yang siap melakukan internasionalisasi seperti https://github.com/google/libaddressinput) - Pengguna tidak boleh diberi elemen UI untuk memasukkan atau mengedit kolom selain negara tempat kolom tersebut digunakan.

Untuk panduan lebih lanjut 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

integer

Revisi skema PostalAddress. Nilai apa pun selain 0 akan menyebabkan API menampilkan error INVALID_ARGUMENT.

regionCode

string

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 mengetahui detailnya. Contoh: "CH" untuk Swiss. Jika kode wilayah tidak diberikan, kode tersebut akan diambil dari alamat. Untuk performa terbaik, sebaiknya sertakan kode wilayah jika Anda mengetahuinya. Wilayah yang tidak konsisten atau berulang dapat menyebabkan performa yang buruk, misalnya, jika addressLines sudah menyertakan wilayah, jangan masukkan kode wilayah lagi di kolom ini. Wilayah yang didukung dapat ditemukan di FAQ.

languageCode

string

Kode bahasa di alamat input dicadangkan untuk penggunaan di masa mendatang dan diabaikan hari ini. API menampilkan alamat dalam bahasa yang sesuai untuk lokasi alamat tersebut.

postalCode

string

Opsional. Kode pos alamat. Tidak semua negara menggunakan atau mewajibkan keberadaan kode pos, tetapi jika digunakan, kode pos tersebut dapat memicu validasi tambahan dengan bagian alamat yang lain (misalnya validasi negara bagian/pos di Amerika Serikat).

sortingCode

string

Opsional. Kode pengurutan tambahan khusus negara. Atribut ini tidak digunakan di sebagian besar wilayah. Jika digunakan, nilainya berupa string seperti "CEDEX", secara opsional diikuti dengan angka (misalnya "CEDEX 7"), atau hanya angka, yang mewakili "kode sektor" (Jamaika), "indikator area pengiriman" (Malawi), atau "indikator kantor pos" (misalnya Côte d'Ivoire).

administrativeArea

string

Opsional. Subdivisi administratif tertinggi yang digunakan untuk alamat pos 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 "Catalunya"). Banyak negara tidak menggunakan wilayah administratif dalam alamat pos. Misalnya, di Swiss, kolom ini harus dibiarkan tidak terisi.

locality

string

Opsional. Secara umum merujuk pada bagian kota dari alamat. 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

string

Opsional. Sublokalitas alamat. Misalnya, ini dapat berupa kawasan, kota kecil, distrik.

addressLines[]

string

Wajib. Baris alamat tidak terstruktur yang menggambarkan tingkat alamat yang lebih rendah.

Karena nilai di addressLines tidak memiliki informasi jenis dan terkadang dapat berisi beberapa nilai dalam satu kolom (misalnya "Austin, TX"), urutan baris harus jelas. Urutan baris alamat harus "urutan amplop" untuk negara/wilayah alamat.

Representasi struktural minimum yang diizinkan dari sebuah alamat terdiri dari semua informasi yang ditempatkan di addressLines. Jika regionCode tidak disediakan, wilayah akan disimpulkan dari baris alamat.

Membuat alamat yang hanya berisi addressLines, lalu geocoding adalah cara yang direkomendasikan untuk menangani alamat yang benar-benar tidak terstruktur (bukan menebak bagian alamat mana yang harus merupakan lokalitas atau wilayah administratif).

recipients[]

string

Jangan tetapkan kolom ini. Address Validation API saat ini tidak menggunakannya. Meskipun saat ini API tidak akan menolak permintaan dengan set kolom ini, informasi akan dibuang dan tidak akan ditampilkan dalam respons.

organization

string

Jangan tetapkan kolom ini. Address Validation API saat ini tidak menggunakannya. Meskipun saat ini API tidak akan menolak permintaan dengan set kolom ini, informasi akan dibuang dan tidak akan ditampilkan 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 informasi selengkapnya, lihat deskripsi tahap peluncuran.

Mengaktifkan Address Validation API untuk menyertakan informasi tambahan dalam respons.

Representasi JSON
{
  "returnEnglishLatinAddress": boolean
}
Kolom
returnEnglishLatinAddress

boolean

Pratinjau: Menampilkan google.maps.addressvalidation.v1.Address dalam bahasa Inggris. Untuk lebih detailnya, lihat google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

ValidationResult

Hasil validasi alamat.

Representasi JSON
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Kolom
verdict

object (Verdict)

Tanda verdict keseluruhan

address

object (Address)

Informasi tentang alamat itu sendiri yang berbeda dengan geocode.

geocode

object (Geocode)

Informasi tentang lokasi dan tempat yang akan di-geocoding pada alamat tersebut.

metadata

object (AddressMetadata)

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

uspsData

object (UspsData)

Tanda pengiriman tambahan disediakan oleh USPS. Hanya disediakan di wilayah US dan PR.

englishLatinAddress

object (Address)

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 informasi selengkapnya, lihat deskripsi tahap peluncuran.

Alamat diterjemahkan ke bahasa Inggris.

Alamat yang diterjemahkan tidak dapat digunakan kembali sebagai input API. Layanan ini menyediakannya sehingga pengguna dapat menggunakan bahasa asli mereka untuk mengonfirmasi atau menolak validasi alamat yang awalnya disediakan.

Jika bagian alamat tidak memiliki terjemahan bahasa Inggris, layanan akan menampilkan bagian tersebut dalam bahasa alternatif yang menggunakan skrip Latin. Lihat di sini untuk mendapatkan 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.

Aktifkan output ini menggunakan flag google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Catatan: kolom google.maps.addressvalidation.v1.Address.unconfirmed_component_types di englishLatinAddress dan kolom google.maps.addressvalidation.v1.AddressComponent.confirmation_level di englishLatinAddress.address_components tidak diisi.

Putusan

Ringkasan tingkat tinggi hasil validasi alamat dan geocode.

Representasi JSON
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Kolom
inputGranularity

enum (Granularity)

Perincian alamat input. Ini adalah hasil dari penguraian alamat input dan tidak memberikan sinyal validasi apa pun. Untuk sinyal validasi, lihat validationGranularity di bawah.

Misalnya, jika alamat input menyertakan nomor apartemen tertentu, inputGranularity di sini adalah SUB_PREMISE. Jika kami tidak dapat mencocokkan nomor apartemen dalam database atau nomor apartemen tidak valid, validationGranularity kemungkinan adalah PREMISE atau di bawahnya.

validationGranularity

enum (Granularity)

Tingkat perincian yang dapat digunakan API untuk validate alamat sepenuhnya. Misalnya, validationGranularity dari PREMISE menunjukkan semua komponen alamat pada level PREMISE atau yang lebih kasar dapat divalidasi.

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

geocodeGranularity

enum (Granularity)

Informasi tentang perincian geocode. Ini bisa dipahami sebagai makna semantik tentang seberapa kasar atau halus lokasi yang di-geocode.

Ini terkadang dapat berbeda dari validationGranularity di atas. Misalnya, {i>database<i} kita mungkin mencatat keberadaan nomor apartemen tetapi tidak memiliki lokasi persis untuk apartemen dalam kompleks apartemen yang besar. Dalam hal ini, validationGranularity akan menjadi SUB_PREMISE, tetapi geocodeGranularity akan menjadi PREMISE.

addressComplete

boolean

Alamat 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 missingComponentTypes, unresolvedTokens, atau unexpected untuk detail selengkapnya.

hasUnconfirmedComponents

boolean

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

hasInferredComponents

boolean

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

hasReplacedComponents

boolean

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

Tingkat perincian

Berbagai perincian yang dapat dimiliki oleh alamat atau geocode. Jika digunakan untuk menunjukkan perincian untuk alamat, nilai ini menunjukkan seberapa baik tingkat perincian alamat mengidentifikasi tujuan email. Misalnya, alamat seperti "123 Main Street, Redwood City, CA, 94061" mengidentifikasi PREMISE, sedangkan alamat 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 mendekati lokasi tingkat bangunan untuk alamat tersebut.
BLOCK Alamat atau geocode menunjukkan blok. Hanya digunakan di wilayah yang memiliki pemberian alamat tingkat blok, seperti Jepang.
ROUTE Geocode atau alamat terperinci untuk merutekan, seperti jalan, jalan, atau jalan raya.
OTHER Semua perincian lainnya, yang dikelompokkan bersama karena tidak dapat diserahkan.

Alamat

Detail alamat yang telah diproses. Pasca-pemrosesan mencakup memperbaiki bagian alamat yang salah eja, mengganti bagian yang salah, dan menyimpulkan bagian yang hilang.

Representasi JSON
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Kolom
formattedAddress

string

Alamat yang telah diproses, yang diformat sebagai alamat satu baris dengan mengikuti aturan pemformatan alamat di wilayah tempat alamat berada.

postalAddress

object (PostalAddress)

Alamat yang telah diproses sebelumnya sebagai alamat pos.

addressComponents[]

object (AddressComponent)

Daftar yang tidak diurutkan. Komponen alamat individual dari alamat yang diformat dan dikoreksi, bersama dengan informasi validasi. Hal ini memberikan informasi tentang status validasi setiap komponen.

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

missingComponentTypes[]

string

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

unconfirmedComponentTypes[]

string

Jenis komponen yang ada di addressComponents, tetapi tidak dapat dikonfirmasi keakuratannya. Kolom ini disediakan untuk memudahkan: kontennya setara dengan melakukan iterasi melalui addressComponents untuk menemukan jenis semua komponen dengan confirmationLevel yang bukan CONFIRMED atau flag inferred tidak ditetapkan ke true. Daftar kemungkinan jenis dapat ditemukan di sini.

unresolvedTokens[]

string

Token dalam input yang tidak dapat diselesaikan. Ini mungkin 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.

Representasi JSON
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Kolom
componentName

object (ComponentName)

Nama untuk komponen ini.

componentType

string

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

confirmationLevel

enum (ConfirmationLevel)

Menunjukkan tingkat kepastian yang kita miliki bahwa komponen sudah benar.

inferred

boolean

Menunjukkan bahwa komponen bukan bagian dari input, tetapi kita menyimpulkannya untuk lokasi alamat dan yakin bahwa komponen harus diberikan untuk alamat lengkap.

spellCorrected

boolean

Menunjukkan koreksi kesalahan ejaan dalam nama komponen. API tersebut tidak selalu menandai perubahan dari satu varian ejaan ke varian ejaan lainnya, seperti saat mengubah "center" menjadi "center". Error ini juga tidak selalu menandai kesalahan ejaan umum, seperti ketika mengubah "Amphitheater Pkwy" menjadi "Amphitheatre Pkwy".

replaced

boolean

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

unexpected

boolean

Menunjukkan komponen alamat yang tidak diharapkan ada dalam alamat pos untuk wilayah yang ditentukan. Kami mempertahankannya hanya karena itu merupakan bagian dari input.

ComponentName

Wrapper untuk nama komponen.

Representasi JSON
{
  "text": string,
  "languageCode": string
}
Kolom
text

string

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

languageCode

string

Kode bahasa BCP-47. 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 masuk akal dalam konteks alamat lainnya.
UNCONFIRMED_BUT_PLAUSIBLE Komponen ini tidak dapat dikonfirmasi, tetapi kemungkinan besar komponen tersebut ada. Misalnya, nomor jalan dalam rentang nomor valid yang diketahui di jalan yang tidak mengetahui nomor rumah tertentu.
UNCONFIRMED_AND_SUSPICIOUS Komponen ini belum dikonfirmasi dan kemungkinan salah. Misalnya, lingkungan yang tidak sesuai dengan informasi lain dari alamat tersebut.

Geocode

Berisi informasi tentang tempat tempat input geocode.

Representasi JSON
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Kolom
location

object (LatLng)

Lokasi input yang di-geocode.

Lebih disarankan menggunakan ID tempat daripada alamat, koordinat lintang/bujur, atau kode plus. Menggunakan koordinat saat merutekan atau menghitung arah mengemudi akan selalu mengakibatkan titik dipaskan ke jalan yang paling dekat dengan koordinat tersebut. Jalan ini mungkin bukan jalan yang akan mengarah dengan cepat atau aman ke tujuan dan mungkin tidak dekat titik akses ke properti. Selain itu, bila lokasi di-geocode terbalik, tidak ada jaminan bahwa alamat yang ditampilkan akan cocok dengan alamat aslinya.

plusCode

object (PlusCode)

Plus Codes yang sesuai dengan location.

bounds

object (Viewport)

Batas tempat yang di-geocoding.

featureSizeMeters

number

Ukuran tempat yang di-geocode, dalam meter. Ini adalah ukuran lain dari kekasaran lokasi geocode, namun dalam ukuran fisik, bukan dalam arti semantik.

placeId

string

PlaceID tempat yang akan di-geocode oleh input ini.

Untuk informasi selengkapnya tentang ID Tempat, lihat di sini.

placeTypes[]

string

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

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

number

Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0].

longitude

number

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 14 m x 14 m (1/8000 derajat) atau kotak yang lebih kecil, dan kode gabungan, yang menggantikan awalan dengan lokasi referensi.

Representasi JSON
{
  "globalCode": string,
  "compoundCode": string
}
Kolom
globalCode

string

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

compoundCode

string

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

Area Tampilan

Area pandang lintang dan bujur, yang direpresentasikan sebagai dua titik low dan high yang secara diagonal berlawanan. Area pandang dianggap sebagai area tertutup, yaitu mencakup batasnya. Batas lintang harus berkisar antara -90 hingga 90 derajat inklusif, dan batas bujur harus berkisar antara -180 hingga 180 derajat inklusif. Berbagai kasus mencakup:

  • Jika low = high, area tampilan terdiri dari satu titik tersebut.

  • Jika low.longitude > high.longitude, rentang bujur akan dibalik (area pandang melintasi garis bujur 180 derajat).

  • Jika low.longitude = -180 derajat dan high.longitude = 180 derajat, area pandang akan mencakup semua garis bujur.

  • Jika low.longitude = 180 derajat dan high.longitude = -180 derajat, rentang bujur kosong.

  • Jika low.latitude > high.latitude, rentang lintang kosong.

low dan high harus diisi, dan kotak yang diwakili 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Kolom
low

object (LatLng)

Wajib. Titik rendah area pandang.

high

object (LatLng)

Wajib. 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

boolean

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

poBox

boolean

Menunjukkan bahwa alamat PO box. Jika tidak disetel, nilai akan tidak diketahui.

residential

boolean

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

UspsData

Data USPS untuk alamat. uspsData tidak dijamin akan terisi penuh untuk setiap alamat PR atau Amerika Serikat yang dikirim ke Address Validation API. Sebaiknya integrasikan kolom alamat cadangan dalam respons jika Anda menggunakan uspsData sebagai bagian utama respons.

Representasi JSON
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Kolom
standardizedAddress

object (UspsAddress)

alamat standar USPS.

deliveryPointCode

string

Kode poin pengiriman 2 digit

deliveryPointCheckDigit

string

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 secara bersamaan akan menghasilkan angka yang dapat dibagi 10.

dpvConfirmation

string

Nilai yang mungkin untuk konfirmasi DPV. Menampilkan satu karakter atau tidak menampilkan nilai.

  • N: Informasi nomor utama dan sekunder gagal dikonfirmasi oleh DPV.
  • D: Alamat dikonfirmasi DPV hanya untuk nomor utama, dan informasi nomor sekunder tidak ada.
  • S: Alamat dikonfirmasi oleh DPV hanya untuk nomor utama, dan ada informasi nomor sekunder, tetapi tidak dikonfirmasi.
  • Y: Alamat telah dikonfirmasi DPV untuk nomor utama dan sekunder.
  • Kosong: Jika respons tidak berisi nilai dpvConfirmation, alamat tidak dikirim untuk konfirmasi DPV.
dpvFootnote

string

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

  • AA: Alamat input yang 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 dan tidak wajib
  • C1: Nomor sekunder tidak cocok, tetapi wajib diisi
  • N1: Alamat gedung tinggi tidak memiliki nomor sekunder
  • M1: Nomor utama tidak ada
  • M3: Nomor utama tidak valid
  • P1: Nomor kotak PO, RR, atau HC alamat input tidak ada
  • P3: Alamat masukan PO, RR, atau HC Box tidak valid
  • F1: Alamat input yang cocok dengan alamat militer
  • G1: Alamat input yang cocok dengan alamat pengiriman umum
  • U1: Alamat input yang cocok dengan kode pos unik
  • PB: Alamat input cocok dengan data PBSA
  • RR: Alamat DPV dikonfirmasi dengan informasi PMB
  • R1: Alamat DPV dikonfirmasi tanpa informasi PMB
  • R7: Data Rute Operator R777 atau R779
  • IA: Alamat yang Diinformasikan diidentifikasi
  • TA: Angka utama yang dicocokkan dengan melepaskan alfa di akhir
dpvCmra

string

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

  • Y: Alamatnya adalah CMRA
  • N: Alamat bukan CMRA
dpvVacant

string

Apakah tempat ini kosong? Menampilkan satu karakter.

  • Y: Alamat kosong
  • N: Alamat tidak kosong
dpvNoStat

string

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

  • Y: Alamat tidak aktif
  • N: Alamat aktif
dpvNoStatReasonCode

integer

Menunjukkan jenis NoStat. Menampilkan kode alasan sebagai int.

  • 1: IDA (Internal Drop Address) – Alamat yang tidak menerima email langsung dari USPS tetapi dikirim ke alamat lepas yang melayani mereka.
  • 2: CDS - Alamat yang belum dapat dikirim. Misalnya, subdivisi baru dengan lot dan angka utama telah ditentukan, tetapi belum ada struktur untuk jumlah tamu.
  • 3: Konflik - Alamat yang sebenarnya tidak mengonfirmasi DPV.
  • 4: CMZ (Perguruan Tinggi, Militer, dan Jenis Lainnya) - ZIP + 4 kumpulan data yang telah dimasukkan USPS ke dalam data.
  • 5: Reguler - Menunjukkan alamat yang tidak menerima pengiriman dan alamat tidak dihitung sebagai kemungkinan pengiriman.
  • 6: Wajib Sekunder - Alamat memerlukan informasi sekunder.
dpvDrop

string

Tanda menunjukkan bahwa email dikirim ke satu penerima pesan di situs. Menampilkan satu karakter.

  • Y: Email dikirim ke satu resepsi di situs.
  • N: Email tidak dikirim ke satu resep saja di situs.
dpvThrowback

string

Menunjukkan bahwa surat tidak dikirim ke alamat tersebut. Menampilkan satu karakter.

  • Y: Surat tidak dikirim ke alamat.
  • N: Surat dikirim ke alamat.
dpvNonDeliveryDays

string

Bendera menunjukkan pengiriman email tidak dilakukan setiap hari dalam seminggu. Menampilkan satu karakter.

  • Y: Pengiriman email tidak dilakukan setiap hari dalam seminggu.
  • N: Tidak ada indikasi bahwa pengiriman email tidak dilakukan setiap hari dalam seminggu.
dpvNonDeliveryDaysValues

integer

Bilangan bulat yang mengidentifikasi hari gagal tayang. Hal ini dapat diinterogasi menggunakan bit flag: 0x40 - Minggu adalah hari tidak terkirim 0x20 - Senin adalah hari tidak terkirim 0x10 - Selasa adalah hari tidak dikirim 0x08 - Rabu adalah hari tidak terkirim 0x04 - Kamis adalah hari tidak terkirim 0x02 - Jumat adalah hari tidak terkirim 0x01 - Sabtu adalah hari tidak terkirim

dpvNoSecureLocation

string

Tanda menunjukkan bahwa pintu dapat diakses, tetapi paket tidak akan ditinggalkan karena masalah keamanan. Menampilkan satu karakter.

  • Y: Paket tidak akan ditinggalkan karena masalah keamanan.
  • N: Tidak ada indikasi bahwa paket tidak akan ditinggalkan karena masalah keamanan.
dpvPbsa

string

Menunjukkan bahwa alamat cocok dengan data PBSA. Menampilkan satu karakter.

  • Y: Alamat dicocokkan dengan data PBSA.
  • N: Alamat tidak cocok dengan data PBSA.
dpvDoorNotAccessible

string

Bendera menunjukkan alamat tempat USPS tidak dapat mengetuk pintu untuk mengirim email. Menampilkan satu karakter.

  • Y: Pintu tidak dapat diakses.
  • N: Tidak ada indikasi bahwa pintu tidak dapat diakses.
dpvEnhancedDeliveryCode

string

Menunjukkan bahwa lebih dari satu kode pengembalian DPV yang valid untuk alamat tersebut. Menampilkan satu karakter.

  • Y: Alamat telah dikonfirmasi DPV untuk nomor utama dan sekunder.
  • N: Informasi nomor utama dan sekunder gagal dikonfirmasi oleh DPV.
  • S: Alamat dikonfirmasi DPV hanya untuk nomor utama saja, dan informasi nomor sekunder ada dengan tidak dikonfirmasi, atau satu alfa akhir pada nomor utama dihapus untuk membuat pencocokan DPV dan informasi sekunder diperlukan.
  • D: Alamat dikonfirmasi DPV hanya untuk nomor utama, dan informasi nomor sekunder tidak ada.
  • R: Alamat dikonfirmasi tetapi ditetapkan ke rute phantom R777 dan R779 serta pengiriman USPS tidak diberikan.
carrierRoute

string

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

Awalan:

  • C: Rute ekspedisi (atau rute kota)
  • R: Rute pedesaan
  • H: Rute Kontrak Jalan Raya
  • B: Bagian Kotak Pos Kantor
  • G: Unit pengiriman umum
carrierRouteIndicator

string

Indikator pengurutan tarif rute ekspedisi.

ewsNoMatch

boolean

Alamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa alamat yang sama persis akan tersedia dalam waktu dekat.

postOfficeCity

string

Kota kantor pos utama.

postOfficeState

string

Negara bagian utama kantor pos.

abbreviatedCity

string

Singkatan kota.

fipsCountyCode

string

Kode wilayah FIPS.

county

string

Nama county.

elotNumber

string

Nomor Line of Travel (eLOT) yang ditingkatkan.

elotFlag

string

eLOT Tanda Menaik/Menurun (A/D).

poBoxOnlyPostalCode

boolean

Hanya kode pos PO Box.

pmbDesignator

string

Penanda unit PMB (Private Mail Box).

pmbNumber

string

Nomor PMB (Private Mail Box);

addressRecordType

string

Jenis data alamat yang cocok dengan alamat input.

  • F: FIRM. Pola ini adalah kecocokan dengan Firm Record, yang merupakan tingkat kecocokan terbaik yang tersedia untuk sebuah alamat.
  • G: PENGIRIMAN UMUM. Ini cocok dengan catatan Pengiriman Umum.
  • H: MEMBUAT / APARTEMEN. Hasil ini cocok dengan catatan Gedung atau Apartemen.
  • P: KOTAK POSTINGAN. Kotak ini cocok dengan Kotak Pos.
  • R: RUTIN RUTE atau KONTRAK TINGGI: Ini adalah kecocokan dengan catatan Rute Pedesaan atau Kontrak Jalan Raya, yang keduanya mungkin memiliki rentang Nomor Kotak terkait.
  • S: STREET RECORD: Ini adalah kecocokan dengan catatan Jalan yang berisi rentang nomor utama yang valid.
defaultAddress

boolean

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

errorMessage

string

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

Kolom data USPS mungkin tidak diisi saat ada error ini.

cassProcessed

boolean

Indikator bahwa permintaan telah diproses CASS.

UspsAddress

Representasi USPS untuk alamat AS.

Representasi JSON
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Kolom
firstAddressLine

string

Baris alamat pertama.

firm

string

Nama perusahaan.

secondAddressLine

string

Baris alamat kedua.

urbanization

string

Nama urbanisasi Puerto Riko.

cityStateZipAddressLine

string

Kota + negara bagian + kode pos.

city

string

Nama kota.

state

string

Kode negara bagian 2 huruf.

zipCode

string

Kode pos, misalnya 10009.

zipCodeExtension

string

Ekstensi kode pos 4 digit, misalnya 5023.