Method: query.search

Cloud Search Query API 提供了搜索方法，该方法会根据用户查询返回最相关的结果。结果可以来自 Google Workspace 应用（例如 Gmail 或 Google 云端硬盘），也可以来自您为第三方编入索引的数据。

注意：此 API 需要使用标准最终用户账号才能执行。服务账号无法直接执行查询 API 请求；如需使用服务账号执行查询，请设置 Google Workspace 全网域授权。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

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)
    }
  ]
}
字段
requestOptions

object (RequestOptions)

请求选项，例如搜索应用和用户时区。
query

string

原始查询字符串。如需查看支持的搜索运算符，请参阅使用运算符缩小搜索范围
pageSize

integer

一页返回的搜索结果数上限。有效值介于 1 到 100 之间（包括这两个数值）。默认值为 10。如果请求的结果数量超过 2000 个，则最小值为 50。
start

integer

结果的起始索引。
dataSourceRestrictions[]

object (DataSourceRestriction)

用于查询的来源。如果未指定，则使用当前搜索应用中的所有数据源。
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

用于对搜索结果排序的选项
queryInterpretationOptions

object (QueryInterpretationOptions)

用于解释用户查询的选项。
contextAttributes[]

object (ContextAttribute)

请求的上下文属性，将用于调整搜索结果的排名。元素数量上限为 10 个。

响应正文

如果成功，则响应正文包含一个 SearchResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅授权指南。