- Permintaan HTTP
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- LocationQuery
- LocationBias
- Result
- Keyakinan (Confidence)
Menyelesaikan daftar nama tempat (atau alamat) ke entitas geospasial tertentu (misalnya, tempat) di Google Maps.
Permintaan HTTP
POST https://mapstools.googleapis.com/v1:resolveNames
URL ini menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "queries": [ { object ( |
| Kolom | |
|---|---|
queries[] |
Wajib. Daftar kueri lokasi yang akan diselesaikan. Anda dapat menentukan hingga 20 kueri. |
locationBias |
Opsional. Wilayah opsional untuk memengaruhi hasil resolusi. Jika ditentukan, hasil resolusi akan cenderung mengarah ke entitas yang lebih dekat dengan wilayah ini. Menyertakan Jika |
regionCode |
Opsional. Kode wilayah opsional untuk memengaruhi hasil resolusi. Jika ditentukan, hasil resolusi akan cenderung mengarah ke entitas yang berada di atau dekat dengan wilayah yang ditentukan. Ini harus berupa kode wilayah CLDR. Misalnya, "US" atau "CA". Menyertakan Jika |
Isi respons
Pesan respons untuk v1.resolveNames.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "results": [ { object ( |
| Kolom | |
|---|---|
results[] |
Hanya output. Daftar entitas yang diselesaikan dari kueri lokasi. Dijamin dipetakan 1:1 dengan indeks |
failedRequests |
Hanya output. Peta yang menunjukkan kegagalan sebagian. Kuncinya adalah indeks permintaan yang gagal di kolom Objek yang berisi daftar pasangan |
saveToMapsUrl |
Hanya output. Link untuk menyimpan semua entitas yang berhasil diselesaikan di Google Maps. |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/maps-platform.mapstools
LocationQuery
Kueri lokasi merepresentasikan entitas lokasi tertentu yang dapat diselesaikan dengan Google Maps. Saat ini, hanya nama tempat dan alamat yang didukung sebagai kueri lokasi.
| Representasi JSON |
|---|
{ "text": string } |
| Kolom | |
|---|---|
text |
Wajib. Kueri teks yang akan diselesaikan ke entitas geospasial tertentu di Google Maps, seperti tempat atau alamat. Makin spesifik kueri, makin akurat resolusinya. Misalnya, "San Francisco", "Googleplex, Mountain View, CA", "1600 Amphitheatre Parkway, Mountain View, CA", atau "Menara Eiffel, Paris". Kueri harus berupa alamat atau nama tempat tertentu. Lokasi umum seperti nama jaringan (misalnya, Starbucks) atau kueri penelusuran seperti "restoran" tidak didukung. |
LocationBias
Wilayah untuk memengaruhi hasil resolusi.
| Representasi JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"viewport": {
object ( |
| Kolom | |
|---|---|
| Jenis bias lokasi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons: | |
viewport |
Area tampilan yang ditentukan oleh kotak pembatas. |
| Akhir kolom yang saling eksklusif. | |
Hasil
Satu entity yang diselesaikan dari kueri lokasi tertentu, beserta tingkat keyakinan penyelesaian.
| Representasi JSON |
|---|
{ "entity": { object ( |
| Kolom | |
|---|---|
entity |
Hanya output. Entitas yang diselesaikan dari kueri lokasi. |
confidence |
Hanya output. Tingkat keyakinan untuk resolusi. |
Keyakinan
Tingkat keyakinan untuk resolusi.
| Enum | |
|---|---|
CONFIDENCE_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
MEDIUM |
Tingkat keyakinan sedang menunjukkan bahwa resolusi kemungkinan benar, tetapi mungkin ada kandidat lain. |
HIGH |
Keyakinan tinggi menunjukkan bahwa resolusi sudah benar dan merepresentasikan entitas geospasial tertentu (misalnya, tempat tertentu). |