Cette page a été traduite par l'API Cloud Translation.

Class DataSource

Accéder à une source de données existante et la modifier Pour créer une table de source de données avec une nouvelle source de données, consultez DataSourceTable.

N'utilisez cette classe que pour les données connectées à une base de données.

Méthodes

Méthode	Type renvoyé	Brève description
`cancelAllLinkedDataSourceObjectRefreshes()`	`void`	Annule toutes les actualisations en cours des objets de source de données associés à cette source de données.
`createCalculatedColumn(name, formula)`	`DataSourceColumn`	Crée une colonne de calcul.
`createDataSourcePivotTableOnNewSheet()`	`DataSourcePivotTable`	Crée un tableau croisé dynamique de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille.
`createDataSourceTableOnNewSheet()`	`DataSourceTable`	Crée un tableau de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille.
`getCalculatedColumnByName(columnName)`	`DataSourceColumn`	Renvoie la colonne calculée dans la source de données qui correspond au nom de la colonne.
`getCalculatedColumns()`	`DataSourceColumn[]`	Renvoie toutes les colonnes calculées de la source de données.
`getColumns()`	`DataSourceColumn[]`	Renvoie toutes les colonnes de la source de données.
`getDataSourceSheets()`	`DataSourceSheet[]`	Renvoie les feuilles de source de données associées à cette source de données.
`getSpec()`	`DataSourceSpec`	Récupère la spécification de la source de données.
`refreshAllLinkedDataSourceObjects()`	`void`	Actualise tous les objets de source de données associés à la source de données.
`updateSpec(spec)`	`DataSource`	Met à jour la spécification de la source de données et actualise les objets de source de données associés à cette source de données avec la nouvelle spécification.
`updateSpec(spec, refreshAllLinkedObjects)`	`DataSource`	Met à jour la spécification de la source de données et actualise l'`data source sheets` associée avec la nouvelle spécification.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Attend que toutes les exécutions en cours des objets de source de données associés soient terminées, et expire après le nombre de secondes indiqué.

Documentation détaillée

`cancelAllLinkedDataSourceObjectRefreshes()`

Annule toutes les actualisations en cours des objets de source de données associés à cette source de données.

Cet exemple montre comment annuler tous les actualisations d'une source de données.

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour le type de source de données spécifique.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`createCalculatedColumn(name, formula)`

Crée une colonne de calcul. Cette méthode n'est disponible que pour les sources de données BigQuery.

Paramètres

Nom	Type	Description
`name`	`String`	Nom de la colonne calculée.
`formula`	`String`	Formule de la colonne de calcul.

Renvois

DataSourceColumn : colonne de calcul créée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`createDataSourcePivotTableOnNewSheet()`

Crée un tableau croisé dynamique de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille. En tant qu'effet secondaire, la nouvelle feuille devient la feuille active.

Renvois

DataSourcePivotTable : tableau croisé dynamique de la source de données nouvellement créée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`createDataSourceTableOnNewSheet()`

Crée un tableau de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille. En conséquence, la nouvelle feuille devient la feuille active.

Cette méthode n'est disponible que pour les sources de données BigQuery.

Renvois

DataSourceTable : table de la source de données nouvellement créée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getCalculatedColumnByName(columnName)`

Renvoie la colonne calculée dans la source de données qui correspond au nom de la colonne.

Paramètres

Nom	Type	Description
`columnName`	`String`	Nom de la colonne calculée à obtenir.

Renvois

DataSourceColumn : colonne calculée correspondant au nom de la colonne, ou null si aucune colonne calculée ne correspond.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getCalculatedColumns()`

Renvoie toutes les colonnes calculées de la source de données.

Les spécifications de la source de données de type DataSourceType.LOOKER renvoient un tableau vide.

Renvois

DataSourceColumn[] : tableau de toutes les colonnes calculées de la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getColumns()`

Renvoie toutes les colonnes de la source de données.

Renvois

DataSourceColumn[] : tableau de tous les DataSourceColumn de la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDataSourceSheets()`

Renvoie les feuilles de source de données associées à cette source de données.

Renvois

DataSourceSheet[] : tableau de feuilles de sources de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSpec()`

Récupère la spécification de la source de données.

Renvois

DataSourceSpec : spécification de la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`refreshAllLinkedDataSourceObjects()`

Actualise tous les objets de source de données associés à la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`updateSpec(spec)`

Met à jour la spécification de la source de données et actualise les objets de source de données associés à cette source de données avec la nouvelle spécification.

Génère une exception si le type de spécification de la source de données est différent du type de source de données actuel.

Paramètres

Nom	Type	Description
`spec`	`DataSourceSpec`	Spécification de la source de données à mettre à jour.

Renvois

DataSource : source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`updateSpec(spec, refreshAllLinkedObjects)`

Met à jour la spécification de la source de données et actualise l'data source sheets associée avec la nouvelle spécification.

Génère une exception si le type de spécification de la source de données est différent du type de source de données actuel.

Paramètres

Nom	Type	Description
`spec`	`DataSourceSpec`	Spécification de la source de données à mettre à jour.
`refreshAllLinkedObjects`	`Boolean`	Si la valeur est `true`, tous les objets de source de données associés à cette source de données sont également actualisés.

Renvois

DataSource : source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

Attend que toutes les exécutions en cours des objets de source de données associés soient terminées, et expire après le nombre de secondes indiqué. Génère une exception si les exécutions ne sont pas terminées à l'expiration du délai, mais n'annule pas les exécutions des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Durée d'attente pour l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets