Method: resolveNames

Menyelesaikan daftar nama tempat (atau alamat) ke entitas geospasial tertentu (misalnya, tempat) di Google Maps.

Permintaan HTTP

POST https://mapstools.googleapis.com/v1alpha: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 diselesaikan. Anda dapat menentukan hingga 20 kueri.
locationBias

object (LocationBias)

Opsional. Wilayah opsional untuk memengaruhi hasil resolusi. Jika ditentukan, hasil resolusi akan cenderung 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 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 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 v1alpha.resolveNames.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Result)

Hanya output. Daftar entitas yang diselesaikan dari kueri lokasi. Dijamin dipetakan 1:1 dengan indeks queries permintaan. String kosong pada 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 menunjukkan kegagalan sebagian. Kuncinya 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" }.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

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

string

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 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Kolom
Kolom union type. Jenis bias lokasi. type hanya dapat berupa salah satu dari berikut:
viewport

object (Viewport)

Area tampilan yang ditentukan oleh kotak pembatas.

Area Tampilan

Area tampilan lintang-bujur, yang ditampilkan sebagai dua titik low dan high yang berlawanan secara diagonal. Area tampilan dianggap sebagai wilayah 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 dibalik (area pandang melintasi garis bujur 180 derajat).

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

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

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

low dan high harus diisi, dan kotak yang ditampilkan tidak boleh kosong (seperti yang ditentukan oleh definisi di atas). Viewport kosong akan menyebabkan error.

Misalnya, area tampilan 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 terendah area pandang.
high

object (LatLng)

Wajib. Titik tinggi area pandang.

LatLng

Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan nilai ganda 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].

Hasil

Satu entity yang telah diselesaikan dari kueri lokasi tertentu, beserta tingkat keyakinan penyelesaiannya.

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

object (Entity)

Hanya output. Entitas 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 merepresentasikan entitas geospasial tertentu (misalnya, tempat tertentu).