Method: query.search

L'API di query Cloud Search fornisce il metodo di ricerca, che restituisce i risultati più pertinenti da una query dell'utente. I risultati possono provenire da app Google Workspace, come Gmail o Google Drive, oppure da dati che hai indicizzato da terze parti.

Nota:per l'esecuzione di questa API è necessario un account utente finale standard. Un account di servizio non può eseguire direttamente richieste API di query. Per utilizzare un account di servizio per eseguire query, configura la delega dell'autorità a livello di dominio di Google Workspace.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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)
    }
  ]
}
Campi
requestOptions

object (RequestOptions)

Opzioni di richiesta, ad esempio l'applicazione di ricerca e il fuso orario dell'utente.
query

string

La stringa di query non elaborata. Consulta gli operatori di ricerca supportati in Restringere la ricerca con gli operatori
pageSize

integer

Numero massimo di risultati di ricerca da restituire in una pagina. I valori validi sono compresi tra 1 e 100, inclusi. Il valore predefinito è 10. Il valore minimo è 50 se vengono richiesti risultati oltre 2000.
start

integer

Indice iniziale dei risultati.
dataSourceRestrictions[]

object (DataSourceRestriction)

Le origini da utilizzare per le query. Se non specificato, vengono utilizzate tutte le origini dati dell'applicazione di ricerca corrente.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Le opzioni per ordinare i risultati di ricerca
queryInterpretationOptions

object (QueryInterpretationOptions)

opzioni per interpretare la query dell'utente.
contextAttributes[]

object (ContextAttribute)

Attributi di contesto per la richiesta che verranno utilizzati per modificare il ranking dei risultati di ricerca. Il numero massimo di elementi è 10.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di SearchResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.