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 diisi. Alamat yang sedang divalidasi. Alamat yang tidak berformat harus dikirimkan 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 pada 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. Setiap nilai di kolom tersebut akan dihapus dan tidak ditampilkan. Jangan menyetelnya.
previousResponseId

string

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 responseId dari respons pertama dalam urutan validasi.
enableUspsCass

boolean

Mengaktifkan mode yang kompatibel dengan USPS CASS. Hal ini hanya memengaruhi kolom google.maps.addressvalidation.v1.ValidationResult.usps_data dari google.maps.addressvalidation.v1.ValidationResult. Catatan: untuk permintaan yang mengaktifkan USPS CASS untuk alamat di Puerto Riko, google.type.PostalAddress.region_code address harus diberikan sebagai "PR", atau google.type.PostalAddress.administrative_area address harus diberikan sebagai "Puerto Riko" (tidak peka huruf besar/kecil) atau "PR".

Sebaiknya gunakan address yang terdiri atas berbagai komponen, atau tentukan setidaknya dua google.type.PostalAddress.address_lines dengan baris pertama berisi nomor dan nama jalan dan baris kedua berisi kota, negara bagian/provinsi, 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 mengetahui 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 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 sessionToken dihapus, 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 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 (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 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

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 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 addressLines sudah menyertakan wilayah tersebut, jangan berikan 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 dengan lokasi alamat tersebut.
postalCode

string

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

string

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

string

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

string

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

string

Opsional. Sublokalitas alamat. Misalnya, ini dapat berupa kawasan, kota besar, distrik.
addressLines[]

string

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

Karena nilai dalam 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 berupa "urutan amplop" untuk negara/wilayah alamat.

Representasi struktural minimum yang diizinkan untuk alamat terdiri dari semua informasi yang ditempatkan di addressLines. Jika regionCode tidak diberikan, region akan diambil dari baris alamat.

Membuat alamat yang hanya berisi addressLines, lalu geocoding adalah cara yang direkomendasikan untuk menangani alamat yang benar-benar tidak terstruktur (daripada menebak bagian alamat mana yang harus berupa 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 kumpulan kolom ini, informasi akan dibuang dan tidak akan dikembalikan dalam respons.
organization

string

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

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 putusan keseluruhan
address

object (Address)

Informasi tentang alamat itu sendiri, bukan geocode.
geocode

object (Geocode)

Informasi tentang lokasi dan tempat yang di-geocode alamat.
metadata

object (AddressMetadata)

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

object (UspsData)

Tanda pengiriman tambahan yang disediakan oleh USPS. Hanya disediakan di region 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 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 google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

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

Putusan

Ringkasan lengkap 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 kita tidak dapat mencocokkan nomor apartemen di database atau nomor apartemen tidak valid, validationGranularity kemungkinan akan berupa PREMISE atau di bawahnya.
validationGranularity

enum (Granularity)

Tingkat perincian yang dapat dipenuhi API untuk sepenuhnya memvalidasi alamat. Misalnya, validationGranularity dari PREMISE menunjukkan bahwa semua komponen alamat pada level PREMISE atau yang lebih umum dapat divalidasi.

Per hasil validasi komponen alamat dapat ditemukan di google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Informasi tentang tingkat perincian geocode. Hal ini dapat dipahami sebagai arti semantik tentang seberapa kasar atau halus lokasi yang di-geocode.

Hal ini terkadang dapat berbeda dari validationGranularity di atas. Misalnya, {i>database<i} kami mungkin mencatat keberadaan nomor apartemen, tetapi tidak memiliki lokasi akurat untuk apartemen tersebut di 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, nilai tersebut akan menunjukkan bahwa nilainya adalah false. Lihat kolom missingComponentTypes, unresolvedTokens, atau unexpected untuk mengetahui 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 disimpulkan (ditambahkan) yang tidak ada dalam input. Lihat google.maps.addressvalidation.v1.Address.address_components untuk mengetahui detailnya.
hasReplacedComponents

boolean

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

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 (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Kolom
formattedAddress

string

Alamat pascapemrosesan, yang diformat sebagai alamat satu baris dengan mengikuti aturan pemformatan alamat di wilayah tempat alamat tersebut berada.
postalAddress

object (PostalAddress)

Alamat pascapemrosesan yang diwakili sebagai alamat pos.
addressComponents[]

object (AddressComponent)

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[]

string

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 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 sebagai benar. Kolom ini disediakan demi kenyamanan: kontennya setara dengan melakukan iterasi melalui addressComponents untuk menemukan jenis semua komponen yang confirmationLevel bukan CONFIRMED atau flag inferred tidak disetel ke true. Daftar kemungkinan jenis dapat ditemukan di sini.
unresolvedTokens[]

string

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 ["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 tersebut benar.
inferred

boolean

Menunjukkan bahwa komponen bukan bagian dari input, tetapi kami menyimpulkannya untuk lokasi alamat dan meyakini bahwa komponen tersebut seharusnya diberikan untuk alamat lengkap.
spellCorrected

boolean

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

boolean

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

boolean

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

string

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

string

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 (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Kolom
location

object (LatLng)

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

object (PlusCode)

Kode plus 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 yang di-geocode, namun dalam ukuran fisik, bukan dalam arti semantik.
placeId

string

PlaceID tempat input geocode ini.

Untuk informasi selengkapnya tentang ID Tempat, lihat di sini.
placeTypes[]

string

Jenis tempat yang akan di-geocode input. 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 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

string

Kode global (penuh) Tempat, seperti "9FWM33GV+HQ", yang mewakili area 1/8000 x 1/8000 derajat (~14 x 14 meter).
compoundCode

string

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 dan high.longitude = 180 derajat, area pandang akan menyertakan semua 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 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:

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

Representasi JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Kolom
low

object (LatLng)

Wajib diisi. Titik rendah area pandang.
high

object (LatLng)

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

boolean

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

boolean

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

boolean

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 (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

2 digit kode poin pengiriman
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 bersama-sama akan menghasilkan angka yang habis 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 DPV.
  • D: Alamat dikonfirmasi hanya untuk nomor utama, dan informasi nomor sekunder tidak ada.
  • S: Alamat dikonfirmasi hanya untuk nomor utama, dan informasi nomor sekunder ada tetapi tidak dikonfirmasi.
  • Y: Alamat 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 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 diisi
  • C1: Nomor sekunder tidak cocok, tetapi wajib diisi
  • N1: Alamat bertingkat 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: Nomor kotak input PO, RR, atau HC 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 yang dikonfirmasi dengan DPV dengan informasi PMB
  • R1: Alamat yang dikonfirmasi DPV tanpa informasi PMB
  • R7: Data Rute Operator R777 atau R779
  • IA: Alamat yang Diinformasikan teridentifikasi
  • TA: Nomor utama dicocokkan dengan menghapus alfa di akhir
dpvCmra

string

Menunjukkan apakah alamatnya adalah CMRA (Commercial Mail Accepted 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 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.

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

integer

Menunjukkan jenis NoStat. Menampilkan kode alasan sebagai int.

  • 1: IDA (Alamat Penyimpanan Internal) – Alamat yang tidak menerima email langsung dari USPS, tetapi dikirim ke alamat lepas yang melayaninya.
  • 2: CDS - Alamat yang belum dapat dikirim. Misalnya, subdivisi baru tempat banyak dan nomor utama telah ditentukan, tetapi belum ada struktur untuk jumlah tamu.
  • 3: Tabrakan - Alamat yang sebenarnya tidak mengonfirmasi DPV.
  • 4: CMZ (College, Military, dan Lainnya) - ZIP + 4 data yang telah dimasukkan USPS ke dalam data.
  • 5: Reguler - Menunjukkan alamat yang tidak menerima pengiriman dan alamat tidak dihitung sebagai kemungkinan pengiriman.
  • 6: Sekunder Wajib - Alamat memerlukan informasi sekunder.
dpvDrop

string

Tanda menunjukkan bahwa email dikirim ke satu tempat yang dapat diterima di suatu situs. Menampilkan satu karakter.

  • Y: Email dikirim ke satu penerima di sebuah situs.
  • N: Email tidak dikirim ke satu tempat yang dapat diterima di suatu situs.
dpvThrowback

string

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

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

string

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

string

Bendera 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

Tanda menunjukkan alamat yang tidak dapat diketuk oleh USPS untuk mengirimkan 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 valid untuk alamat tersebut. Menampilkan satu karakter.

  • Y: Alamat dikonfirmasi DPV untuk nomor utama dan sekunder.
  • N: Informasi nomor utama dan sekunder gagal dikonfirmasi DPV.
  • S: Alamat dikonfirmasi hanya untuk nomor utama, dan informasi nomor sekunder ada tetapi tidak dikonfirmasi, atau satu alfa akhir pada nomor utama dihapus untuk membuat pencocokan DPV dan informasi sekunder diperlukan.
  • D: Alamat dikonfirmasi hanya untuk nomor utama, dan informasi nomor sekunder tidak ada.
  • R: Alamat dikonfirmasi, tetapi ditetapkan ke pengiriman rute palsu 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 Kantor Pos
  • G: Unit pengiriman umum
carrierRouteIndicator

string

Indikator pengurutan tarif rute ekspedisi.
ewsNoMatch

boolean

Alamat pengiriman dapat dicocokkan, tetapi file EWS menunjukkan bahwa pencocokan persis akan segera tersedia.
postOfficeCity

string

Kota kantor pos utama.
postOfficeState

string

Negara bagian utama kantor pos.
abbreviatedCity

string

Singkatan kota.
fipsCountyCode

string

Kode county FIPS.
county

string

Nama county.
elotNumber

string

Nomor Jalur Perjalanan yang Ditingkatkan (eLOT).
elotFlag

string

Tanda Menaik/Menurun eLOT (A/D).
poBoxOnlyPostalCode

boolean

Kode pos khusus PO Box.
pmbDesignator

string

Penunjuk unit PMB (Private Mail Box).
pmbNumber

string

Nomor PMB (Private Mail Box);
addressRecordType

string

Jenis data alamat yang cocok dengan alamat input.

  • F: FIRM. Data ini dicocokkan dengan Catatan Perusahaan, yang merupakan tingkat kecocokan terbaik yang tersedia untuk suatu alamat.
  • G: PENGIRIMAN UMUM. Data ini cocok dengan data Pengiriman Umum.
  • H: PENGEMBANGAN / Apartemen. Ini cocok dengan catatan Bangunan atau Apartemen.
  • P: KOTAK KANTOR POSTINGAN. Ini cocok dengan Kotak Pos.
  • R: ROUTE RURAL atau TINGGI KONTRAK: Ini cocok dengan catatan Rute Pedesaan atau Kontrak Jalan Raya, yang keduanya mungkin memiliki rentang Nomor Kotak terkait.
  • S: RECORD STREET: Ini cocok dengan data 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 deteksi alamat yang dibuat secara artifisial.

Kolom data USPS mungkin tidak diisi saat error ini ada.
cassProcessed

boolean

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

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, mis. 10009.
zipCodeExtension

string

Ekstensi kode pos 4 digit mis. 5023.