Method: query.sources.list

傳回使用者可用於 Search 和 Suggest API 的來源清單。

注意：執行這個 API 需要標準使用者帳戶。服務帳戶無法直接執行查詢 API 要求。如要使用服務帳戶執行查詢，請設定 Google Workspace 全網域委派權限。

HTTP 要求

GET https://cloudsearch.googleapis.com/v1/query/sources

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
requestOptions

object (RequestOptions)

請求選項，例如搜尋應用程式和使用者時區。
pageToken

string

回應中要傳回的來源數量。

要求主體

要求主體必須為空白。

回應主體

列出來源回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
欄位
sources[]

object (QuerySource)
nextPageToken

string

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。

QuerySource

使用者可使用查詢 API 搜尋的來源清單。

JSON 表示法 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
欄位
source

object (Source)

來源名稱
shortName

string

來源的簡稱或別名。這個值可與「source」運算子搭配使用。
displayName

string

資料來源的顯示名稱。
operators[]

object (QueryOperator)

此來源適用的所有運算子清單。

QueryOperator

可在 Search/query.suggest 要求中使用的運算子定義。

JSON 表示法 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
欄位
operatorName

string

運算子的名稱。
lessThanOperatorName

string

表示可用於使用小於運算子隔離屬性的運算子名稱。
greaterThanOperatorName

string

表示可用於使用大於運算子隔離屬性的運算子名稱。
type

enum (QueryOperator.Type)

運算子的類型。
displayName

string

運算子的顯示名稱
isSortable

boolean

這個運算子可用於排序結果嗎？
isFacetable

boolean

這個運算子可用於取得切面嗎？
isReturnable

boolean

是否會將與此面向傳回的屬性納入搜尋結果。
isRepeatable

boolean

指出是否可以為此屬性設定多個值。
isSuggestable

boolean

可以取得此欄位的建議。
enumValues[]

string

運算子欄位的可能值清單。只有在我們可以安全地列舉此運算子的所有可能值時，才會填入這個欄位。
objectType

string

對應至運算子的物件名稱。這個欄位只會填入特定結構定義運算子的值，不會填入一般運算子的值。

QueryOperator.Type

運算子參照的屬性類型。

列舉
UNKNOWN 無效的值。
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML