Method: query.sources.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la liste des sources que l'utilisateur peut utiliser pour les API Search et Suggest.
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
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
Réponse de la liste des sources.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| 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.queryhttps://www.googleapis.com/auth/cloud_search
Pour en savoir plus, consultez le guide d'autorisation.
QuerySource
Liste des sources que l'utilisateur peut rechercher à l'aide de l'API de requête.
| 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 à cette source.
|
QueryOperator
Définition d'un opérateur pouvant être utilisé dans une requête 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 qui peut être utilisé pour isoler la propriété à l'aide de l'opérateur inférieur.
|
greaterThanOperatorName |
string
Indique le nom de l'opérateur qui peut être utilisé pour isoler la propriété à l'aide de l'opérateur "supérieur à".
|
type |
enum (QueryOperator.Type)
Type de l'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 facettes ?
|
isReturnable |
boolean
Indique si la propriété associée à cet attribut sera renvoyée dans les résultats de recherche.
|
isRepeatable |
boolean
Indique si plusieurs valeurs peuvent être définies pour cette propriété.
|
isSuggestable |
boolean
Vous pouvez obtenir des suggestions pour ce champ.
|
enumValues[] |
string
Liste des valeurs possibles pour le champ "opérateur". Ce champ n'est renseigné que lorsque 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 et n'est pas défini pour les opérateurs courants.
|
QueryOperator.Type
Type de l'établissement référencé par l'opérateur.
| Enums |
UNKNOWN |
Valeur incorrecte. |
INTEGER |
|
DOUBLE |
|
TIMESTAMP |
|
BOOLEAN |
|
ENUM |
|
DATE |
|
TEXT |
|
HTML |
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: query.sources.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListQuerySourcesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [QuerySource](#QuerySource)\n - [JSON representation](#QuerySource.SCHEMA_REPRESENTATION)\n- [QueryOperator](#QueryOperator)\n - [JSON representation](#QueryOperator.SCHEMA_REPRESENTATION)\n- [QueryOperator.Type](#QueryOperator.Type)\n- [Try it!](#try-it)\n\nReturns list of sources that user can use for Search and Suggest APIs.\n\n**Note:** This API requires a standard end user account to execute. A service account can't perform query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).\n\n### HTTP request\n\n`GET https://cloudsearch.googleapis.com/v1/query/sources`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestOptions` | `object (`[RequestOptions](/workspace/cloud-search/docs/reference/rest/v1/RequestOptions)`)` Request options, such as the search application and user timezone. |\n| `pageToken` | `string` Number of sources to return in the response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList sources response.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sources\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QuerySource) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------|\n| `sources[]` | `object (`[QuerySource](/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QuerySource)`)` |\n| `nextPageToken` | `string` |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.query`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nQuerySource\n-----------\n\nList of sources that the user can search using the query API.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"source\": { object (/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#Source) }, \"shortName\": string, \"displayName\": string, \"operators\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QueryOperator) } ] } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `source` | `object (`[Source](/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#Source)`)` The name of the source |\n| `shortName` | `string` A short name or alias for the source. This value can be used with the 'source' operator. |\n| `displayName` | `string` Display name of the data source. |\n| `operators[]` | `object (`[QueryOperator](/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QueryOperator)`)` List of all operators applicable for this source. |\n\nQueryOperator\n-------------\n\nThe definition of a operator that can be used in a Search/query.suggest request.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"operatorName\": string, \"lessThanOperatorName\": string, \"greaterThanOperatorName\": string, \"type\": enum (/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QueryOperator.Type), \"displayName\": string, \"isSortable\": boolean, \"isFacetable\": boolean, \"isReturnable\": boolean, \"isRepeatable\": boolean, \"isSuggestable\": boolean, \"enumValues\": [ string ], \"objectType\": string } ``` |\n\n| Fields ||\n|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `operatorName` | `string` The name of the operator. |\n| `lessThanOperatorName` | `string` Indicates the operator name that can be used to isolate the property using the less-than operator. |\n| `greaterThanOperatorName` | `string` Indicates the operator name that can be used to isolate the property using the greater-than operator. |\n| `type` | `enum (`[QueryOperator.Type](/workspace/cloud-search/docs/reference/rest/v1/query.sources/list#QueryOperator.Type)`)` The type of the operator. |\n| `displayName` | `string` Display name of the operator |\n| `isSortable` | `boolean` Can this operator be used to sort results. |\n| `isFacetable` | `boolean` Can this operator be used to get facets. |\n| `isReturnable` | `boolean` Will the property associated with this facet be returned as part of search results. |\n| `isRepeatable` | `boolean` Indicates if multiple values can be set for this property. |\n| `isSuggestable` | `boolean` Can get suggestions for this field. |\n| `enumValues[]` | `string` Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator. |\n| `objectType` | `string` The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators. |\n\nQueryOperator.Type\n------------------\n\nThe type of the property referred by the operator.\n\n| Enums ||\n|-------------|----------------|\n| `UNKNOWN` | Invalid value. |\n| `INTEGER` | |\n| `DOUBLE` | |\n| `TIMESTAMP` | |\n| `BOOLEAN` | |\n| `ENUM` | |\n| `DATE` | |\n| `TEXT` | |\n| `HTML` | |"]]
