Method: query.search

API kueri Cloud Search menyediakan metode penelusuran, yang menampilkan hasil yang paling relevan dari kueri pengguna. Hasilnya dapat berasal dari aplikasi Google Workspace, seperti Gmail atau Google Drive, atau dapat berasal dari data yang telah Anda indeks dari pihak ketiga.

Catatan: API ini memerlukan akun pengguna akhir standar untuk dieksekusi. Akun layanan tidak dapat menjalankan permintaan API kueri secara langsung; untuk menggunakan akun layanan guna menjalankan kueri, siapkan delegasi otorisasi seluruh domain Google Workspace.

Permintaan HTTP

POST https://cloudsearch.googleapis.com/v1/query/search

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Kolom
requestOptions

object (RequestOptions)

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

string

String kueri mentah. Lihat operator penelusuran yang didukung di Mempersempit penelusuran dengan operator
pageSize

integer

Jumlah maksimum hasil penelusuran yang akan ditampilkan di satu halaman. Nilai yang valid adalah antara 1 dan 100, inklusif. Nilai defaultnya adalah 10. Nilai minimum adalah 50 jika hasil di luar 2.000 diminta.
start

integer

Indeks awal hasil.
dataSourceRestrictions[]

object (DataSourceRestriction)

Sumber yang akan digunakan untuk membuat kueri. Jika tidak ditentukan, semua sumber data dari aplikasi penelusuran saat ini akan digunakan.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Opsi untuk mengurutkan hasil penelusuran
queryInterpretationOptions

object (QueryInterpretationOptions)

opsi untuk menafsirkan kueri pengguna.
contextAttributes[]

object (ContextAttribute)

Atribut konteks untuk permintaan yang akan digunakan untuk menyesuaikan peringkat hasil penelusuran. Jumlah maksimum elemen adalah 10.

Isi respons

Jika berhasil, isi respons memuat instance SearchResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.