Method: places.searchNearby

Telusuri 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)
}
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 ada detail tersebut.

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

regionCode

string

Kode negara/wilayah (CLDR) Unicode tempat permintaan berasal. 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.

Hingga 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis yang bertentangan, yaitu jenis muncul di includeTypes dan excludedTypes, error INVALID_ tambahkan akan ditampilkan.

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

excludedTypes[]

string

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

Hingga 50 jenis dari Tabel A dapat ditentukan.

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

Jika ada jenis yang bertentangan, yaitu jenis muncul di includeTypes dan excludedTypes, error INVALID_ tambahkan akan ditampilkan.

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

includedPrimaryTypes[]

string

Jenis Tempat utama yang disertakan (misalnya "restoran" 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.

Hingga 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis utama yang bertentangan, yaitu jenis muncul di includePrimaryTypes dan excludedPrimaryTypes, error INVALID_ ARGUMENT akan ditampilkan.

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

excludedPrimaryTypes[]

string

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

Hingga 50 jenis dari Tabel A dapat ditentukan.

Jika ada jenis utama yang bertentangan, yaitu jenis muncul di includePrimaryTypes dan excludedPrimaryTypes, error INVALID_ ARGUMENT akan ditampilkan.

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

maxResultCount

integer

Jumlah hasil maksimum yang akan ditampilkan. Nilainya harus antara 1 dan 20 (default), secara inklusif. Jika tidak disetel, jumlah ini akan kembali ke batas atas. Jika angka ditetapkan ke negatif atau melebihi batas atas, error INVALID_FILENAME akan ditampilkan.

locationRestriction

object (LocationRestriction)

Wajib. Wilayah yang akan ditelusuri.

rankPreference

enum (RankPreference)

Cara peringkat hasil akan ditentukan dalam respons.

Isi respons

Proto respons untuk Search Nearby.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Place)

Daftar tempat yang memenuhi persyaratan pengguna seperti jenis tempat, jumlah tempat, dan pembatasan lokasi tertentu.

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 berikut:

circle

object (Circle)

Lingkaran yang ditentukan oleh titik tengah dan radius.

RankPreference

Cara peringkat hasil akan ditentukan dalam respons.

Enum
RANK_PREFERENCE_UNSPECIFIED Nilai RankPreference belum ditetapkan. Akan menggunakan peringkat berdasarkan POPULARITAS secara default.
DISTANCE Memberi peringkat hasil menurut jarak.
POPULARITY Memberi peringkat pada hasil berdasarkan popularitas.