Method: query.suggest

Memberikan saran untuk melengkapi kueri secara otomatis.

Catatan: API ini membutuhkan akun pengguna akhir standar untuk dieksekusi. Akun layanan tidak dapat menjalankan permintaan Query API secara langsung; agar dapat menggunakan akun layanan untuk menjalankan kueri, siapkan delegasi 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 saran pelengkapan otomatis akan ditampilkan. Misalnya, jika kueri adalah "sea", server mungkin menampilkan "season", "search", "seagull", dan seterusnya.

dataSourceRestrictions[]

object (DataSourceRestriction)

Sumber yang akan digunakan untuk saran. Jika tidak ditentukan, sumber data diambil dari aplikasi penelusuran saat ini.

CATATAN: Saran hanya didukung untuk sumber berikut:

  • Sumber data pihak ketiga
  • StandarSource.PERSON
  • dibatasiSumber.GOOGLE_DRIVE

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons API yang disarankan.

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 Ringkasan OAuth 2.0.

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

source

object (Source)

Sumber saran.

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

object (QuerySuggestion)

Kolom ini akan muncul jika kueri yang disarankan adalah penyelesaian kata/frasa.

peopleSuggestion

object (PeopleSuggestion)

Ini ada saat saran menunjukkan seseorang. Daftar ini berisi lebih banyak informasi tentang orang tersebut - seperti ID email, nama, dll.

SaranSaran

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

SaranOrang

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.