- Permintaan HTTP
- Isi permintaan
- Isi respons
- LocationBias
- LocationRestriction
- Saran
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Menampilkan prediksi untuk input yang diberikan.
Permintaan HTTP
POST https://places.googleapis.com/v1/places:autocomplete
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "input": string, "locationBias": { object ( |
Kolom | |
---|---|
input |
Wajib. String teks yang digunakan untuk menelusuri. |
locationBias |
Opsional. Membiaskan hasil ke lokasi yang ditentukan. Maksimal satu dari |
locationRestriction |
Opsional. Membatasi hasil ke lokasi yang ditentukan. Maksimal satu dari |
includedPrimaryTypes[] |
Opsional. Jenis Tempat utama yang disertakan (misalnya, "restaurant" atau "gas_station") dari https://developers.google.com/maps/documentation/places/web-service/place-types. Tempat hanya ditampilkan jika jenis utamanya disertakan dalam daftar ini. Anda dapat menentukan hingga 5 nilai. Jika tidak ada jenis yang ditentukan, semua jenis Tempat akan ditampilkan. |
includedRegionCodes[] |
Opsional. Hanya sertakan hasil di wilayah yang ditentukan, yang ditetapkan sebagai maksimum 15 kode wilayah dua karakter CLDR. Set kosong tidak akan membatasi hasil. Jika |
languageCode |
Opsional. Bahasa yang akan digunakan untuk menampilkan hasil. Default-nya adalah en-US. Hasilnya mungkin dalam bahasa campuran jika bahasa yang digunakan dalam |
regionCode |
Opsional. Kode wilayah, ditetapkan sebagai kode wilayah dua karakter CLDR. Hal ini mempengaruhi pemformatan alamat, peringkat hasil, dan dapat mempengaruhi hasil yang dimunculkan. Tindakan ini tidak membatasi hasil pada wilayah yang ditentukan. Untuk membatasi hasil ke suatu wilayah, gunakan |
origin |
Opsional. Titik asal untuk menghitung jarak geodesi ke tujuan (ditampilkan sebagai |
inputOffset |
Opsional. Offset karakter Unicode berbasis nol dari Jika kosong, panjang defaultnya adalah |
includeQueryPredictions |
Opsional. Jika benar, respons akan menyertakan prediksi Tempat dan kueri. Jika tidak, respons hanya akan menampilkan prediksi Tempat. |
sessionToken |
Opsional. String yang mengidentifikasi sesi Autocomplete untuk tujuan penagihan. Harus berupa string base64 yang aman untuk URL dan nama file, dengan panjang maksimal 36 karakter ASCII. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. Sesi dimulai saat pengguna mulai mengetik kueri, dan berakhir saat mereka memilih tempat, lalu panggilan ke Place Details atau Validasi Alamat dilakukan. Setiap sesi dapat memiliki beberapa kueri, diikuti dengan satu permintaan Place Details atau Validasi Alamat. Kredensial yang digunakan untuk setiap permintaan dalam suatu sesi harus berasal dari project Konsol Google Cloud yang sama. Setelah sesi selesai, token tidak lagi valid; aplikasi Anda harus membuat token baru untuk setiap sesi. Jika parameter Sebaiknya ikuti panduan berikut:
|
Isi respons
Proto respons untuk places.Autocomplete.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"suggestions": [
{
object ( |
Kolom | |
---|---|
suggestions[] |
Berisi daftar saran, yang diurutkan dalam urutan relevansi menurun. |
LocationBias
Wilayah yang akan ditelusuri. Hasilnya mungkin bias di sekitar wilayah yang ditentukan.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
rectangle |
Area pandang yang ditentukan oleh sudut timur laut dan barat daya. |
circle |
Lingkaran yang ditentukan oleh titik tengah dan radius. |
LocationRestriction
Wilayah yang akan ditelusuri. Hasil akan dibatasi pada wilayah yang ditentukan.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
rectangle |
Area pandang yang ditentukan oleh sudut timur laut dan barat daya. |
circle |
Lingkaran yang ditentukan oleh titik tengah dan radius. |
Saran
Hasil saran Autocomplete.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
placePrediction |
Prediksi untuk Tempat. |
queryPrediction |
Prediksi untuk kueri. |
PlacePrediction
Hasil prediksi untuk prediksi Place Autocomplete.
Representasi JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Kolom | |
---|---|
place |
Nama resource Tempat yang disarankan. Nama ini dapat digunakan dalam API lain yang menerima nama Tempat. |
placeId |
ID unik untuk Tempat yang disarankan. ID ini dapat digunakan di API lain yang menerima ID Tempat. |
text |
Berisi nama yang dapat dibaca manusia untuk hasil yang ditampilkan. Untuk hasil tempat usaha, biasanya berupa nama dan alamat bisnis.
Teks ini mungkin berbeda dengan Mungkin dalam bahasa campuran jika permintaan |
structuredFormat |
Perincian prediksi Tempat menjadi teks utama yang berisi nama Tempat dan teks sekunder berisi fitur tambahan yang membedakan (seperti kota atau wilayah).
|
types[] |
Daftar jenis yang berlaku untuk Tempat ini dari Tabel A atau Tabel B di https://developers.google.com/maps/documentation/places/web-service/place-types. Jenis adalah kategorisasi Tempat. Tempat dengan jenis bersama akan memiliki karakteristik yang serupa. |
distanceMeters |
Panjang geodesi dalam meter dari |
FormattableText
Teks yang mewakili prediksi Tempat atau kueri. Teks dapat digunakan sebagaimana adanya atau diformat.
Representasi JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Kolom | |
---|---|
text |
Teks yang dapat digunakan sebagaimana adanya atau diformat dengan |
matches[] |
Daftar rentang string yang mengidentifikasi tempat permintaan input cocok di Nilai ini adalah offset karakter Unicode dari |
StringRange
Mengidentifikasi substring dalam teks tertentu.
Representasi JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Kolom | |
---|---|
startOffset |
Offset berbasis nol dari karakter Unicode pertama string (inklusif). |
endOffset |
Offset berbasis nol dari karakter Unicode terakhir (eksklusif). |
StructuredFormat
Berisi perincian prediksi Tempat atau kueri menjadi teks utama dan teks sekunder.
Untuk prediksi Tempat, teks utamanya berisi nama spesifik Tempat. Untuk prediksi kueri, teks utama berisi kueri.
Teks sekunder berisi fitur tambahan yang membedakan (seperti kota atau wilayah) untuk mengidentifikasi Tempat lebih lanjut atau menyaring kueri.
Representasi JSON |
---|
{ "mainText": { object ( |
Kolom | |
---|---|
mainText |
Menunjukkan nama Tempat atau kueri. |
secondaryText |
Mewakili fitur tambahan yang memperjelas (seperti kota atau wilayah) untuk mengidentifikasi Tempat lebih lanjut atau menyaring kueri. |
QueryPrediction
Hasil prediksi untuk prediksi Query Autocomplete.
Representasi JSON |
---|
{ "text": { object ( |
Kolom | |
---|---|
text |
Teks yang diprediksi. Teks ini tidak merepresentasikan Tempat, melainkan kueri teks yang dapat digunakan di endpoint penelusuran (misalnya, Text Search).
Mungkin dalam bahasa campuran jika permintaan |
structuredFormat |
Perincian prediksi kueri menjadi teks utama yang berisi kueri dan teks sekunder yang berisi fitur tambahan yang membedakannya (seperti kota atau wilayah).
|