Method: query.search

L'API de requête Cloud Search fournit la méthode de recherche, qui renvoie les résultats les plus pertinents d'une requête utilisateur. Les résultats peuvent provenir d'applications Google Workspace, comme Gmail ou Google Drive, ou de données que vous avez indexées à partir d'un tiers.

Remarque:Pour s'exécuter, cette API nécessite un compte utilisateur final standard. Un compte de service ne peut pas effectuer directement de requêtes d'API. Pour utiliser un compte de service pour effectuer des requêtes, configurez la délégation d'autorité au niveau du domaine Google Workspace.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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)
    }
  ]
}
Champs
requestOptions

object (RequestOptions)

Options de requête, telles que l'application de recherche et le fuseau horaire de l'utilisateur.
query

string

Chaîne de requête brute. Consultez les opérateurs de recherche compatibles dans Affiner votre recherche à l'aide d'opérateurs.
pageSize

integer

Nombre maximal de résultats de recherche à renvoyer sur une seule page. Les valeurs valides sont comprises entre 1 et 100, inclus. La valeur par défaut est 10. La valeur minimale est de 50 lorsque des résultats au-delà de 2 000 sont demandés.
start

integer

Index de début des résultats.
dataSourceRestrictions[]

object (DataSourceRestriction)

Sources à utiliser pour les requêtes. Si ce paramètre n'est pas spécifié, toutes les sources de données de l'application de recherche actuelle sont utilisées.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Options de tri des résultats de recherche
queryInterpretationOptions

object (QueryInterpretationOptions)

options pour interpréter la requête de l'utilisateur.
contextAttributes[]

object (ContextAttribute)

Attributs de contexte de la requête qui seront utilisés pour ajuster le classement des résultats de recherche. Le nombre maximal d'éléments est de 10.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SearchResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.