Method: query.search

La API de búsqueda de Cloud Search proporciona el método de búsqueda, que muestra los resultados más relevantes de una búsqueda del usuario. Los resultados pueden provenir de apps de Google Workspace, como Gmail o Google Drive, o de datos que indexaste de un tercero.

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/search

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,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Campos
requestOptions

object (RequestOptions)

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

string

Es la cadena de consulta sin procesar. Consulta los operadores de búsqueda admitidos en Cómo acotar tu búsqueda con operadores
pageSize

integer

Es la cantidad máxima de resultados de la búsqueda que se mostrarán en una página. Los valores válidos están entre 1 y 100 inclusive. El valor predeterminado es 10. El valor mínimo es 50 cuando se solicitan resultados más allá de 2,000.
start

integer

Es el índice inicial de los resultados.
dataSourceRestrictions[]

object (DataSourceRestriction)

Las fuentes que se usarán para realizar consultas. Si no se especifica, se usan todas las fuentes de datos de la aplicación de búsqueda actual.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Las opciones para ordenar los resultados de la búsqueda
queryInterpretationOptions

object (QueryInterpretationOptions)

opciones para interpretar la consulta del usuario.
contextAttributes[]

object (ContextAttribute)

Atributos de contexto para la solicitud que se usarán para ajustar la clasificación de los resultados de la búsqueda. La cantidad máxima de elementos es 10.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SearchResponse.

Alcances 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.