Method: query.suggest

Proporciona sugerencias para autocompletar la búsqueda.

Nota: Esta API requiere una cuenta de usuario final estándar para ejecutarse. Una cuenta de servicio no puede realizar solicitudes a la API de consulta directamente. Para usar una cuenta de servicio para realizar consultas, configura la delegación de autoridad en 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)

Solicita opciones, como la aplicación de búsqueda y la zona horaria del usuario.
query

string

Es la consulta parcial para la que se mostrarán las sugerencias de autocompletado. Por ejemplo, si la consulta es "mar", el servidor podría mostrar "estación", "búsqueda", "gaviota", etcétera.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

NOTA: Las sugerencias solo son compatibles con las siguientes fuentes:

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

Cuerpo de la respuesta

Respuesta de la API de sugerencias.

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

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

object (SuggestResult)

Es la lista de sugerencias.

Permisos de autorización

Se necesita uno de los siguientes permisos 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

Es la búsqueda sugerida que se usará 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 búsqueda sugerida. También indica el tipo de consulta sugerida. Por ejemplo, si PeopleSuggestion está presente, 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 búsqueda sugerida es una finalización de palabra o frase.
peopleSuggestion

object (PeopleSuggestion)

Aparece 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 tipo no tiene campos.

Por el momento, este campo no contiene nada y solo se usa como indicador de que el resultado de la sugerencia fue una finalización de frase.

PeopleSuggestion

Este campo contiene información sobre la persona que se sugiere.

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

object (Person)

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