Method: query.suggest

Proporciona sugerencias para completar automáticamente la consulta.

Nota: Para ejecutarse esta API, se requiere una cuenta de usuario final estándar. Una cuenta de servicio no puede realizar solicitudes a la API de Query directamente. Si quieres usar una cuenta de servicio para realizar consultas, debes configurar la delegación de autoridad de todo el dominio de Google Workspace.

Solicitud HTTP

POST https://cloudsearch.googleapis.com/v1/query/suggest

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Campos
requestOptions

object (RequestOptions)

Opciones de solicitud, como la aplicación de búsqueda y la zona horaria del usuario

query

string

Consulta parcial para la que se mostrarán las sugerencias de autocompletar. Por ejemplo, si la consulta es "mar", entonces el servidor podría mostrar "temporada", "búsqueda", "gaviota", etcétera.

dataSourceRestrictions[]

object (DataSourceRestriction)

Las fuentes que se utilizan para las sugerencias. Si no se especifican, las fuentes de datos se obtienen de la aplicación de búsqueda actual.

NOTA: Las sugerencias solo se admiten para las siguientes fuentes:

  • Fuentes de datos de terceros
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Respuesta de la API de Suggest

Representación JSON
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Campos
suggestResults[]

object (SuggestResult)

Lista de sugerencias.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Para obtener más información, consulta la guía de autorización.

SuggestResult

Un resultado de sugerencia.

Representación 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

La consulta sugerida que se utilizará para la búsqueda cuando el usuario haga clic en la sugerencia

source

object (Source)

Es la fuente de la sugerencia.

Campo de unión suggestion. Contiene metadatos adicionales sobre la consulta sugerida. También indica el tipo de consulta sugerida. Por ejemplo, si PeopleSugeririon está presente, esto indica que suggested_query es una sugerencia de persona. Las direcciones (suggestion) solo pueden ser una de las siguientes opciones:
querySuggestion

object (QuerySuggestion)

Este campo estará presente si la consulta sugerida es una palabra o frase completa.

peopleSuggestion

object (PeopleSuggestion)

Esto está presente cuando la sugerencia indica una persona. Contiene más información sobre la persona, como su ID de correo electrónico, nombre, etc.

QuerySuggestion

Este campo no contiene nada a partir de ahora y solo se usa como indicador de que el resultado sugerido fue una frase completada.

PeopleSuggestion

Este campo contiene información sobre la persona sugerida.

Representación JSON
{
  "person": {
    object (Person)
  }
}
Campos
person

object (Person)

Persona sugerida Es posible que no se propaguen todos los campos del objeto person.