- Permintaan HTTP
- Isi permintaan
- Isi respons
- Cakupan Otorisasi
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- Cobalah!
Memberikan saran untuk melengkapi kueri secara otomatis.
Catatan: API ini memerlukan akun pengguna akhir standar agar dapat dijalankan. Akun layanan tidak dapat melakukan permintaan Query API secara langsung. Untuk menggunakan akun layanan guna menjalankan kueri, siapkan delegasi otoritas seluruh domain Google Workspace.
Permintaan HTTP
POST https://cloudsearch.googleapis.com/v1/query/suggest
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "requestOptions": { object ( |
Kolom | |
---|---|
requestOptions |
Opsi permintaan, seperti aplikasi penelusuran dan zona waktu pengguna. |
query |
Kueri sebagian yang saran pelengkapan otomatisnya akan ditampilkan. Misalnya, jika kuerinya adalah "sea", maka server mungkin menampilkan "samu", "search", "seagull", dan seterusnya. |
dataSourceRestrictions[] |
Sumber yang akan digunakan untuk saran. Jika tidak ditentukan, sumber data akan diambil dari aplikasi penelusuran saat ini. CATATAN: Saran hanya didukung untuk sumber berikut:
|
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Respons API saran.
Representasi JSON |
---|
{
"suggestResults": [
{
object ( |
Kolom | |
---|---|
suggestResults[] |
Daftar saran. |
Cakupan Otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
Untuk informasi selengkapnya, lihat Panduan otorisasi.
SuggestResult
Satu hasil saran.
Representasi JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
Kolom | |
---|---|
suggestedQuery |
Kueri yang disarankan yang akan digunakan untuk penelusuran, saat pengguna mengklik saran tersebut |
source |
Sumber saran. |
Kolom union suggestion . Berisi metadata tambahan tentang kueri yang disarankan. Kolom ini juga menunjukkan jenis kueri yang disarankan. Misalnya, jika PeopleSuggestion ada, ini menunjukkan bahwa suggested_query adalah saran orang. suggestion hanya ada berupa salah satu diantara berikut: |
|
querySuggestion |
Kolom ini akan ada jika kueri yang disarankan adalah pelengkapan kata/frasa. |
peopleSuggestion |
Elemen ini muncul jika saran menunjukkan seseorang. File ini berisi informasi selengkapnya tentang orang tersebut - seperti ID email, nama, dll. |
QuerySuggestion
Untuk saat ini, kolom ini tidak berisi apa pun dan hanya digunakan sebagai indikator bahwa hasil saran adalah pelengkapan frasa.
PeopleSuggestion
Kolom ini berisi informasi tentang orang yang disarankan.
Representasi JSON |
---|
{
"person": {
object ( |
Kolom | |
---|---|
person |
Orang yang disarankan. Semua kolom objek orang mungkin tidak diisi. |