傳回使用者可用於 query.search 和 Suggest API 的來源清單。
注意:您必須執行標準使用者帳戶,才能執行這個 API。服務帳戶無法直接執行 Query API 要求。如要使用服務帳戶執行查詢,請設定 Google Workspace 全網域授權委派。
HTTP 要求
GET https://cloudsearch.googleapis.com/v1/query/sources
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
requestOptions |
要求選項,例如搜尋應用程式和使用者時區。 |
pageToken |
回應中要傳回的來源數量。 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
清單來源回應。
JSON 表示法 |
---|
{
"sources": [
{
object ( |
欄位 | |
---|---|
sources[] |
|
nextPageToken |
|
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
詳情請參閱授權指南。
QuerySource
使用者可透過查詢 API 搜尋的來源清單。
JSON 表示法 |
---|
{ "source": { object ( |
欄位 | |
---|---|
source |
來源名稱 |
shortName |
來源的簡稱或別名。這個值可與「source」運算子搭配使用。 |
displayName |
資料來源的顯示名稱。 |
operators[] |
適用於這個來源的所有運算子清單。 |
QueryOperator
定義可用於 query.search/query.suggest 要求中的運算子。
JSON 表示法 |
---|
{
"operatorName": string,
"lessThanOperatorName": string,
"greaterThanOperatorName": string,
"type": enum ( |
欄位 | |
---|---|
operatorName |
運算子的名稱。 |
lessThanOperatorName |
指出可使用小於 運算子分隔屬性的運算子名稱。 |
greaterThanOperatorName |
指出可使用大於 1 運算子分隔屬性的運算子名稱。 |
type |
運算子的類型, |
displayName |
業者的顯示名稱 |
isSortable |
此運算子可用於排序結果。 |
isFacetable |
這個運算子可用於取得商情項目。 |
isReturnable |
與這個 facet 相關聯的屬性是否會做為搜尋結果傳回。 |
isRepeatable |
指出這個屬性是否可設定多個值。 |
isSuggestable |
可取得這個欄位的建議。 |
enumValues[] |
可能的值清單。只有在我們能夠安全列舉這個運算子的所有可能值時,才會填入這個欄位。 |
objectType |
與運算子對應的物件名稱。只有結構定義專屬的運算子才會填寫這個欄位,一般運算子不會設定此值。 |
QueryOperator.Type
運算子所參照的屬性類型。
列舉 | |
---|---|
UNKNOWN |
無效的值。 |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |