Method: query.suggest

Memberikan saran untuk pelengkapan otomatis kueri.

Catatan: API ini memerlukan akun pengguna akhir standar agar dapat dijalankan. Akun layanan tidak dapat melakukan permintaan Query API secara langsung; agar dapat menggunakan akun layanan untuk menjalankan kueri, siapkan delegasi otoritas tingkat 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 (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Kolom
requestOptions

object (RequestOptions)

Opsi permintaan, seperti aplikasi penelusuran dan zona waktu pengguna.
query

string

Kueri sebagian yang akan menampilkan saran pelengkapan otomatis. Misalnya, jika kuerinya adalah "sea", server mungkin akan menampilkan "season", "search", "seagull" dan seterusnya.
dataSourceRestrictions[]

object (DataSourceRestriction)

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:

  • Sumber data pihak ketiga
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons API saran.

Representasi JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Kolom
suggestResults[]

object (SuggestResult)

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 (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
Kolom
suggestedQuery

string

Kueri yang disarankan yang akan digunakan untuk penelusuran, saat pengguna mengklik saran tersebut
source

object (Source)

Sumber saran.
Kolom union suggestion. Berisi metadata tambahan tentang kueri yang disarankan. Kode ini juga menunjukkan jenis kueri yang disarankan. Misalnya, jika PeopleSuggestion ada, hal ini menunjukkan bahwa suggested_query adalah saran orang. suggestion hanya dapat berupa salah satu dari berikut:
querySuggestion

object (QuerySuggestion)

Kolom ini akan ada jika kueri yang disarankan adalah pelengkapan kata/frasa.
peopleSuggestion

object (PeopleSuggestion)

Tombol ini ada jika saran menunjukkan seseorang. Kolom ini berisi informasi selengkapnya tentang orang tersebut - seperti ID email, nama, dll.

QuerySuggestion

Saat ini kolom ini tidak berisi apa pun dan hanya digunakan sebagai indikator bahwa hasil yang disarankan adalah pelengkapan frasa.

PeopleSuggestion

Kolom ini berisi informasi tentang orang yang disarankan.

Representasi JSON 
{
  "person": {
    object (Person)
  }
}
Kolom
person

object (Person)

Orang yang disarankan. Semua kolom objek orang mungkin tidak diisi.