Method: places.searchNearby

Menelusuri tempat di dekat lokasi.

Permintaan HTTP

POST https://places.googleapis.com/v1/places:searchNearby

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  }
}
Kolom
languageCode

string

Detail tempat akan ditampilkan dengan bahasa pilihan jika tersedia. Jika kode bahasa tidak ditentukan atau tidak dikenali, detail tempat dalam bahasa apa pun dapat ditampilkan, dengan preferensi untuk bahasa Inggris jika detail tersebut ada.

Daftar bahasa yang didukung saat ini: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

Kode negara/wilayah Unicode (CLDR) lokasi asal permintaan. Parameter ini digunakan untuk menampilkan detail tempat, seperti nama tempat khusus wilayah, jika tersedia. Parameter ini dapat memengaruhi hasil berdasarkan hukum yang berlaku.

Untuk informasi selengkapnya, lihat https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Perhatikan bahwa kode wilayah 3 digit saat ini tidak didukung.
includedTypes[]

string

Jenis Tempat yang disertakan (misalnya, "restaurant" atau "gas_station") dari https://developers.google.com/maps/documentation/places/web-service/place-types.

Maksimal 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis yang bertentangan, yaitu jenis yang muncul di includedTypes dan excludedTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditentukan dengan beberapa batasan jenis, hanya tempat yang memenuhi semua batasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan menyediakan layanan terkait "restoran", tetapi tidak beroperasi terutama sebagai "restoran".
excludedTypes[]

string

Jenis Tempat yang dikecualikan (misalnya, "restaurant" atau "gas_station") dari https://developers.google.com/maps/documentation/places/web-service/place-types.

Maksimal 50 jenis dari Tabel A dapat ditentukan.

Jika klien memberikan includedTypes (misalnya restoran) dan excludedTypes (misalnya kafe), respons harus menyertakan tempat yang merupakan restoran, tetapi bukan kafe. Responsnya mencakup tempat yang cocok dengan setidaknya salah satu includedTypes dan tidak ada excludedTypes.

Jika ada jenis yang bertentangan, yaitu jenis yang muncul di includedTypes dan excludedTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditentukan dengan beberapa batasan jenis, hanya tempat yang memenuhi semua batasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan menyediakan layanan terkait "restoran", tetapi tidak beroperasi terutama sebagai "restoran".
includedPrimaryTypes[]

string

Menyertakan jenis Tempat utama (misalnya "restaurant" atau "gas_station") dari https://developers.google.com/maps/documentation/places/web-service/place-types. Tempat hanya dapat memiliki satu jenis utama dari tabel jenis yang didukung yang terkait dengannya.

Maksimal 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis utama yang bertentangan, yaitu jenis yang muncul di includedPrimaryTypes dan excludedPrimaryTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditentukan dengan beberapa batasan jenis, hanya tempat yang memenuhi semua batasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan menyediakan layanan terkait "restoran", tetapi tidak beroperasi terutama sebagai "restoran".
excludedPrimaryTypes[]

string

Jenis Tempat utama yang dikecualikan (misalnya "restaurant" atau "gas_station") dari https://developers.google.com/maps/documentation/places/web-service/place-types.

Maksimal 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis utama yang bertentangan, yaitu jenis yang muncul di includedPrimaryTypes dan excludedPrimaryTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditentukan dengan beberapa batasan jenis, hanya tempat yang memenuhi semua batasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan menyediakan layanan terkait "restoran", tetapi tidak beroperasi terutama sebagai "restoran".
maxResultCount

integer

Jumlah hasil maksimum yang akan ditampilkan. Nilainya harus antara 1 dan 20 (default), inklusif. Jika tidak ditetapkan, angka tersebut akan kembali ke batas atas. Jika angka ditetapkan ke negatif atau melebihi batas atas, error INVALID_ARGUMENT akan ditampilkan.
locationRestriction

object (LocationRestriction)

Wajib. Wilayah yang akan ditelusuri.
rankPreference

enum (RankPreference)

Cara hasil akan diberi peringkat dalam respons.
routingParameters

object (RoutingParameters)

Opsional. Parameter yang memengaruhi pemilihan rute ke hasil penelusuran.

Isi respons

Proto respons untuk Penelusuran di Sekitar.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
Kolom
places[]

object (Place)

Daftar tempat yang memenuhi persyaratan pengguna seperti jenis tempat, jumlah tempat, dan batasan lokasi tertentu.
routingSummaries[]

object (RoutingSummary)

Daftar ringkasan pemilihan rute dengan setiap entri dikaitkan ke tempat yang sesuai dalam indeks yang sama di kolom places. Jika ringkasan pemilihan rute tidak tersedia untuk salah satu tempat, ringkasan tersebut akan berisi entri kosong. Daftar ini harus memiliki entri sebanyak daftar tempat jika diminta.

LocationRestriction

Wilayah yang akan ditelusuri.

Representasi JSON 
{

  // Union field type can be only one of the following:
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Kolom

Kolom union type.

type hanya dapat berupa salah satu dari hal berikut:
circle

object (Circle)

Lingkaran yang ditentukan oleh titik tengah dan radius.

RankPreference

Cara hasil akan diberi peringkat dalam respons.

Enum
RANK_PREFERENCE_UNSPECIFIED Nilai RankPreference tidak ditetapkan. Secara default, akan menggunakan peringkat berdasarkan POPULARITAS.
DISTANCE Mengurutkan hasil menurut jarak.
POPULARITY Memberi peringkat hasil berdasarkan popularitas.