提供自动填充查询的建议。
注意:执行此 API 需要标准的最终用户帐号。服务帐号无法直接执行 Query API 请求;要使用服务帐号执行查询,请设置 Google Workspace 全网域授权。
HTTP 请求
POST https://cloudsearch.googleapis.com/v1/query/suggest
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "requestOptions": { object ( |
字段 | |
---|---|
requestOptions |
请求选项,例如搜索应用和用户时区。 |
query |
显示自动补全建议的部分查询。例如,如果查询内容是“sea”,服务器可能会返回“season”、“search”、“seagull”等语句。 |
dataSourceRestrictions[] |
用于获取建议的来源。如果未指定,数据源将取自当前搜索应用。 注意:仅以下来源支持建议:
|
响应正文
如果成功,响应正文将包含结构如下的数据:
建议 API 的响应。
JSON 表示法 |
---|
{
"suggestResults": [
{
object ( |
字段 | |
---|---|
suggestResults[] |
建议列表。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
有关详情,请参阅授权指南。
SuggestResult
1 条建议结果。
JSON 表示法 |
---|
{ "suggestedQuery": string, "source": { object ( |
字段 | |
---|---|
suggestedQuery |
当用户点击建议时将用于搜索的建议查询 |
source |
建议的来源。 |
联合字段 suggestion 。包含有关建议查询的其他元数据。它还会指明建议查询的类型。例如,如果存在 PeopleSuggestion,则其表示 suggest_query 是一个人物建议。suggestion 只能是下列其中一项: |
|
querySuggestion |
如果建议的查询是字词/短语补全,系统就会显示此字段。 |
peopleSuggestion |
当建议指示人物时,系统就会显示此通知。其中包含有关此人的更多信息,如电子邮件 ID、姓名等。 |
QuerySuggestion
该字段目前不包含任何内容,仅用于表明建议结果为词组补全情况。
PeopleSuggestion
此字段包含被建议人员的相关信息。
JSON 表示法 |
---|
{
"person": {
object ( |
字段 | |
---|---|
person |
为你推荐的人。系统可能不会填充该 person 对象的所有字段。 |