- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- SuggestResult
- Sugestão de consulta
- Sugestão de pessoas
- Faça um teste
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 ( |
Campos | |
---|---|
requestOptions |
Opções de solicitação, como o app de pesquisa e o fuso horário do usuário. |
query |
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[] |
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:
|
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 ( |
Campos | |
---|---|
suggestResults[] |
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 ( |
Campos | |
---|---|
suggestedQuery |
A consulta sugerida que será usada para pesquisa quando o usuário clicar na sugestão |
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 |
Este campo estará presente se a consulta sugerida for uma conclusão de palavra/frase. |
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 ( |
Campos | |
---|---|
person |
Pessoa sugerida. Nem todos os campos do objeto de pessoa podem ser preenchidos. |