Acessar e modificar a tabela dinâmica de fonte de dados atual. Para criar uma nova tabela dinâmica de fonte de dados, use Range.createDataSourcePivotTable(dataSource).
Use essa classe apenas com dados conectados a um banco de dados.
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
addColumnGroup(columnName) | PivotGroup | Adiciona um novo grupo de colunas dinâmicas com base na coluna de fonte de dados especificada. |
addFilter(columnName, filterCriteria) | PivotFilter | Adiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados. |
addPivotValue(columnName, summarizeFunction) | PivotValue | Adiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função summarize especificada. |
addRowGroup(columnName) | PivotGroup | Adiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada. |
asPivotTable() | PivotTable | Retorna a tabela dinâmica de fonte de dados como um objeto de tabela dinâmica normal. |
forceRefreshData() | DataSourcePivotTable | Atualiza os dados desse objeto, independentemente do estado atual. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
refreshData() | DataSourcePivotTable | Atualiza os dados do objeto. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
Documentação detalhada
addColumnGroup(columnName)
Adiciona um novo grupo de colunas dinâmicas com base na coluna de fonte de dados especificada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | O nome da coluna de origem de dados em que o grupo dinâmico se baseia. |
Retorno
PivotGroup: o novo grupo dinâmico.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Adiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | O nome da coluna de origem dos dados em que o filtro é baseado. |
filterCriteria | FilterCriteria | Os critérios usados pelo filtro. |
Retorno
PivotFilter: o novo filtro.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addPivotValue(columnName, summarizeFunction)
Adiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função summarize especificada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | O nome da coluna de origem de dados em que o valor dinâmico é baseado. |
summarizeFunction | PivotTableSummarizeFunction | A função summarize que o valor dinâmico usa. |
Retorno
PivotValue: o novo valor dinâmico.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
addRowGroup(columnName)
Adiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | O nome da coluna de origem de dados em que o grupo dinâmico se baseia. |
Retorno
PivotGroup: o novo grupo dinâmico.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
asPivotTable()
Retorna a tabela dinâmica de fonte de dados como um objeto de tabela dinâmica normal.
Retorno
PivotTable: a tabela dinâmica.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Atualiza os dados desse objeto, independentemente do estado atual. Consulte refreshData() para
mais detalhes.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() a fim de ativar a execução de dados para um tipo específico de fonte.
Retorno
DataSourcePivotTable: o objeto de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Recebe a fonte de dados à qual o objeto está vinculado.
Retorno
DataSource: a fonte de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getStatus()
Recebe o status de execução de dados do objeto.
Retorno
DataExecutionStatus — status de execução dos dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
refreshData()
Atualiza os dados do objeto.
Gera uma exceção se estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método tem preferência em relação a forceRefreshData() para evitar edições inesperadas na fonte de dados.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution() a fim de ativar a execução de dados para um tipo específico de fonte.
Retorno
DataSourcePivotTable: o objeto de dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. Gera uma exceção quando a execução não é concluída quando o tempo limite é atingido, mas não cancela a execução dos dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
timeoutInSeconds | Integer | O tempo de espera pela execução dos dados, em segundos. O máximo é de 300 segundos. |
Retorno
DataExecutionStatus — status de execução dos dados.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets