Class DataSourcePivotTable

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
DataSourcePivotTable

Acessar e modificar a tabela dinâmica de fonte de dados existente Para criar uma nova tabela dinâmica de fonte de dados, use Range.createDataSourcePivotTable(dataSource). Use essa classe apenas com os dados que estão 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 de fonte de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica de fonte de dados como um objeto normal da tabela dinâmica.
forceRefreshData()DataSourcePivotTableAtualiza os dados deste objeto, independentemente do estado atual.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

Documentação detalhada

addColumnGroup(columnName)

Adiciona um novo grupo de colunas dinâmicas com base na coluna de fonte de dados especificada.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna de origem de dados em que o grupo dinâmico se baseia.

Retornar

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

NomeTipoDescrição
columnNameStringO nome da coluna de dados baseado no filtro.
filterCriteriaFilterCriteriaSão os 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, summarizeFunction)

Adiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função de resumo especificada.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna de origem de dados em que o valor dinâmico é baseado.
summarizeFunctionPivotTableSummarizeFunctionA função de resumo que o valor de tabela dinâmica usa.

Retornar

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

NomeTipoDescrição
columnNameStringO nome da coluna de origem de dados em que o grupo dinâmico se baseia.

Retornar

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 normal da tabela dinâmica.

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

forceRefreshData()

Atualiza os dados deste objeto, independentemente do estado atual. Consulte refreshData() para ver mais detalhes.

Uma exceção vai ser gerada 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()

Acessa a fonte de dados vinculada ao objeto.

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

Acessa 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.

Lança uma exceção se estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método tem preferência sobre forceRefreshData() para evitar edições inesperadas na fonte de dados.

Uma exceção vai ser gerada 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)

Aguarda até que a execução atual seja concluída, expirando após o número de segundos informado. Emite uma exceção se a execução não é concluída ao expirar, mas não cancela a execução de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerTempo de espera da execução de dados, em segundos. O máximo é de 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