Method: query.sources.list

Affiche la liste des sources que l'utilisateur peut utiliser pour les API query.search et Suggest.

Remarque:L'exécution de cette API nécessite un compte utilisateur final standard. Un compte de service ne peut pas effectuer directement des requêtes API Query. 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

GET https://cloudsearch.googleapis.com/v1/query/sources

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
requestOptions

object (RequestOptions)

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

string

Nombre de sources à renvoyer dans la réponse.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

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

Réponse de liste des sources.

Représentation JSON 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
Champs
sources[]

object (QuerySource)
nextPageToken

string

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 relatif aux autorisations.

QuerySource

Liste des sources dans lesquelles l'utilisateur peut effectuer des recherches à l'aide de l'API Query.

Représentation JSON 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
Champs
source

object (Source)

Nom de la source
shortName

string

Nom court ou alias de la source. Cette valeur peut être utilisée avec l'opérateur "source".
displayName

string

Nom à afficher de la source de données.
operators[]

object (QueryOperator)

Liste de tous les opérateurs applicables pour cette source.

QueryOperator

Définition d'un opérateur pouvant être utilisé dans une requête query.search/query.suggest.

Représentation JSON 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
Champs
operatorName

string

Nom de l'opérateur.
lessThanOperatorName

string

Indique le nom de l'opérateur permettant d'isoler la propriété à l'aide de l'opérateur "inférieur à".
greaterThanOperatorName

string

Indique le nom de l'opérateur permettant d'isoler la propriété à l'aide de l'opérateur "supérieur à".
type

enum (QueryOperator.Type)

Type d'opérateur.
displayName

string

Nom à afficher de l'opérateur
isSortable

boolean

Cet opérateur peut-il être utilisé pour trier les résultats ?
isFacetable

boolean

Cet opérateur peut-il être utilisé pour obtenir des attributs.
isReturnable

boolean

La propriété associée à cet attribut sera-t-elle renvoyée dans les résultats de recherche ?
isRepeatable

boolean

Indique si plusieurs valeurs peuvent être définies pour cette propriété.
isSuggestable

boolean

Peut obtenir des suggestions pour ce champ.
enumValues[]

string

Liste potentielle de valeurs pour le champ opeatror. Ce champ n'est rempli que si nous pouvons énumérer en toute sécurité toutes les valeurs possibles de cet opérateur.
objectType

string

Nom de l'objet correspondant à l'opérateur. Ce champ n'est renseigné que pour les opérateurs spécifiques au schéma. Il n'est pas défini pour les opérateurs courants.

QueryOperator.Type

Type de la propriété référencée par l'opérateur.

Enums
UNKNOWN Valeur incorrecte.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML