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,
  "pageSize": integer,
  "pageToken": string,
  "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
(deprecated)

integer

Tidak digunakan lagi: Sebagai gantinya, gunakan pageSize.

Jumlah hasil maksimum per halaman yang dapat ditampilkan. Jika jumlah hasil yang tersedia lebih besar dari maxResultCount, nextPageToken akan ditampilkan yang dapat diteruskan ke pageToken untuk mendapatkan halaman hasil berikutnya dalam permintaan berikutnya. Jika 0 atau tidak ada nilai yang diberikan, nilai default 20 akan digunakan. Nilai maksimum adalah 20; nilai di atas 20 akan dikonversi menjadi 20. Nilai negatif akan menampilkan error INVALID_ARGUMENT.

Jika maxResultCount dan pageSize ditentukan, maxResultCount akan diabaikan.

pageSize

integer

Opsional. Jumlah hasil maksimum per halaman yang dapat ditampilkan. Jika jumlah hasil yang tersedia lebih besar dari pageSize, nextPageToken akan ditampilkan yang dapat diteruskan ke pageToken untuk mendapatkan halaman hasil berikutnya dalam permintaan berikutnya. Jika 0 atau tidak ada nilai yang diberikan, nilai default 20 akan digunakan. Nilai maksimum adalah 20; nilai di atas 20 akan ditetapkan ke 20. Nilai negatif akan menampilkan error INVALID_ARGUMENT.

Jika maxResultCount dan pageSize ditentukan, maxResultCount akan diabaikan.

pageToken

string

Opsional. Token halaman, diterima dari panggilan TextSearch sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter selain pageToken, pageSize, dan maxResultCount yang diberikan ke TextSearch harus cocok dengan panggilan awal yang menyediakan token halaman. Jika tidak, 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)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Kolom
places[]

object (Place)

Daftar tempat yang memenuhi kriteria penelusuran teks pengguna.

contextualContents[]

object (ContextualContent)

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

Daftar konten kontekstual dengan setiap entri terkait dengan tempat yang sesuai dalam indeks yang sama di kolom tempat. Konten yang relevan dengan textQuery dalam permintaan lebih disarankan. Jika konten kontekstual tidak tersedia untuk salah satu tempat, konten non-kontekstual akan ditampilkan. Kolom ini hanya akan kosong jika konten tidak tersedia untuk tempat ini. Daftar ini harus memiliki entri sebanyak daftar tempat jika diminta.

nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan atau kosong, maka tidak akan ada halaman berikutnya.

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.

ContextualContent

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

Konten yang kontekstual dengan kueri tempat.

Representasi JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Kolom
reviews[]

object (Review)

Daftar ulasan tentang tempat ini, berlanjut dengan kueri tempat.

photos[]

object (Photo)

Informasi (termasuk referensi) tentang foto tempat ini, beserta kueri tempat.

justifications[]

object (Justification)

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

Justifikasi untuk tempat.

Pembenaran

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

Justifikasi untuk tempat. Justifikasi menjawab pertanyaan tentang mengapa suatu tempat dapat menarik minat pengguna akhir.

Representasi JSON
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Kolom

Kolom union justification.

justification hanya dapat berupa salah satu dari yang berikut:

reviewJustification

object (ReviewJustification)

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

ReviewJustification

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya.

Justifikasi peninjauan pengguna. Fitur ini menyoroti bagian ulasan pengguna yang akan menarik minat pengguna akhir. Misalnya, jika kueri penelusuran adalah "firewood pizza", justifikasi peninjauan akan menandai teks yang relevan dengan kueri penelusuran tersebut.

Representasi JSON
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Kolom
highlightedText

object (HighlightedText)

review

object (Review)

Ulasan yang menghasilkan teks yang ditandai.

HighlightedText

Teks yang ditandai dengan justifikasi. Ini adalah bagian dari ulasan itu sendiri. Kata persis yang perlu ditandai ditandai dengan HighlightedTextRange. Mungkin ada beberapa kata dalam teks yang ditandai.

Representasi JSON
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Kolom
text

string

highlightedTextRanges[]

object (HighlightedTextRange)

Daftar rentang teks yang ditandai.

HighlightedTextRange

Rentang teks yang ditandai.

Representasi JSON
{
  "startIndex": integer,
  "endIndex": integer
}
Kolom
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk detail selengkapnya. Justifikasi BusinessAvailabilityAttributes. Diagram ini menunjukkan beberapa atribut yang dimiliki bisnis yang dapat menarik minat pengguna akhir.

Representasi JSON
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Kolom
takeout

boolean

Apakah ada tempat yang menyediakan layanan bawa pulang.

delivery

boolean

Apakah tempat yang menyediakan layanan pesan antar.

dineIn

boolean

Apakah tempat menyediakan layanan makan di tempat.