Method: places.searchText

Penelusuran tempat berdasarkan kueri teks.

Permintaan HTTP

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

URL ini 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)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean,
  "includeFutureOpeningBusinesses": boolean
}
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 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.
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

Memfilter hasil yang rating pengguna rata-ratanya kurang dari batas ini. Nilai yang valid harus berupa float antara 0 dan 5 (inklusif) pada irama 0,5, yaitu [0, 0,5, 1,0, ... , 5,0] secara inklusif. Rating input akan dibulatkan ke atas ke 0,5 terdekat(pembulatan ke atas). Misalnya, rating 0,6 akan menghilangkan semua hasil dengan rating kurang dari 1,0.
maxResultCount
(deprecated)

integer

Tidak digunakan lagi: Gunakan pageSize sebagai gantinya.

Jumlah maksimum hasil per halaman yang dapat ditampilkan. Jika jumlah hasil yang tersedia lebih besar dari maxResultCount, nextPageToken akan ditampilkan dan dapat diteruskan ke pageToken untuk mendapatkan halaman hasil berikutnya dalam permintaan selanjutnya. 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 maksimum hasil per halaman yang dapat ditampilkan. Jika jumlah hasil yang tersedia lebih besar dari pageSize, nextPageToken akan ditampilkan dan dapat diteruskan ke pageToken untuk mendapatkan halaman hasil berikutnya dalam permintaan selanjutnya. 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, yang diterima dari panggilan TextSearch sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter selain pageToken, pageSize, dan maxResultCount yang diberikan ke TextSearch harus sesuai 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. Default untuk memilih semua tingkat harga.
strictTypeFiltering

boolean

Digunakan untuk menyetel pemfilteran jenis ketat untuk includedType. Jika disetel ke benar (true), hanya hasil dengan jenis yang sama yang akan ditampilkan. Defaultnya adalah salah (false).
locationBias

object (LocationBias)

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai bias yang berarti hasil di sekitar lokasi tertentu dapat ditampilkan. Tidak dapat disetel bersama dengan locationRestriction.
locationRestriction

object (LocationRestriction)

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai batasan yang berarti hasil di luar lokasi yang diberikan tidak akan ditampilkan. Tidak dapat disetel bersama dengan locationBias.
evOptions

object (EVOptions)

Opsional. Menetapkan opsi EV yang dapat ditelusuri dari permintaan penelusuran tempat.
routingParameters

object (RoutingParameters)

Opsional. Parameter tambahan untuk merutekan ke hasil.
searchAlongRouteParameters

object (SearchAlongRouteParameters)

Opsional. Proto parameter tambahan untuk menelusuri sepanjang rute.
includePureServiceAreaBusinesses

boolean

Opsional. Sertakan bisnis jasa sistem panggilan murni jika kolom ditetapkan ke benar (true). Bisnis jasa sistem panggilan murni adalah bisnis yang melakukan kunjungan atau pengiriman ke pelanggan secara langsung, tetapi tidak melayani pelanggan di alamat bisnisnya. Misalnya, bisnis seperti layanan kebersihan atau tukang leding. Bisnis tersebut tidak memiliki alamat atau lokasi fisik di Google Maps. Places tidak akan menampilkan kolom termasuk location, plusCode, dan kolom terkait lokasi lainnya untuk bisnis ini.
includeFutureOpeningBusinesses

boolean

Opsional. Jika benar, sertakan bisnis yang belum buka, tetapi akan buka di masa mendatang.

Isi respons

Proto respons untuk places.searchText.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Kolom
places[]

object (Place)

Daftar tempat yang memenuhi kriteria penelusuran teks pengguna.
routingSummaries[]

object (RoutingSummary)

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

object (ContextualContent)

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

Daftar konten kontekstual dengan setiap entri dikaitkan dengan tempat yang sesuai dalam indeks yang sama di kolom tempat. Konten yang relevan dengan textQuery dalam permintaan lebih disukai. Jika konten kontekstual tidak tersedia untuk salah satu tempat, konten non-kontekstual akan ditampilkan. Kolom ini akan kosong hanya jika konten tidak tersedia untuk tempat ini. Daftar ini akan 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 ada halaman selanjutnya.
searchUri

string

Link memungkinkan pengguna menelusuri dengan kueri teks yang sama seperti yang ditentukan dalam permintaan di Google Maps.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

RankPreference

Cara hasil akan diberi peringkat dalam respons.

Enum
RANK_PREFERENCE_UNSPECIFIED Untuk kueri kategori seperti "Restoran di Jakarta", RELEVANSI adalah defaultnya. Untuk kueri non-kategoris seperti "Mountain View, CA", sebaiknya Anda membiarkan rankPreference tidak ditetapkan.
DISTANCE Memeringkat hasil menurut jarak.
RELEVANCE Memberi peringkat hasil berdasarkan relevansi. Urutan pengurutan ditentukan oleh tumpukan peringkat normal.

LocationBias

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai bias yang berarti hasil di sekitar lokasi tertentu dapat 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 hal berikut:
rectangle

object (Viewport)

Kotak persegi panjang yang ditentukan oleh sudut timur laut dan barat daya. rectangle.high() harus berupa titik timur laut dari area tampilan persegi panjang. rectangle.low() harus berupa titik barat daya area tampilan persegi panjang. rectangle.low().latitude() tidak boleh lebih besar dari rectangle.high().latitude(). Hal ini akan menghasilkan rentang lintang yang kosong. Area pandang persegi panjang tidak boleh lebih lebar dari 180 derajat.
circle

object (Circle)

Lingkaran yang ditentukan oleh titik tengah dan radius.

LocationRestriction

Wilayah yang akan ditelusuri. Lokasi ini berfungsi sebagai batasan yang berarti hasil di luar lokasi yang diberikan 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 hal berikut:
rectangle

object (Viewport)

Kotak persegi panjang yang ditentukan oleh sudut timur laut dan barat daya. rectangle.high() harus berupa titik timur laut dari area tampilan persegi panjang. rectangle.low() harus berupa titik barat daya area tampilan persegi panjang. rectangle.low().latitude() tidak boleh lebih besar dari rectangle.high().latitude(). Hal ini akan menghasilkan rentang lintang yang kosong. Area pandang persegi panjang tidak boleh lebih lebar 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 kecepatan pengisian daya yang lebih rendah dari kecepatan yang ditentukan akan difilter.
connectorTypes[]

enum (EVConnectorType)

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

SearchAlongRouteParameters

Menentukan polyline yang telah dihitung sebelumnya dari Routes API yang menentukan rute yang akan dicari. Menelusuri di sepanjang rute serupa dengan menggunakan opsi permintaan locationBias atau locationRestriction untuk memengaruhi hasil penelusuran. Namun, meskipun opsi locationBias dan locationRestriction memungkinkan Anda menentukan wilayah untuk memengaruhi hasil penelusuran, opsi ini memungkinkan Anda memengaruhi hasil di sepanjang rute perjalanan.

Hasil tidak dijamin berada di sepanjang rute yang diberikan, tetapi diberi peringkat dalam area penelusuran yang ditentukan oleh polyline dan, secara opsional, oleh locationBias atau locationRestriction berdasarkan waktu pengalihan minimal dari asal ke tujuan. Hasilnya mungkin berada di sepanjang rute alternatif, terutama jika polyline yang diberikan tidak menentukan rute optimal dari asal ke tujuan.

Representasi JSON 
{
  "polyline": {
    object (Polyline)
  }
}
Kolom
polyline

object (Polyline)

Wajib. Polyline rute.

Polyline

Polyline rute. Hanya mendukung polyline yang dienkode, yang dapat diteruskan sebagai string dan mencakup kompresi dengan kehilangan minimal. Ini adalah output default Routes API.

Representasi JSON 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Kolom
Kolom union polyline_type. Mencakup jenis polyline. Output Routes API secara default adalah encoded_polyline. polyline_type hanya dapat berupa salah satu dari hal berikut:
encodedPolyline

string

Polyline yang dienkode, seperti yang ditampilkan oleh Routes API secara default. Lihat alat encoder dan decoder.

ContextualContent

Eksperimental: Lihat https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative untuk mengetahui 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, kontekstual dengan kueri tempat.
photos[]

object (Photo)

Informasi (termasuk referensi) tentang foto tempat ini, yang kontekstual dengan kueri tempat.
justifications[]

object (Justification)

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

Justifikasi untuk tempat tersebut.

Pembenaran

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

Justifikasi untuk tempat tersebut. Justifikasi menjawab pertanyaan 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 hal berikut:
reviewJustification

object (ReviewJustification)

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

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

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

Justifikasi ulasan pengguna. Bagian ini menyoroti bagian ulasan pengguna yang akan menarik minat pengguna akhir. Misalnya, jika kueri penelusuran adalah "pizza kayu bakar", pembenaran ulasan akan menandai teks yang relevan dengan kueri penelusuran.

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

object (HighlightedText)
review

object (Review)

Ulasan yang menjadi asal teks yang ditandai.

HighlightedText

Teks yang ditandai oleh justifikasi. Ini adalah subset dari ulasan itu sendiri. Kata persis yang akan ditandai ditandai oleh 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 mengetahui detail selengkapnya. Justifikasi BusinessAvailabilityAttributes. Bagian ini menampilkan beberapa atribut yang dimiliki bisnis yang dapat menarik minat pengguna akhir.

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

boolean

Jika tempat menyediakan opsi bawa pulang.
delivery

boolean

Jika tempat menyediakan layanan pesan antar.
dineIn

boolean

Jika tempat menyediakan layanan makan di tempat.