Method: resolveNames

Menyelesaikan daftar nama tempat (atau alamat) ke entity 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 (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
Kolom
queries[]

object (LocationQuery)

Wajib. Daftar kueri lokasi yang akan di-resolve. Anda dapat menentukan hingga 20 kueri.
locationBias

object (LocationBias)

Opsional. Wilayah opsional untuk membiaskan hasil resolusi. Jika ditentukan, hasil resolusi akan cenderung mengarah ke entitas yang lebih dekat dengan wilayah ini. Menyertakan locationBias atau regionCode sering kali memberikan hasil yang lebih baik dengan mempersempit ruang penelusuran.

Jika locationBias dan regionCode ditentukan, locationBias akan diprioritaskan daripada regionCode.
regionCode

string

Opsional. Kode wilayah opsional untuk membiaskan hasil resolusi. Jika ditentukan, hasil resolusi akan bias terhadap entity yang berada di atau di dekat wilayah yang ditentukan. Kode ini harus berupa kode wilayah CLDR. Misalnya, "US" atau "CA". Menyertakan locationBias atau regionCode sering kali memberikan hasil yang lebih baik dengan mempersempit ruang penelusuran.

Jika locationBias dan regionCode ditentukan, locationBias akan diprioritaskan daripada regionCode.

Isi respons

Pesan respons untuk v1.resolveNames.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
Kolom
results[]

object (Result)

Hanya output. Daftar entitas yang di-resolve dari kueri lokasi. Dijamin akan dipetakan 1:1 dengan indeks queries permintaan. String kosong di indeks i menunjukkan bahwa resolusi gagal untuk kueri tersebut. Jika resolusi gagal, periksa kolom failedRequests untuk mengetahui status error.
failedRequests

map (key: integer, value: object (Status))

Hanya output. Peta yang mengomunikasikan kegagalan sebagian. Kunci adalah indeks permintaan yang gagal di kolom queries. Nilainya adalah status error yang menjelaskan alasan kegagalan resolusi.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
saveToMapsUrl

string

Hanya output. Link untuk menyimpan semua entitas yang berhasil di-resolve di Google Maps.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

Kueri lokasi mewakili 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

string

Wajib. Kueri teks yang akan di-resolve ke entitas geospasial tertentu di Google Maps, seperti tempat atau alamat. Semakin spesifik kuerinya, semakin akurat penyelesaiannya. 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 yang akan menjadi bias 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 (Viewport)
  }
  // End of mutually exclusive fields.
}
Kolom
Jenis bias lokasi. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
viewport

object (Viewport)

Area pandang yang ditentukan oleh kotak pembatas.
Akhir kolom yang saling eksklusif.

Hasil

Satu entity yang di-resolve dari kueri lokasi tertentu, beserta tingkat keyakinan resolusi.

Representasi JSON 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
Kolom
entity

object (Entity)

Hanya output. Entity yang diselesaikan dari kueri lokasi.
confidence

enum (Confidence)

Hanya output. Tingkat keyakinan untuk resolusi.

Keyakinan

Tingkat keyakinan untuk resolusi.

Enum
CONFIDENCE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
MEDIUM Keyakinan sedang menunjukkan bahwa resolusi kemungkinan benar, tetapi mungkin ada kandidat lain.
HIGH Keyakinan tinggi menunjukkan bahwa resolusi sudah benar dan mewakili entitas geospasial tertentu (misalnya, tempat tertentu).