Method: query.suggest

Fornece sugestões para preencher automaticamente a consulta.

Observação:para executar essa API, é preciso ter uma conta de usuário final padrão. Uma conta de serviço não pode fazer solicitações da API Query diretamente. Se você quiser usar uma conta de serviço para fazer consultas, configure a delegação de autoridade em todo o domínio do Google Workspace.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Campos
requestOptions

object (RequestOptions)

Opções de solicitação, como o app de pesquisa e o fuso horário do usuário.
query

string

Consulta parcial para a qual as sugestões de preenchimento automático serão mostradas. Por exemplo, se a consulta for "sea", o servidor poderá retornar "temporada", "pesquisa", "gaivota" e assim por diante.
dataSourceRestrictions[]

object (DataSourceRestriction)

As fontes a serem usadas para sugestões. Se não for especificado, as origens de dados vão ser extraídas do app de pesquisa atual.

OBSERVAÇÃO: as sugestões são compatíveis apenas com as seguintes origens:

  • Origens de dados de terceiros
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Resposta da API de sugestão.

Representação JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Campos
suggestResults[]

object (SuggestResult)

Lista de sugestões.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte o Guia de autorização.

SuggestResult

Um resultado de sugestão.

Representação 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.
}
Campos
suggestedQuery

string

A consulta sugerida que será usada para a pesquisa quando o usuário clicar na sugestão.
source

object (Source)

A fonte da sugestão.
Campo de união suggestion. Contém metadados adicionais sobre a consulta sugerida. Ela também indica o tipo de consulta sugerida. Por exemplo, se PeopleSuggestion está presente, indica queger_query é uma sugestão de pessoa. suggestion pode ser apenas de um dos tipos a seguir:
querySuggestion

object (QuerySuggestion)

Este campo estará presente se a consulta sugerida for uma conclusão de palavra/frase.
peopleSuggestion

object (PeopleSuggestion)

Presente quando a sugestão indica uma pessoa. Ele contém mais informações sobre a pessoa, como ID de e-mail, nome etc.

QuerySuggestion

Este campo não contém nada a partir de agora e é usado apenas como um indicador de que o resultado da sugestão foi a conclusão de uma frase.

PeopleSuggestion

Esse campo contém informações sobre a pessoa que está sendo sugerida.

Representação JSON 
{
  "person": {
    object (Person)
  }
}
Campos
person

object (Person)

Pessoa sugerida. Nem todos os campos do objeto pessoa podem ser preenchidos.