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 untuk dieksekusi. Akun layanan tidak dapat melakukan permintaan API kueri secara langsung; untuk menggunakan akun layanan dalam melakukan kueri, siapkan delegasi otoritas seluruh domain Google Workspace.

Permintaan HTTP

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

URL ini 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 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 menginterpretasikan kueri pengguna.
contextAttributes[]

object (ContextAttribute)

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

Isi respons

Respons API penelusuran. ID BERIKUTNYA: 19

Jika berhasil, isi respons memuat data dengan struktur berikut:

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 terhadap pageSize.
spellResults[]

object (SpellResult)

Ejaan yang disarankan untuk kueri.
facetResults[]

object (FacetResult)

Hasil faset berulang.
hasMoreResults

boolean

Apakah ada hasil penelusuran lainnya yang cocok dengan kueri.
debugInfo

object (ResponseDebugInfo)

Informasi proses debug tentang respons.
errorInfo

object (ErrorInfo)

Informasi error tentang respons.
resultCounts

object (ResultCounts)

Informasi jumlah hasil yang diluaskan.

Kolom union result_count. Jumlah total hasil di semua sumber data yang diminta. Dihilangkan jika sumber yang telah ditentukan disertakan dalam kumpulan sumber data yang dikueri. Jumlah hasil mungkin ditampilkan sebagai estimasi, bukan jumlah yang tepat, dalam situasi berikut:

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

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

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

string (int64 format)

Perkiraan jumlah 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.

QueryInterpretationOptions

opsi untuk menginterpretasikan kueri pengguna.

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

boolean

Flag untuk menonaktifkan interpretasi bahasa alami (NL) kueri. Defaultnya adalah false. Setel ke true untuk menonaktifkan interpretasi bahasa alami. Interpretasi NL hanya berlaku untuk sumber data standar.
enableVerbatimMode

boolean

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

boolean

Gunakan tanda ini untuk menonaktifkan hasil tambahan untuk kueri. Setelan hasil tambahan yang dipilih di tingkat SearchApplication akan diprioritaskan jika disetel ke True.

QueryInterpretation

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

string

Interpretasi kueri yang digunakan dalam penelusuran. Misalnya, kueri dengan maksud bahasa alami seperti "email dari johan" akan ditafsirkan sebagai "from:johan 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 interpretasi kueri. Kolom ini tidak akan UNSPECIFIED jika jenis interpretasi bukan NONE.
interpretedQueryActualResultCount

integer

Jumlah sebenarnya hasil yang ditampilkan oleh kueri yang diinterpretasikan.
interpretedQueryEstimatedResultCount

string (int64 format)

Perkiraan jumlah hasil yang ditampilkan oleh kueri yang diinterpretasikan.

QueryInterpretation.InterpretationType

Enum
NONE Interpretasi bahasa alami, maupun versi kueri yang lebih luas tidak digunakan untuk mengambil hasil penelusuran.
BLEND Hasil dari kueri asli digabungkan dengan hasil lainnya. Alasan penggabungan hasil lain ini dengan hasil dari kueri asli diisi di kolom 'reason' di bawah.
REPLACE Hasil dari kueri asli diganti. Alasan penggantian hasil dari kueri asli diisi di kolom 'reason' di bawah.

QueryInterpretation.Reason

Enum
UNSPECIFIED
QUERY_HAS_NATURAL_LANGUAGE_INTENT Interpretasi bahasa alami dari kueri digunakan untuk mengambil hasil penelusuran.
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY Kemiripan istilah kueri dan dokumen digunakan untuk memperluas kueri secara selektif guna mengambil hasil penelusuran tambahan karena hasil yang cukup tidak ditemukan untuk kueri pengguna. Kueri yang ditafsirkan akan kosong untuk kasus ini.

SearchResult

Hasil yang berisi informasi terindeks untuk dokumen. ID Berikutnya: 16

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 sebenarnya. URL ini ditandatangani dan tidak boleh diubah.
snippet

object (Snippet)

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

object (Metadata)

metadata hasil penelusuran.
clusteredResults[]

object (SearchResult)

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

object (ResultDebugInfo)

Informasi proses debug tentang hasil penelusuran ini.

Cuplikan

Cuplikan hasil penelusuran, yang merangkum konten halaman yang dihasilkan.

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

string

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

object (MatchRange)

Rentang yang cocok dalam cuplikan.

MatchRange

Rentang cuplikan yang cocok [start, end).

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

integer

Posisi awal kecocokan dalam cuplikan.
end

integer

Akhir pertandingan 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.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
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.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
fields[]

object (NamedProperty)

Kolom yang diindeks 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 baris meta yang akan ditampilkan dengan hasil.

ResultDisplayMetadata.ResultDisplayLine

Kumpulan kolom yang membentuk baris yang ditampilkan

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

object (ResultDisplayMetadata.ResultDisplayField)

ResultDisplayMetadata.ResultDisplayField

Menampilkan 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 yang diformat untuk ditampilkan.

StructuredResult

Hasil terstruktur yang ditampilkan sebagai bagian dari permintaan penelusuran.

Representasi JSON 
{

  // Union field structured_result can be only one of the following:
  "person": {
    object (Person)
  }
  // End of list of possible types for union field structured_result.
}
Kolom

Kolom union structured_result.

structured_result hanya dapat berupa salah satu dari berikut:
person

object (Person)

Representasi seseorang

SpellResult

Representasi JSON 
{
  "suggestedQuery": string,
  "suggestionType": enum (SpellResult.SuggestionType),
  "suggestedQueryHtml": {
    object (SafeHtmlProto)
  }
}
Kolom
suggestedQuery

string

Ejaan kueri yang disarankan.
suggestionType

enum (SpellResult.SuggestionType)

saran dipicu untuk kueri saat ini.
suggestedQueryHtml

object (SafeHtmlProto)

HTML yang sudah dibersihkan yang merepresentasikan kueri yang ejaannya dikoreksi yang dapat digunakan di UI. Biasanya memiliki tag khusus bahasa untuk menandai bagian kueri yang diperiksa ejaannya.

SpellResult.SuggestionType

Jenis saran yang dipicu untuk kueri.

Enum
SUGGESTION_TYPE_UNSPECIFIED Jenis pemeriksaan ejaan default
NON_EMPTY_RESULTS_SPELL_SUGGESTION Saran ejaan tanpa hasil apa pun diubah. Hasil tetap ditampilkan untuk kueri asli (yang memiliki hasil / non-nol) dengan saran ejaan yang akan menghasilkan hasil.
ZERO_RESULTS_FULL_PAGE_REPLACEMENT Saran ejaan dipicu saat kueri asli tidak memiliki hasil. Jika kueri asli tidak memiliki hasil, dan saran ejaan memiliki hasil, kami akan memicu hasil untuk kueri yang telah dikoreksi ejaannya.

SafeHtmlProto

PENTING: Menerima pesan ini dari sumber yang tidak tepercaya tidak aman, karena penyerang dapat dengan mudah memalsukan pesan berserial yang tidak memenuhi kontrak keamanan jenis -- misalnya, pesan tersebut dapat berisi skrip yang dikontrol penyerang. Sistem yang menerima SafeHtmlProto secara implisit memercayai produsen SafeHtmlProto. Jadi, umumnya aman untuk menampilkan pesan ini dalam respons RPC, tetapi umumnya tidak aman untuk menerimanya dalam permintaan RPC.

Representasi JSON 
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Kolom
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

PENTING: Jangan pernah menyetel atau membaca kolom ini, bahkan dari pengujian, karena bersifat pribadi. Lihat dokumentasi di bagian atas file .proto untuk mengetahui paket bahasa pemrograman yang digunakan untuk membuat atau membaca pesan ini.

FacetResult

Respons aspek khusus sumber

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

string

Nama sumber yang hasil facetnya ditampilkan. Tidak akan kosong.
objectType

string

Jenis objek yang hasil fasetnya ditampilkan. Boleh kosong.
operatorName

string

Nama operator yang dipilih untuk pengelompokan. @see cloudsearch.SchemaPropertyOptions
buckets[]

object (FacetBucket)

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

FacetBucket

Bucket dalam aspek adalah unit dasar operasi. Kelompok dapat terdiri dari satu nilai 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)
  },

  // Union field bucket_value can be only one of the following:
  "value": {
    object (Value)
  }
  // End of list of possible types for union field bucket_value.
}
Kolom
count

integer

Jumlah hasil yang cocok dengan nilai bucket. Jumlah hanya ditampilkan untuk penelusuran jika akurasi jumlah dipastikan. Cloud Search tidak menjamin jumlah aspek untuk kueri apa pun dan jumlah aspek mungkin hanya muncul sesekali, bahkan untuk kueri yang identik. Jangan membangun dependensi pada keberadaan jumlah aspek; sebagai gantinya, gunakan persentase jumlah aspek yang selalu ditampilkan.
percentage

integer

Persen hasil yang cocok dengan nilai bucket. Nilai yang ditampilkan adalah antara (0-100], dan dibulatkan ke bawah menjadi bilangan bulat jika berupa pecahan. Jika nilai tidak ditampilkan secara eksplisit, nilai tersebut mewakili nilai persentase yang dibulatkan menjadi 0. Persentase ditampilkan untuk semua penelusuran, tetapi 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.
Kolom union bucket_value. Rentang atau nilai bucket yang difasetkan bucket_value hanya dapat berupa salah satu dari berikut:
value

object (Value)

ResponseDebugInfo

Informasi proses debug tentang respons.

Representasi JSON 
{
  "formattedDebugInfo": string
}
Kolom
formattedDebugInfo

string

Info debug umum yang 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 terkait dengan informasi jumlah hasil.
hasMoreResults

boolean

Apakah ada hasil penelusuran lainnya untuk sumber ini.

Kolom union result_count.

result_count hanya dapat berupa salah satu dari berikut:
resultCountEstimate

string (int64 format)

Estimasi jumlah hasil untuk sumber ini.
resultCountExact

string (int64 format)

Jumlah hasil yang tepat untuk sumber ini.