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

有关详情,请参阅 OAuth 2.0 概览

QuerySource

用户可以使用查询 API 搜索的来源列表。

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

object (Source)

来源的名称

shortName

string

来源的简称或别名。此值可用于 &'source' 运算符。

displayName

string

数据源的显示名。

operators[]

object (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

此运算符是否可用于获取构面。

isReturnable

boolean

与此构面关联的属性是否作为搜索结果的一部分返回。

isRepeatable

boolean

指明是否可以为此属性设置多个值。

isSuggestable

boolean

可以获取关于此字段的建议。

enumValues[]

string

opopror 字段的值的可能列表。仅当我们能够安全枚举此运算符的所有可能值时,系统才会填充此字段。

objectType

string

与运算符对应的对象的名称。此字段仅针对特定于架构的运算符填充,对于常见运算符未设置。

QueryOperator.Type

运算符引用的属性类型。

枚举
UNKNOWN 值无效。
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML