Method: query.suggest

Fornece sugestões para preencher automaticamente a 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. Para 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 sugestões de preenchimento automático serão exibidas. Por exemplo, se a consulta for "sea", o servidor poderá retornar "season", "search", "aagull" e assim por diante.
dataSourceRestrictions[]

object (DataSourceRestriction)

As fontes que serão usadas para sugestões. Se não for especificado, as fontes de dados serão obtidas do aplicativo de pesquisa atual.

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

  • Origens de dados de terceiros
  • Predefinição.PERSON
  • Fonte predefinida.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.

ResultadoResultar

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, 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 a conclusão de uma palavra/frase.
peopleSuggestion

object (PeopleSuggestion)

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

Sugestão de consulta

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.

Sugestão de pessoas

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 de pessoa podem ser preenchidos.