Method: query.suggest

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Oferece sugestões para concluir automaticamente a consulta.

Observação:para usar essa API, é necessário ter uma conta de usuário final padrão. Uma conta de serviço não pode fazer solicitações da API Query diretamente. Para usar uma conta de serviço para realizar 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 exibidas. Por exemplo, se a consulta for "mar", o servidor poderá retornar "temporada", "pesquisa", "gaivota" e assim por diante.

dataSourceRestrictions[]

object (DataSourceRestriction)

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

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

  • Origens de dados de terceiros
  • Predefinição
  • PreSource.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 a Visão geral do OAuth 2.0.

Sugerir resultado

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)

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

peopleSuggestion

object (PeopleSuggestion)

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

Sugestão de consulta

Por enquanto, esse campo não contém nada e é usado apenas como um indicador de que o resultado da sugestão 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.