Class DataSource

Source de données

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.

Utilisez cette classe uniquement avec les données connectées à une base de données.

Méthodes

MéthodeType renvoyéBrève description
createCalculatedColumn(name, formula)DataSourceColumnCrée une colonne de calcul.
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)DataSourceColumnRenvoie 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[]Affiche les feuilles de source de données associées à cette source de données.
getSpec()DataSourceSpecRécupère 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 la data source sheets associée avec la nouvelle spécification.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttend que toutes les exécutions actuelles des objets de la source de données associée soient terminées. Le délai expire après le nombre de secondes fourni.

Documentation détaillée

createCalculatedColumn(name, formula)

Crée une colonne de calcul.

Paramètres

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

Aller-retour

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

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. La nouvelle feuille devient alors la feuille active.

Aller-retour

DataSourcePivotTable : tableau croisé dynamique nouvellement créé pour 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

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. La nouvelle feuille devient alors la feuille active.

Aller-retour

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

NomTypeDescription
columnNameStringNom de la colonne calculée à obtenir.

Aller-retour

DataSourceColumn : colonne calculée correspondant au nom de la colonne, ou null en l'absence de colonne calculé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

getCalculatedColumns()

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

Aller-retour

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

Aller-retour

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()

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

Aller-retour

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.

Aller-retour

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.

Lève une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'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

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.

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

Paramètres

NomTypeDescription
specDataSourceSpecSpécification de source de données à mettre à jour.

Aller-retour

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 la data source sheets associée avec la nouvelle spécification.

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

Paramètres

NomTypeDescription
specDataSourceSpecSpécification de source de données à mettre à jour.
refreshAllLinkedObjectsBooleanSi la valeur est true, actualise également tous les objets de source de données associés à cette source de données.

Aller-retour

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 actuelles des objets de la source de données associée soient terminées. Le délai expire après le nombre de secondes fourni. Lève 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 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