Method: query.search

Cloud Search Query API menyediakan metode penelusuran, yang menampilkan hasil 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 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/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 bagian Mempersempit penelusuran dengan operator
pageSize

integer

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

integer

Memulai indeks hasil.
dataSourceRestrictions[]

object (DataSourceRestriction)

Sumber yang akan digunakan untuk 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)

pilihan untuk menafsirkan kueri pengguna.
contextAttributes[]

object (ContextAttribute)

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

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons API penelusuran.

Representasi JSON 
{
  "queryInterpretation": {
    object (QueryInterpretation)
  },
  "results": [
    {
      object (SearchResult)
    }
  ],
  "structuredResults": [
    {
      object (StructuredResult)
    }
  ],
  "spellResults": [
    {
      object (SpellResult)
    }
  ],
  "facetResults": [
    {
      object (FacetResult)
    }
  ],
  "hasMoreResults": boolean,
  "debugInfo": {
    object (ResponseDebugInfo)
  },
  "errorInfo": {
    object (ErrorInfo)
  },
  "resultCounts": {
    object (ResultCounts)
  },

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
Kolom
queryInterpretation

object (QueryInterpretation)

Hasil interpretasi kueri untuk kueri pengguna. Kosong jika interpretasi kueri dinonaktifkan.
results[]

object (SearchResult)

Hasil dari kueri penelusuran.
structuredResults[]

object (StructuredResult)

Hasil terstruktur untuk kueri pengguna. Hasil ini tidak dihitung berdasarkan pageSize.
spellResults[]

object (SpellResult)

Ejaan yang disarankan untuk kueri.
facetResults[]

object (FacetResult)

Hasil faset berulang.
hasMoreResults

boolean

Apakah ada lebih banyak hasil penelusuran yang cocok dengan kueri.
debugInfo

object (ResponseDebugInfo)

Melakukan proses debug informasi tentang respons.
errorInfo

object (ErrorInfo)

Informasi error tentang respons.
resultCounts

object (ResultCounts)

Informasi jumlah hasil yang diperluas.

Kolom union result_count. Total jumlah hasil di semua sumber data yang diminta. Dihapus jika sumber yang telah ditentukan sebelumnya disertakan dalam kumpulan sumber data yang dikueri. Jumlah hasil mungkin ditampilkan sebagai perkiraan, bukan tepat, dalam keadaan berikut:

  • Jika kueri memiliki lebih dari 2 istilah dalam satu frasa, seperti "jumlah hasil persis" dalam tanda kutip.

  • Ketika jumlah ACL hasil penelusuran unik yang akan dievaluasi terlalu besar untuk dihitung dalam latensi yang wajar.

Dalam kasus yang jarang terjadi, jika sistem tidak dapat menelusuri semua dokumen, jalankan kembali kueri. result_count hanya dapat berupa salah satu dari yang berikut:
resultCountEstimate

string (int64 format)

Jumlah perkiraan hasil untuk kueri ini.
resultCountExact

string (int64 format)

Jumlah hasil yang tepat untuk kueri ini.

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.

QueryInterpretationOptions

opsi untuk menafsirkan kueri pengguna.

Representasi JSON 
{
  "disableNlInterpretation": boolean,
  "enableVerbatimMode": boolean,
  "disableSupplementalResults": boolean
}
Kolom
disableNlInterpretation

boolean

Tandai untuk menonaktifkan penafsiran bahasa alami (NL) atas kueri. Default-nya adalah false, Tetapkan ke true untuk menonaktifkan penafsiran natural language. Penafsiran NL hanya berlaku untuk sumber data yang telah ditentukan sebelumnya.
enableVerbatimMode

boolean

Aktifkan tanda ini untuk menonaktifkan semua pengoptimalan internal seperti penafsiran bahasa alami (NL) kueri, pengambilan hasil tambahan, dan penggunaan sinonim termasuk yang kustom. Penafsiran nl akan dinonaktifkan jika salah satu dari kedua tanda benar.
disableSupplementalResults

boolean

Gunakan penanda ini untuk menonaktifkan hasil tambahan untuk kueri. Setelan hasil tambahan yang dipilih di tingkat SearchApplication akan diutamakan jika disetel ke Benar (True).

QueryInterpretation

Representasi JSON 
{
  "interpretedQuery": string,
  "interpretationType": enum (QueryInterpretation.InterpretationType),
  "reason": enum (QueryInterpretation.Reason)
}
Kolom
interpretedQuery

string

Penafsiran kueri yang digunakan dalam penelusuran. Misalnya, kueri dengan intent bahasa alami seperti "email dari john" akan ditafsirkan sebagai "from:john source:mail". Kolom ini tidak akan diisi jika alasannya adalah NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
interpretationType

enum (QueryInterpretation.InterpretationType)
reason

enum (QueryInterpretation.Reason)

Alasan penafsiran kueri. Kolom ini tidak akan UNSPECIFIED jika jenis penafsirannya tidak NONE.

QueryInterpretation.InterpretationType

Enum
NONE Baik penafsiran natural language maupun versi kueri yang lebih luas tidak digunakan untuk mengambil hasil penelusuran.
BLEND Hasil dari kueri asli digabungkan dengan hasil lainnya. Alasan menggabungkan hasil lain ini dengan hasil dari kueri asli diisi dalam 'Alasan' di bawah ini.
REPLACE Hasil dari kueri asli diganti. Alasan untuk mengganti hasil dari kueri asli diisi dalam 'Alasan' di bawah ini.

QueryInterpretation.Reason

Enum
UNSPECIFIED
QUERY_HAS_NATURAL_LANGUAGE_INTENT Penafsiran natural language atas kueri digunakan untuk mengambil hasil penelusuran.
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY Kemiripan istilah dokumen dan kueri digunakan untuk memperluas kueri secara selektif guna mengambil hasil penelusuran tambahan karena tidak ada hasil yang cukup untuk kueri pengguna tersebut. Kueri yang ditafsirkan akan kosong untuk kasus ini.

SearchResult

Hasil berisi informasi yang diindeks untuk dokumen.

Representasi JSON 
{
  "title": string,
  "url": string,
  "snippet": {
    object (Snippet)
  },
  "metadata": {
    object (Metadata)
  },
  "clusteredResults": [
    {
      object (SearchResult)
    }
  ],
  "debugInfo": {
    object (ResultDebugInfo)
  }
}
Kolom
title

string

Judul hasil penelusuran.
url

string

URL hasil penelusuran. URL berisi pengalihan Google ke item yang sebenarnya. URL ini ditandatangani dan tidak boleh diubah.
snippet

object (Snippet)

Penyambungan semua cuplikan (ringkasan) yang tersedia untuk hasil ini.
metadata

object (Metadata)

{i>metadata<i} hasil penelusuran.
clusteredResults[]

object (SearchResult)

Jika sumber dikelompokkan, berikan daftar hasil yang dikelompokkan. Hanya akan ada satu tingkat hasil yang dikelompokkan. Jika sumber saat ini tidak diaktifkan untuk pengelompokan, kolom ini akan kosong.
debugInfo

object (ResultDebugInfo)

Proses debug informasi tentang hasil penelusuran ini.

Cuplikan

Cuplikan hasil penelusuran, yang meringkas konten dari halaman yang dihasilkan.

Representasi JSON 
{
  "snippet": string,
  "matchRanges": [
    {
      object (MatchRange)
    }
  ]
}
Kolom
snippet

string

Cuplikan dokumen. Cuplikan dokumen. Dapat berisi karakter HTML yang di-escape yang harus tidak di-escape sebelum rendering.
matchRanges[]

object (MatchRange)

Rentang yang cocok dalam cuplikan.

MatchRange

Rentang cuplikan yang cocok [awal, akhir).

Representasi JSON 
{
  "start": integer,
  "end": integer
}
Kolom
start

integer

Posisi awal pencocokan dalam cuplikan.
end

integer

Akhir kecocokan dalam cuplikan.

Metadata

metadata hasil penelusuran yang cocok.

Representasi JSON 
{
  "source": {
    object (Source)
  },
  "mimeType": string,
  "thumbnailUrl": string,
  "owner": {
    object (Person)
  },
  "createTime": string,
  "updateTime": string,
  "fields": [
    {
      object (NamedProperty)
    }
  ],
  "displayOptions": {
    object (ResultDisplayMetadata)
  },
  "objectType": string
}
Kolom
source

object (Source)

Sumber bernama untuk hasil, seperti Gmail.
mimeType

string

Jenis mime hasil penelusuran.
thumbnailUrl

string

URL thumbnail hasil.
owner

object (Person)

pemilik (biasanya pembuat) dokumen atau objek hasil penelusuran.
createTime

string (Timestamp format)

Waktu pembuatan dokumen atau objek ini dalam hasil penelusuran.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Tanggal terakhir diubah untuk objek dalam hasil penelusuran. Jika tidak ditetapkan dalam item, nilai yang ditampilkan di sini kosong. Jika updateTime digunakan untuk menghitung keaktualan dan tidak ditetapkan, nilai ini akan ditetapkan secara default ke 2 tahun dari waktu saat ini.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
fields[]

object (NamedProperty)

Kolom terindeks dalam data terstruktur, ditampilkan sebagai properti bernama generik.
displayOptions

object (ResultDisplayMetadata)

opsi yang menentukan cara menampilkan hasil penelusuran data terstruktur.
objectType

string

Jenis objek hasil penelusuran.

ResultDisplayMetadata

Representasi JSON 
{
  "objectTypeLabel": string,
  "metalines": [
    {
      object (ResultDisplayMetadata.ResultDisplayLine)
    }
  ]
}
Kolom
objectTypeLabel

string

Label tampilan untuk objek.
metalines[]

object (ResultDisplayMetadata.ResultDisplayLine)

Konten metaline yang akan ditampilkan bersama hasil.

ResultDisplayMetadata.ResultDisplayLine

Kumpulan kolom yang membentuk garis yang ditampilkan

Representasi JSON 
{
  "fields": [
    {
      object (ResultDisplayMetadata.ResultDisplayField)
    }
  ]
}
Kolom
fields[]

object (ResultDisplayMetadata.ResultDisplayField)

ResultDisplayMetadata.ResultDisplayField

Tampilkan Kolom untuk Hasil query.search

Representasi JSON 
{
  "label": string,
  "operatorName": string,
  "property": {
    object (NamedProperty)
  }
}
Kolom
label

string

Label tampilan untuk properti.
operatorName

string

Nama operator properti.
property

object (NamedProperty)

Pasangan nilai nama untuk properti.

ResultDebugInfo

Informasi proses debug tentang hasil.

Representasi JSON 
{
  "formattedDebugInfo": string
}
Kolom
formattedDebugInfo

string

Info debug umum diformat untuk ditampilkan.

StructuredResult

Hasil terstruktur yang ditampilkan sebagai bagian dari permintaan penelusuran.

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

object (Person)

Representasi seseorang

SpellResult

Representasi JSON 
{
  "suggestedQuery": string
}
Kolom
suggestedQuery

string

Saran ejaan kueri.

FacetResult

Respons faset spesifik sumber

Representasi JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ]
}
Kolom
sourceName

string

Nama sumber yang menampilkan hasil faset. Tidak akan kosong.
objectType

string

Jenis objek yang hasil faset-nya ditampilkan. Boleh kosong.
operatorName

string

Nama operator yang dipilih untuk facet. @lihat cloudsearch.SchemaPropertyOptions
buckets[]

object (FacetBucket)

FacetBuckets untuk nilai sebagai respons yang berisi setidaknya satu hasil dengan filter yang sesuai.

FacetBucket

Bucket dalam faset adalah unit dasar operasi. Bucket dapat terdiri dari nilai tunggal ATAU rentang nilai yang berdekatan, bergantung pada jenis kolom yang dikelompokkan. FacetBucket saat ini hanya digunakan untuk menampilkan objek respons.

Representasi JSON 
{
  "count": integer,
  "percentage": integer,
  "filter": {
    object (Filter)
  },
  "value": {
    object (Value)
  }
}
Kolom
count

integer

Jumlah hasil yang cocok dengan nilai bucket. Jumlah hanya ditampilkan untuk penelusuran jika akurasi penghitungan sudah dipastikan. Cloud Search tidak menjamin jumlah faset untuk setiap kueri dan jumlah faset mungkin hanya muncul sesekali, bahkan untuk kueri yang identik. Jangan membangun dependensi pada keberadaan jumlah faset; sebagai gantinya gunakan persentase ount {i>facet<i} yang selalu dikembalikan.
percentage

integer

Persentase hasil yang cocok dengan nilai bucket. Nilai yang ditampilkan antara (0-100], dan dibulatkan ke bawah menjadi bilangan bulat jika pecahan. Jika nilai tidak ditampilkan secara eksplisit, ini mewakili nilai persentase yang dibulatkan ke 0. Persentase ditampilkan untuk semua penelusuran, namun merupakan perkiraan. Karena persentase selalu ditampilkan, Anda harus merender persentase, bukan jumlah.
filter

object (Filter)

Filter yang akan diteruskan dalam permintaan penelusuran jika bucket yang sesuai dipilih.
value

object (Value)

ResponseDebugInfo

Melakukan proses debug informasi tentang respons.

Representasi JSON 
{
  "formattedDebugInfo": string
}
Kolom
formattedDebugInfo

string

Info debug umum diformat untuk ditampilkan.

ErrorInfo

Informasi error tentang respons.

Representasi JSON 
{
  "errorMessages": [
    {
      object (ErrorMessage)
    }
  ]
}
Kolom
errorMessages[]

object (ErrorMessage)

ErrorMessage

Pesan error per respons sumber.

Representasi JSON 
{
  "source": {
    object (Source)
  },
  "errorMessage": string
}
Kolom
source

object (Source)
errorMessage

string

ResultCounts

Informasi jumlah hasil

Representasi JSON 
{
  "sourceResultCounts": [
    {
      object (SourceResultCount)
    }
  ]
}
Kolom
sourceResultCounts[]

object (SourceResultCount)

Informasi jumlah hasil untuk setiap sumber dengan hasil.

SourceResultCount

Informasi jumlah hasil per sumber.

Representasi JSON 
{
  "source": {
    object (Source)
  },
  "hasMoreResults": boolean,

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
Kolom
source

object (Source)

Sumber yang dikaitkan dengan informasi jumlah hasil.
hasMoreResults

boolean

Apakah ada lebih banyak hasil penelusuran untuk sumber ini.

Kolom union result_count.

result_count hanya dapat berupa salah satu dari yang berikut:
resultCountEstimate

string (int64 format)

Estimasi jumlah hasil untuk sumber ini.
resultCountExact

string (int64 format)

Jumlah hasil persis untuk sumber ini.