Class DataSource

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 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 d'une source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille.
createDataSourceTableOnNewSheet()DataSourceTableCré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)DataSourceColumnRenvoie la colonne calculée dans la source de données qui correspond au nom de la colonne.
getCalculatedColumns()DataSourceColumn[]Renvoie toutes les colonnes de calcul de 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()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)DataSourceLa spécification de la source de données est mise à jour, et le data source sheets associé est actualisé en fonction de la nouvelle spécification.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttend que toutes les exécutions en cours des objets de source de données associés soient terminées et expirent 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 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 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 d'une source de données à partir de cette source de données dans la première cellule d'une nouvelle feuille. L'effet secondaire 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. En conséquence, la nouvelle feuille devient la feuille active.

Renvois

DataSourceTable : nouvelle table de source de données créée.

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

NomTypeDescription
columnNameStringNom 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 de calcul de la source de données.

Renvois

DataSourceColumn[] : tableau de toutes les colonnes de calcul 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

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

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.

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

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.

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

La spécification de la source de données est mise à jour, et le data source sheets associé est actualisé en fonction de 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.

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 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 que toutes les exécutions en cours des objets de source de données associés soient terminées et expirent après le nombre de secondes fourni. La fonction renvoie une exception si les exécutions ne se terminent pas lorsque le délai expire, mais n'annule pas les exécutions des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerDé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