REST Resource: settings.datasources
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource : DataSource
La source de données est un espace de noms logique pour les éléments à indexer. Tous les éléments doivent appartenir à une source de données. Il s'agit d'une condition préalable à l'indexation des éléments dans Cloud Search.
Représentation JSON |
{
"name": string,
"displayName": string,
"shortName": string,
"indexingServiceAccounts": [
string
],
"disableServing": boolean,
"disableModifications": boolean,
"itemsVisibility": [
{
object (GSuitePrincipal )
}
],
"returnThumbnailUrls": boolean,
"operationIds": [
string
]
} |
Champs |
name |
string
Nom de la ressource de source de données. Format: datasources/{sourceId}. Le nom est ignoré lors de la création d'une source de données.
|
displayName |
string
Obligatoire. Nom à afficher de la source de données. La longueur maximale est de 300 caractères.
|
shortName |
string
Nom court ou alias de la source. Cette valeur sera utilisée pour faire correspondre l'opérateur "source". Par exemple, si le nom court est <valeur>, les requêtes telles que source:<valeur> ne renvoient que des résultats pour cette source. La valeur doit être unique dans toutes les sources de données. La valeur ne doit contenir que des caractères alphanumériques (a-zA-Z0-9). La valeur ne doit pas commencer par "google" et ne doit pas être l'une des valeurs suivantes: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people ou teams. Il ne doit pas dépasser 32 caractères.
|
indexingServiceAccounts[] |
string
Liste des comptes de service disposant d'un accès à l'indexation.
|
disableServing |
boolean
Désactivez l'affichage de résultats de recherche ou d'assistance.
|
disableModifications |
boolean
Si la valeur est "true", la source de données est définie en mode lecture seule. En mode lecture seule, l'API d'indexation rejette toutes les requêtes d'indexation ou de suppression d'éléments de cette source. L'activation du mode lecture seule n'arrête pas le traitement des données précédemment acceptées.
|
itemsVisibility[] |
object (GSuitePrincipal )
Ce champ limite la visibilité aux éléments au niveau de la source de données. Les éléments de la source de données sont limités à l'union des utilisateurs et des groupes inclus dans ce champ. Notez que cela n'assure pas l'accès à un élément spécifique, car les utilisateurs doivent disposer d'autorisations LCA sur les éléments qu'il contient. Cela garantit un accès de haut niveau à l'ensemble de la source de données et que les éléments individuels ne sont pas partagés en dehors de cette visibilité.
|
returnThumbnailUrls |
boolean
Un utilisateur peut demander à obtenir l'URI de la vignette pour les éléments indexés dans cette source de données.
|
operationIds[] |
string
ID des opérations de longue durée (LRO) actuellement exécutées pour ce schéma.
|
Méthodes |
|
Crée une source de données. |
|
Supprime une source de données. |
|
Permet d'obtenir une source de données. |
|
Répertorie les sources de données. |
|
Met à jour une source de données. |
|
Met à jour une source de données. |
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,["# REST Resource: settings.datasources\n\n- [Resource: DataSource](#DataSource)\n - [JSON representation](#DataSource.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: DataSource\n--------------------\n\nDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"shortName\": string, \"indexingServiceAccounts\": [ string ], \"disableServing\": boolean, \"disableModifications\": boolean, \"itemsVisibility\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal) } ], \"returnThumbnailUrls\": boolean, \"operationIds\": [ string ] } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the datasource resource. Format: datasources/{sourceId}. The name is ignored when creating a datasource. |\n| `displayName` | `string` Required. Display name of the datasource The maximum length is 300 characters. |\n| `shortName` | `string` A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *\\\u003cvalue\\\u003e* then queries like *source:\\\u003cvalue\\\u003e* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. |\n| `indexingServiceAccounts[]` | `string` List of service accounts that have indexing access. |\n| `disableServing` | `boolean` Disable serving any search or assist results. |\n| `disableModifications` | `boolean` If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. |\n| `itemsVisibility[]` | `object (`[GSuitePrincipal](/workspace/cloud-search/docs/reference/rest/v1/GSuitePrincipal)`)` This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. |\n| `returnThumbnailUrls` | `boolean` Can a user request to get thumbnail URI for Items indexed in this data source. |\n| `operationIds[]` | `string` IDs of the Long Running Operations (LROs) currently running for this schema. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------|-----------------------|\n| ### [create](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/create) | Creates a datasource. |\n| ### [delete](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/delete) | Deletes a datasource. |\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/get) | Gets a datasource. |\n| ### [list](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/list) | Lists datasources. |\n| ### [patch](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch) | Updates a datasource. |\n| ### [update](/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/update) | Updates a datasource. |"]]