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)
}
Kolom
languageCode

string

Detail tempat akan ditampilkan dengan bahasa pilihan jika tersedia. Jika kode bahasa tidak ditentukan atau tidak dikenal, detail tempat dari bahasa apa pun mungkin ditampilkan, dengan preferensi 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) untuk lokasi asal permintaan. Parameter ini digunakan untuk menampilkan detail tempat, seperti nama tempat spesifik per 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 suatu jenis muncul di includeTypes dan excludedTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditetapkan dengan beberapa pembatasan jenis, hanya tempat yang memenuhi semua pembatasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan akan menampilkan "restaurant" layanan terkait 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 includeTypes (misalnya restoran) dan excludedTypes (misalnya kafe), maka respons harus mencakup tempat yang merupakan restoran, tetapi bukan kafe. Respons akan menyertakan tempat yang cocok dengan setidaknya salah satu jenis includeType dan tidak satu pun excludedType.

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

Jika jenis Tempat ditetapkan dengan beberapa pembatasan jenis, hanya tempat yang memenuhi semua pembatasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan akan menampilkan "restaurant" layanan terkait 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 suatu jenis muncul di includePrimaryTypes dan excludedPrimaryTypes, error INVALID_ARGUMENT akan ditampilkan.

Jika jenis Tempat ditetapkan dengan beberapa pembatasan jenis, hanya tempat yang memenuhi semua pembatasan yang akan ditampilkan. Misalnya, jika kita memiliki {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, tempat yang ditampilkan akan menampilkan "restaurant" layanan terkait 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 suatu jenis muncul di includePrimaryTypes dan excludedPrimaryTypes, error INVALID_ARGUMENT akan ditampilkan.

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

maxResultCount

integer

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

locationRestriction

object (LocationRestriction)

Wajib diisi. Wilayah yang akan ditelusuri.

rankPreference

enum (RankPreference)

Bagaimana hasil akan diberi peringkat 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 kebutuhan 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 yang berikut:

circle

object (Circle)

Lingkaran yang ditentukan berdasarkan titik tengah dan radius.

RankPreference

Bagaimana hasil akan diberi peringkat dalam respons.

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