Method: places.searchText

Kueri teks berdasarkan penelusuran tempat.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
Kolom
textQuery

string

Wajib. Kueri teks untuk penelusuran tekstual.

languageCode

string

Detail tempat akan ditampilkan dalam bahasa pilihan jika tersedia. Jika kode bahasa tidak ditentukan atau tidak dikenal, detail tempat untuk bahasa apa pun dapat ditampilkan, dengan preferensi 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 lokasi permintaan berasal. 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 mengetahui 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.

rankPreference

enum (RankPreference)

Cara hasil akan diberi peringkat dalam respons.

includedType

string

Jenis tempat yang diminta. Daftar lengkap jenis yang didukung: https://developers.google.com/maps/documentation/places/web-service/place-types. Hanya mendukung satu jenis yang disertakan.

openNow

boolean

Digunakan untuk membatasi penelusuran ke tempat yang saat ini buka. Default-nya adalah salah.

minRating

number

Filter hasil yang rating pengguna rata-ratanya benar-benar kurang dari batas ini. Nilai yang valid harus berupa float antara 0 dan 5 (inklusif) pada ritme 0,5 yaitu [0, 0,5, 1,0, ... , 5,0] secara inklusif. Rating input akan dibulatkan ke 0,5(plafon) terdekat. Misalnya, peringkat 0,6 akan menghilangkan semua hasil dengan peringkat kurang dari 1,0.

maxResultCount

integer

Jumlah hasil maksimum yang akan ditampilkan. Nilainya harus antara 1 dan 20, secara inklusif. Nilai default-nya adalah 20. Jika tidak disetel, angka ini akan kembali ke batas atas. Jika angka ditetapkan ke negatif atau melebihi batas atas, error INVALID_ARGUMENT akan ditampilkan.

priceLevels[]

enum (PriceLevel)

Digunakan untuk membatasi penelusuran ke tempat yang ditandai sebagai tingkat harga tertentu. Pengguna dapat memilih kombinasi tingkat harga apa pun. Setelan default untuk memilih semua tingkat harga.

strictTypeFiltering

boolean

Digunakan untuk menetapkan pemfilteran jenis yang ketat untuk includeType. Jika disetel ke benar (true), hanya hasil dari jenis yang sama yang akan ditampilkan. Nilai defaultnya adalah false (salah).

locationBias

object (LocationBias)

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai bias yang berarti hasil di sekitar lokasi yang diberikan mungkin akan ditampilkan. Tidak dapat ditetapkan bersama locationRestriction.

locationRestriction

object (LocationRestriction)

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai pembatasan yang berarti hasil di luar lokasi yang ditentukan tidak akan ditampilkan. Tidak dapat ditetapkan bersama dengan locationBias.

evOptions

object (EVOptions)

Opsional. Menyetel opsi kendaraan listrik yang dapat ditelusuri dari permintaan penelusuran tempat.

Isi respons

Proto respons untuk places.searchText.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (Place)

Daftar tempat yang memenuhi kriteria penelusuran teks pengguna.

RankPreference

Cara hasil akan diberi peringkat dalam respons.

Enum
RANK_PREFERENCE_UNSPECIFIED Untuk kueri kategori seperti "Restoran di Bandung", RELEVANCE adalah setelan default. Untuk kueri non-kategori seperti "Jakarta, CA", sebaiknya Anda tidak menetapkan RankPreference.
DISTANCE Menentukan peringkat hasil menurut jarak.
RELEVANCE Memberi peringkat hasil menurut relevansi. Urutan penyortiran yang ditentukan oleh tumpukan peringkat normal.

LocationBias

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai bias yang berarti hasil di sekitar lokasi yang diberikan mungkin akan ditampilkan.

Representasi JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "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:

rectangle

object (Viewport)

Kotak persegi panjang yang ditentukan oleh sudut timur laut dan barat daya. rectangle.high() harus merupakan titik timur laut area pandang persegi panjang. rectangle.low() harus merupakan titik barat daya area pandang persegi panjang. rectangle.low().latitude() tidak boleh lebih dari rectangle.high().latitude(). Ini akan menghasilkan rentang lintang yang kosong. Area pandang persegi panjang tidak boleh lebih dari 180 derajat.

circle

object (Circle)

Lingkaran yang ditentukan oleh titik tengah dan radius.

LocationRestriction

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai pembatasan yang berarti hasil di luar lokasi yang ditentukan tidak akan ditampilkan.

Representasi JSON
{

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

Kolom union type.

type hanya dapat berupa salah satu dari yang berikut:

rectangle

object (Viewport)

Kotak persegi panjang yang ditentukan oleh sudut timur laut dan barat daya. rectangle.high() harus merupakan titik timur laut area pandang persegi panjang. rectangle.low() harus merupakan titik barat daya area pandang persegi panjang. rectangle.low().latitude() tidak boleh lebih dari rectangle.high().latitude(). Ini akan menghasilkan rentang lintang yang kosong. Area pandang persegi panjang tidak boleh lebih dari 180 derajat.

EVOptions

Opsi kendaraan listrik yang dapat ditelusuri dari permintaan penelusuran tempat.

Representasi JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Kolom
minimumChargingRateKw

number

Opsional. Kecepatan pengisian daya minimum yang diperlukan dalam kilowatt. Tempat dengan tarif pengisian daya kurang dari tarif yang ditentukan akan difilter.

connectorTypes[]

enum (EVConnectorType)

Opsional. Daftar jenis konektor EV yang diinginkan. Tempat yang tidak mendukung salah satu jenis konektor yang tercantum akan difilter.