Method: query.suggest

Fournit des suggestions pour la saisie semi-automatique de la requête.

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

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,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Champs
requestOptions

object (RequestOptions)

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

string

Requête partielle pour laquelle des suggestions de saisie semi-automatique s'affichent. Par exemple, si la requête est "mer", le serveur peut renvoyer "saison", "recherche", "mouette", etc.
dataSourceRestrictions[]

object (DataSourceRestriction)

Sources à utiliser pour les suggestions. Si ce paramètre n'est pas spécifié, les sources de données sont extraites de l'application de recherche actuelle.

REMARQUE: Les suggestions ne sont disponibles que pour les sources suivantes:

  • Sources de données tierces
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Corps de la réponse

Réponse de l'API de suggestion.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Champs
suggestResults[]

object (SuggestResult)

Liste de suggestions.

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.

SuggestResult

Un résultat de suggestion.

Représentation 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.
}
Champs
suggestedQuery

string

Requête suggérée qui sera utilisée pour la recherche lorsque l'utilisateur cliquera dessus
source

object (Source)

Source de la suggestion.
Champ d'union suggestion. Contient des métadonnées supplémentaires sur la requête suggérée. Il indique également le type de la requête suggérée. Par exemple, si "PeopleSuggestion" est présent, cela signifie que "suggested_query" est une suggestion de personne. suggestion ne peut être qu'un des éléments suivants :
querySuggestion

object (QuerySuggestion)

Ce champ est présent si la requête suggérée est une saisie semi-automatique de mot/d'expression.
peopleSuggestion

object (PeopleSuggestion)

Cette option s'affiche lorsque la suggestion indique une personne. Il contient plus d'informations sur la personne, comme son adresse e-mail, son nom, etc.

QuerySuggestion

Ce type ne comporte aucun champ.

Ce champ ne contient rien pour le moment et sert uniquement à indiquer que le résultat de la suggestion était une phrase complétée.

PeopleSuggestion

Ce champ contient des informations sur la personne suggérée.

Représentation JSON 
{
  "person": {
    object (Person)
  }
}
Champs
person

object (Person)

Personne suggérée. Il est possible que tous les champs de l'objet personne ne soient pas renseignés.