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

Class DataSourcePivotTable

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

N'utilisez cette classe que pour les données connectées à une base de données.

Méthodes

Méthode	Type renvoyé	Brève description
`addColumnGroup(columnName)`	`PivotGroup`	Ajoute un groupe de colonnes de tableau croisé dynamique en fonction de la colonne de la source de données spécifiée.
`addFilter(columnName, filterCriteria)`	`PivotFilter`	Ajoute un filtre basé sur la colonne de la source de données spécifiée avec les critères de filtre spécifiés.
`addPivotValue(columnName)`	`PivotValue`	Ajoute une valeur de tableau croisé dynamique basée sur la colonne de la source de données spécifiée sans fonction de récapitulatif.
`addPivotValue(columnName, summarizeFunction)`	`PivotValue`	Ajoute une valeur de tableau croisé dynamique basée sur la colonne de la source de données spécifiée avec la fonction de récapitulation spécifiée.
`addRowGroup(columnName)`	`PivotGroup`	Ajoute un groupe de lignes de tableau croisé dynamique en fonction de la colonne de la source de données spécifiée.
`asPivotTable()`	`PivotTable`	Renvoie le tableau croisé dynamique de la source de données en tant qu'objet de tableau croisé dynamique standard.
`cancelDataRefresh()`	`DataSourcePivotTable`	Annule l'actualisation des données associée à cet objet si elle est en cours.
`forceRefreshData()`	`DataSourcePivotTable`	Actualise les données de cet objet, quel que soit l'état actuel.
`getDataSource()`	`DataSource`	Obtient la source de données à laquelle l'objet est associé.
`getStatus()`	`DataExecutionStatus`	Récupère l'état d'exécution des données de l'objet.
`refreshData()`	`DataSourcePivotTable`	Actualise les données de l'objet.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Attend la fin de l'exécution en cours, avec un délai d'inactivité de 30 secondes.

Documentation détaillée

`addColumnGroup(columnName)`

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

Paramètres

Nom	Type	Description
`columnName`	`String`	Nom de la colonne de la source de données sur laquelle le groupe croisé dynamique est basé.

Renvois

PivotGroup : nouveau groupe croisé dynamique.

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

`addFilter(columnName, filterCriteria)`

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

Paramètres

Nom	Type	Description
`columnName`	`String`	Nom de la colonne de la source de données sur laquelle le filtre est basé.
`filterCriteria`	`FilterCriteria`	Critères utilisés par le filtre.

Renvois

PivotFilter : nouveau filtre.

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

`addPivotValue(columnName)`

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

Le code suivant montre comment ajouter une mesure Looker en tant que valeur de pivot.

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

Nom	Type	Description
`columnName`	`String`	Nom 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 pivot.

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

`addPivotValue(columnName, summarizeFunction)`

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

Pour ajouter des valeurs pivot pour les mesures Looker, utilisez addPivotValue(columnName).

Paramètres

Nom	Type	Description
`columnName`	`String`	Nom de la colonne de la source de données sur laquelle la valeur du tableau croisé dynamique est basée.
`summarizeFunction`	`PivotTableSummarizeFunction`	Fonction de récapitulation utilisée par la valeur du pivot.

Renvois

PivotValue : nouvelle valeur du pivot.

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

`addRowGroup(columnName)`

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

Paramètres

Nom	Type	Description
`columnName`	`String`	Nom de la colonne de la source de données sur laquelle le groupe croisé dynamique est basé.

Renvois

PivotGroup : nouveau groupe croisé dynamique.

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

`asPivotTable()`

Renvoie le tableau croisé dynamique de la source de données en tant qu'objet de tableau croisé dynamique standard.

Renvois

PivotTable : tableau croisé dynamique.

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

`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 champs d'application 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 une actualisation en cours de cet objet, consultez cancelDataRefresh().

Renvois

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

`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 champs d'application suivants:

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

`getStatus()`

Récupère 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 champs d'application 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. La méthode est préférable à forceRefreshData() pour éviter les modifications inattendues sur la source de données.

Renvois

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

`waitForCompletion(timeoutInSeconds)`

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

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Temps d'attente de 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 champs d'application suivants:

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