Method: query.sources.list

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

注意：這個 API 需要標準使用者帳戶才能執行。服務帳戶無法直接執行 Query 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

可在 query.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

此運算子可用於取得 facet。
isReturnable

boolean

搜尋結果是否會傳回與此 facet 相關聯的屬性。
isRepeatable

boolean

指出這個屬性是否能設定多個值。
isSuggestable

boolean

可取得這個欄位的建議。
enumValues[]

string

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

string

與運算子對應的物件名稱。這個欄位只會填寫結構定義專用的運算子，而且不會針對一般運算子進行設定。

QueryOperator.Type

運算子參照的屬性類型。

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