Class DataSourcePivotTable

DataSourcePivotTable

Acessar e modificar a tabela dinâmica da fonte de dados. Para criar uma 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étodoTipo de retornoBreve descrição
addColumnGroup(columnName)PivotGroupAdiciona um novo grupo de colunas dinâmicas com base na coluna especificada da fonte de dados.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um filtro com base na coluna especificada da fonte de dados e nos critérios de filtro especificados.
addPivotValue(columnName)PivotValueAdiciona um novo valor dinâmico com base na coluna especificada da fonte de dados sem uma função de resumo.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor de representação dinâmica com base na coluna da fonte de dados especificada e na função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas de tabela dinâmica com base na coluna especificada da fonte de dados.
asPivotTable()PivotTableRetorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica comum.
cancelDataRefresh()DataSourcePivotTableCancela a atualização de dados associada a esse objeto, se ela estiver em execução.
forceRefreshData()DataSourcePivotTableAtualiza os dados desse objeto, independente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite 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 especificada da fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados em que o grupo de indicadores dinâmicos se baseia.

Retornar

PivotGroup: o novo grupo de indicadores.

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 filtro com base na coluna especificada da fonte de dados e nos critérios de filtro especificados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados em que o filtro se baseia.
filterCriteriaFilterCriteriaOs critérios usados pelo filtro.

Retornar

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)

Adiciona um novo valor dinâmico com base na coluna especificada da fonte de dados sem uma função de resumo. Somente para medidas do Looker.

O código a seguir mostra como adicionar uma métrica do Looker como um valor de pivô. 

// 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');

Esse método só está disponível para fontes de dados do Looker.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados em que o valor de pivô se baseia.

Retornar

PivotValue: o novo valor de pivô.

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 de representação dinâmica com base na coluna da fonte de dados especificada e na função de resumo especificada.

Para adicionar valores de rotação às medidas do Looker, use addPivotValue(columnName).

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados em que o valor de pivô se baseia.
summarizeFunctionPivotTableSummarizeFunctionA função de resumo usada pelo valor de pivô.

Retornar

PivotValue: o novo valor de pivô.

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 de tabela dinâmica com base na coluna especificada da fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados em que o grupo de indicadores dinâmicos se baseia.

Retornar

PivotGroup: o novo grupo de indicadores.

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 da fonte de dados como um objeto de tabela dinâmica comum.

Retornar

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

cancelDataRefresh()

Cancela a atualização de dados associada a esse objeto, se ela estiver em execução.

Este exemplo mostra como cancelar uma atualização de fórmula. 

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

Gera uma exceção se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Retornar

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

forceRefreshData()

Atualiza os dados desse objeto, independente do estado atual. Consulte refreshData() para mais detalhes. Se quiser cancelar uma atualização em andamento desse objeto, consulte cancelDataRefresh().

Gera uma exceção se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Retornar

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 a que o objeto está vinculado.

Retornar

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.

Retornar

DataExecutionStatus: o status da execução 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

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 é preferível a forceRefreshData() para evitar edições inesperadas na fonte de dados.

Gera uma exceção se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Retornar

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)

Aguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido. Gera uma exceção se a execução não for concluída quando o tempo limite expirar, mas não cancela a execução de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerO tempo de espera para a execução de dados, em segundos. O máximo é 300 segundos.

Retornar

DataExecutionStatus: o status da execução 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