Method: query.suggest

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

提供关于自动填充查询的建议。

注意:此 API 需要标准的最终用户帐号才能执行。服务帐号无法直接执行 Query API 请求;要使用服务帐号执行查询,请设置 Google Workspace 全网域授权

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
字段
requestOptions

object (RequestOptions)

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

query

string

将出现自动补全建议的部分查询。例如,如果查询为“sea”,那么服务器可能会返回“season”、“search”、“seagull”等。

dataSourceRestrictions[]

object (DataSourceRestriction)

建议来源。如果未指定,则数据源取自当前搜索应用。

注意:系统仅支持针对以下来源的建议:

  • 第三方数据源
  • 预定义来源
  • 预定义来源。GOOGLE_DRIVE

响应正文

如果成功,响应正文将包含结构如下的数据:

建议 API 的响应。

JSON 表示法
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
字段
suggestResults[]

object (SuggestResult)

建议列表。

授权范围

需要以下 OAuth 范围之一:

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

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

建议结果

1 条建议结果。

JSON 表示法
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
字段
suggestedQuery

string

将在您点击建议时用于搜索的建议查询

source

object (Source)

建议的来源。

联合字段 suggestion。包含与建议查询有关的其他元数据。它还会指出建议的查询的类型。例如,如果存在 PeopleSuggestion,它表示 suggestion_query 是一个人物建议。suggestion 只能是下列其中一项:
querySuggestion

object (QuerySuggestion)

如果建议的查询是字词/短语补全,则将出现此字段。

peopleSuggestion

object (PeopleSuggestion)

如果建议表示用户,系统就会显示此信息。它包含有关联系人的更多信息,例如其电子邮件 ID、姓名等。

查询建议

此字段目前不含任何内容,只是用作建议结果是词组完成情况的指示。

用户建议

此字段包含有关建议人员的信息。

JSON 表示法
{
  "person": {
    object (Person)
  }
}
字段
person

object (Person)

建议的联系人。人物对象的所有字段可能未填充内容。