Class DataSourcePivotTable

DataSourcePivotTable

Accédez à un tableau croisé dynamique de source de données existant et modifiez-le. Pour créer un tableau croisé dynamique de source de données, utilisez Range.createDataSourcePivotTable(dataSource).

N'utilisez cette classe qu'avec des données connectées à une base de données.

Méthodes

MéthodeType renvoyéBrève description
addColumnGroup(columnName)PivotGroupAjoute un groupe de colonnes croisées en fonction de la colonne de source de données spécifiée.
addFilter(columnName, filterCriteria)PivotFilterAjoute un filtre basé sur la colonne de source de données spécifiée avec les critères de filtre spécifiés.
addPivotValue(columnName)PivotValueAjoute une valeur de tableau croisé dynamique basée sur la colonne de source de données spécifiée, sans fonction de récapitulation.
addPivotValue(columnName, summarizeFunction)PivotValueAjoute une valeur de tableau croisé dynamique en fonction de la colonne de source de données spécifiée avec la fonction de récapitulation spécifiée.
addRowGroup(columnName)PivotGroupAjoute un groupe de lignes croisées en fonction de la colonne de source de données spécifiée.
asPivotTable()PivotTableRenvoie le tableau croisé dynamique de la source de données sous la forme d'un tableau croisé dynamique standard.
cancelDataRefresh()DataSourcePivotTableAnnule l'actualisation des données associée à cet objet si elle est en cours.
forceRefreshData()DataSourcePivotTableActualise les données de cet objet, quel que soit l'état actuel.
getDataSource()DataSourceObtient la source de données à laquelle l'objet est associé.
getStatus()DataExecutionStatusObtient l'état d'exécution des données de l'objet.
refreshData()DataSourcePivotTableActualise les données de l'objet.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttend la fin de l'exécution actuelle, avec un délai d'inactivité après le nombre de secondes indiqué.

Documentation détaillée

addColumnGroup(columnName)

Ajoute un groupe de colonnes croisées en fonction de la colonne de source de données spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données sur laquelle repose le groupe de tableaux croisés dynamiques.

Renvois

PivotGroup : nouveau groupe de tableaux croisés dynamiques.

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

addFilter(columnName, filterCriteria)

Ajoute un filtre basé sur la colonne de source de données spécifiée avec les critères de filtre spécifiés.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données sur laquelle le filtre est basé.
filterCriteriaFilterCriteriaCritères utilisés par le filtre.

Renvois

PivotFilter : le nouveau filtre.

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

addPivotValue(columnName)

Ajoute une valeur de tableau croisé dynamique basée sur la colonne de source de données spécifiée, sans fonction de récapitulation. Pour les mesures Looker uniquement.

Le code suivant montre comment ajouter une mesure Looker en tant que valeur de tableau croisé dynamique.

// TODO(developer): Replace with your spreadsheet ID which has a Looker data
// source.
const spreadsheet = SpreadsheetApp.openById('abcd1234');
const datasource = spreadsheet.getDataSources()[0];
const pivotTable = datasource.createDataSourcePivotTableOnNewSheet();

pivotTable.addPivotValue('columnName');

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

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données sur laquelle la valeur du tableau croisé dynamique est basée.

Renvois

PivotValue : nouvelle valeur du tableau croisé dynamique.

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

addPivotValue(columnName, summarizeFunction)

Ajoute une valeur de tableau croisé dynamique en fonction de la colonne de source de données spécifiée avec la fonction de récapitulation spécifiée.

Pour ajouter des valeurs de tableau croisé dynamique pour les mesures Looker, utilisez addPivotValue(columnName).

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données sur laquelle la valeur du tableau croisé dynamique est basée.
summarizeFunctionPivotTableSummarizeFunctionFonction de synthèse utilisée par la valeur du tableau croisé dynamique.

Renvois

PivotValue : nouvelle valeur du tableau croisé dynamique.

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

addRowGroup(columnName)

Ajoute un groupe de lignes croisées en fonction de la colonne de source de données spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données sur laquelle repose le groupe de tableaux croisés dynamiques.

Renvois

PivotGroup : nouveau groupe de tableaux croisés dynamiques.

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

asPivotTable()

Renvoie le tableau croisé dynamique de la source de données sous la forme d'un tableau croisé dynamique standard.

Renvois

PivotTable : le tableau croisé dynamique.

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

cancelDataRefresh()

Annule l'actualisation des données associée à cet objet si elle est en cours.

Cet exemple montre comment annuler l'actualisation d'une formule.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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 un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet 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

forceRefreshData()

Actualise les données de cet objet, quel que soit l'état actuel. Pour en savoir plus, consultez refreshData(). Si vous souhaitez annuler l'actualisation en cours de cet objet, consultez cancelDataRefresh().

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 un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet 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

getDataSource()

Obtient la source de données à laquelle l'objet est associé.

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

getStatus()

Obtient l'état d'exécution des données de l'objet.

Renvois

DataExecutionStatus : état d'exécution des 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

refreshData()

Actualise les données de l'objet.

Génère une exception si l'état actuel est error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. Cette méthode est préférable à forceRefreshData() pour éviter toute modification inattendue de 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 un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet 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

waitForCompletion(timeoutInSeconds)

Attend la fin de l'exécution actuelle, avec un délai d'inactivité après le nombre de secondes indiqué. Génère une exception si l'exécution n'est pas terminée au moment du délai d'expiration, mais n'annule pas l'exécution des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerTemps d'attente pour l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Renvois

DataExecutionStatus : état d'exécution des 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