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

Class DataSourcePivotTable

Accédez au 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éthode	Type renvoyé	Brève description
`addColumnGroup(columnName)`	`PivotGroup`	Ajoute un nouveau groupe de colonnes de tableau croisé dynamique en fonction de la colonne de source de données spécifiée.
`addFilter(columnName, filterCriteria)`	`PivotFilter`	Ajoute 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, summarizeFunction)`	`PivotValue`	Ajoute une nouvelle valeur de tableau croisé dynamique basée sur la colonne de source de données spécifiée avec le résumé spécifié. .
`addRowGroup(columnName)`	`PivotGroup`	Ajoute un nouveau groupe de lignes de tableau croisé dynamique en fonction de la colonne de source de données spécifiée.
`asPivotTable()`	`PivotTable`	Renvoie le tableau croisé dynamique de 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 s'il est en cours d'exécution.
`forceRefreshData()`	`DataSourcePivotTable`	Actualise les données de cet objet quel que soit l'état actuel.
`getDataSource()`	`DataSource`	Récupère 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 et expire après le nombre de secondes indiqué.

Documentation détaillée

`addColumnGroup(columnName)`

Ajoute un nouveau groupe de colonnes de tableau croisé dynamique en fonction de la colonne de 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 lequel le groupe de tableaux croisés dynamiques est basé.

Renvois

PivotGroup : nouveau groupe de tableaux croisés dynamiques.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 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 source de données sur lequel 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 correspondant à 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 nouvelle valeur de tableau croisé dynamique basée sur la colonne de source de données spécifiée avec le résumé spécifié. .

Paramètres

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

Renvois

PivotValue : nouvelle valeur de tableau croisé dynamique.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 nouveau groupe de lignes de tableau croisé dynamique en fonction de la colonne de 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 lequel le groupe de tableaux croisés dynamiques est basé.

Renvois

PivotGroup : nouveau groupe de tableaux croisés dynamiques.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 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 correspondant à 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 s'il est en cours d'exécution.

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

La fonction renvoie une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourcePivotTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. Consultez les refreshData() pour plus de détails. Si vous souhaitez annuler l'actualisation de cet objet en cours, consultez cancelDataRefresh().

Renvois

DataSourcePivotTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

`getDataSource()`

Récupère 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 correspondant à 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 correspondant à 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.

La fonction renvoie 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 des modifications inattendues de la source de données.

Renvois

DataSourcePivotTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 et expire après le nombre de secondes indiqué. La fonction renvoie une exception si l'exécution n'est pas terminée à l'expiration du délai, mais n'annule pas la l'exécution des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Délai d'attente de l'exécution des données, en secondes. Le maximum 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 correspondant à un ou plusieurs des champs d'application suivants:

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