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

Class DataSource

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

N'utilisez cette classe qu'avec des 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 dans la source de données.
`getColumns()`	`DataSourceColumn[]`	Renvoie toutes les colonnes de la source de données.
`getDataSourceSheets()`	`DataSourceSheet[]`	Affiche les feuilles de la 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 la `data source sheets` associée avec la nouvelle spécification.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Attend la fin de toutes les exécutions en cours des objets de source de données associés et expirent au bout du nombre de secondes spécifié.

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 toutes les actualisations d'une source de données.

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

Une exception est générée 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 associée à 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.

Paramètres

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

Renvois

DataSourceColumn : colonne de calcul que vous venez de créer.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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. Par ailleurs, elle fait de la nouvelle feuille la feuille active.

Renvois

DataSourcePivotTable : nouveau tableau croisé dynamique de la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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. Par conséquent, fait de la nouvelle feuille la feuille active.

Renvois

DataSourceTable : nouvelle table de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 de calcul à obtenir.

Renvois

DataSourceColumn : colonne de calcul correspondant au nom de la colonne ou null s'il n'existe aucune colonne de calcul de ce type.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 dans la source de données.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à un ou plusieurs des champs d'application suivants:

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

`getDataSourceSheets()`

Affiche les feuilles de la 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 associée à 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 associée à 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 associée à 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.

Paramètres

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

Renvois

DataSource : source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 la data source sheets associée avec la nouvelle spécification.

Paramètres

Nom	Type	Description
`spec`	`DataSourceSpec`	Spécification de la source de données à utiliser pour la mise à 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 associée à un ou plusieurs des champs d'application suivants:

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

Attend la fin de toutes les exécutions en cours des objets de source de données associés et expirent au bout du nombre de secondes spécifié. La génération d'une exception si les exécutions ne sont pas terminées lorsque le délai expire, mais elle n'annule pas les exécutions des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Délai d'attente des exécutions des données, en secondes. La valeur maximale est de 300 secondes.

Autorisation

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

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