Class DataSource

DonnéesSource

Accédez à une 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éthodeType renvoyéBrève description
cancelAllLinkedDataSourceObjectRefreshes()voidAnnule toutes les actualisations en cours des objets de source de données associés à cette source de données.
createCalculatedColumn(name, formula)DataSourceColumnCrée une colonne calculée.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCré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()DataSourceTableCrée une table de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille.
getCalculatedColumnByName(columnName)DataSourceColumn|nullRenvoie la colonne calculée de la source de données qui correspond au nom de 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()DataSourceSpecObtient la spécification de la source de données.
refreshAllLinkedDataSourceObjects()voidActualise tous les objets de source de données associés à la source de données.
updateSpec(spec)DataSourceMet à 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)DataSourceMet à jour la spécification de la source de données et actualise le data source sheets associé avec la nouvelle spécification.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttend que toutes les exécutions actuelles des objets de source de données associée soient terminées, avec un délai d'expiration 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 toutes 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 scopes suivants :

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

createCalculatedColumn(name, formula)

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

Paramètres

NomTypeDescription
nameStringNom de la colonne calculée.
formulaStringFormule de la colonne de calcul.

Renvois

DataSourceColumn : colonne de calcul nouvellement créée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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, 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 scopes suivants :

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

createDataSourceTableOnNewSheet()

Crée une table de source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille. Par ailleurs, 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 source de données nouvellement créée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getCalculatedColumnByName(columnName)

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

Paramètres

NomTypeDescription
columnNameStringNom de la colonne calculée à obtenir.

Renvois

DataSourceColumn|null : colonne calculée correspondant au nom de la colonne ou null si aucune colonne calculée de ce type n'existe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 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 scopes 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 scopes 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 source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getSpec()

Obtient 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 scopes 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.

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 scopes 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 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.

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

NomTypeDescription
specDataSourceSpecSpé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 scopes 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 le data source sheets associé avec la nouvelle spécification.

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.

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

NomTypeDescription
specDataSourceSpecSpécification de la source de données à mettre à jour.
refreshAllLinkedObjectsBooleanSi 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 scopes suivants :

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Attend que toutes les exécutions actuelles des objets de source de données associée soient terminées, avec un délai d'expiration après le nombre de secondes indiqué. Génère une exception si les exécutions ne sont pas terminées lorsque le délai expire, mais n'annule pas les exécutions de données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerTemps d'attente pour les exécutions de 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 scopes suivants :

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