Method: query.suggest

Fornece sugestões para o preenchimento automático da consulta.

Observação:essa API requer uma conta de usuário final padrão para ser executada. 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 em que as sugestões de preenchimento automático serão mostradas. Por exemplo, se a consulta for "mar", 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 forem especificadas, as fontes de dados serão extraídas do app de pesquisa atual.

OBSERVAÇÃO: as sugestões são aceitas apenas para as seguintes fontes:

  • 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 do 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 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. Também indica o tipo de consulta sugerida. Por exemplo: se PeopleSuggestion estiver presente, isso indica que suggested_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 um preenchimento de palavra/frase.
peopleSuggestion

object (PeopleSuggestion)

Está 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

No momento, esse campo não contém nada e é usado apenas como indicador de que o resultado sugerido foi o preenchimento de uma frase.

PeopleSuggestion

Este campo contém informações sobre a pessoa sugerida.

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

object (Person)

Pessoa sugerida. Talvez todos os campos do objeto da pessoa não estejam preenchidos.