Method: query.suggest

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

Observação:essa API exige uma conta de usuário final padrão para ser executada. Uma conta de serviço não pode executar solicitações de API de consulta diretamente. Para usar uma conta de serviço para executar 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 aplicativo 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 "mar", o servidor poderá retornar "estação", "pesquisa", "gaivota" e assim por diante.
dataSourceRestrictions[]

object (DataSourceRestriction)

As origens a serem usadas para sugestões. Se não forem especificadas, as fontes de dados serão extraídas do aplicativo de pesquisa atual.

OBSERVAÇÃO: as sugestões têm suporte apenas para as seguintes fontes:

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

Corpo da resposta

Resposta da API de sugestões.

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

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 origem da sugestão.
Campo de união suggestion. Contém metadados adicionais sobre a consulta sugerida. Ele também indica o tipo da consulta sugerida. Por exemplo, se a propriedade PeopleSuggestion estiver presente, isso indica que a propriedade suggested_query é uma sugestão de pessoa. suggestion pode ser apenas de um dos tipos a seguir:
querySuggestion

object (QuerySuggestion)

Este campo vai estar presente se a consulta sugerida for uma palavra/expressão completa.
peopleSuggestion

object (PeopleSuggestion)

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

QuerySuggestion

Esse tipo não tem campos.

Esse campo não contém nada no momento e é usado apenas como um indicador de que o resultado sugerido foi uma conclusão de frase.

PeopleSuggestion

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

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

object (Person)

Pessoa sugerida. É possível que nem todos os campos do objeto de pessoa sejam preenchidos.