Acesse e modifique a tabela dinâmica da fonte de dados. 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 |
---|---|---|
add | Pivot | Adiciona um novo grupo de colunas dinâmicas com base na coluna de origem de dados especificada. |
add | Pivot | Adiciona um novo filtro com base na coluna da fonte de dados especificada e nos critérios de filtro especificados. |
add | Pivot | Adiciona um novo valor dinâmico com base na coluna de origem de dados especificada sem nenhuma função de resumo. |
add | Pivot | Adiciona um novo valor de pivot com base na coluna de origem de dados especificada e na função de resumo especificada. |
add | Pivot | Adiciona um novo grupo de linhas de pivot com base na coluna da fonte de dados especificada. |
as | Pivot | Retorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal. |
cancel | Data | Cancela a atualização de dados associada a esse objeto se ela estiver em execução. |
force | Data | Atualiza os dados desse objeto, independentemente do estado atual. |
get | Data | Recebe a fonte de dados à qual o objeto está vinculado. |
get | Data | Recebe o status de execução de dados do objeto. |
refresh | Data | Atualiza os dados do objeto. |
wait | Data | Aguarda até a conclusão da execução atual e expira após o número de segundos fornecido. |
Documentação detalhada
add Column Group(columnName)
Adiciona um novo grupo de colunas dinâmicas com base na coluna de origem de dados especificada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | String | O nome da coluna da fonte de dados em que o grupo de pivote é baseado. |
Retornar
Pivot
: o novo grupo de pivot.
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
add Filter(columnName, filterCriteria)
Adiciona um novo filtro com base na coluna da fonte de dados especificada e nos critérios de filtro especificados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | String | O nome da coluna da fonte de dados em que o filtro se baseia. |
filter | Filter | Os critérios usados pelo filtro. |
Retornar
Pivot
: 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
add Pivot Value(columnName)
Adiciona um novo valor dinâmico com base na coluna de origem de dados especificada sem nenhuma função de resumo. Somente para medidas do Looker.
O código a seguir mostra como adicionar uma medida do Looker como um valor 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');
Esse método está disponível apenas para fontes de dados do Looker.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | String | O nome da coluna da fonte de dados em que o valor do resumo é baseado. |
Retornar
Pivot
: o novo valor do eixo.
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
add Pivot Value(columnName, summarizeFunction)
Adiciona um novo valor de pivot com base na coluna de origem de dados especificada e na função de resumo especificada.
Para adicionar valores de pivot para medidas do Looker, use add
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | String | O nome da coluna da fonte de dados em que o valor do resumo é baseado. |
summarize | Pivot | A função de resumo usada pelo valor do resumo. |
Retornar
Pivot
: o novo valor do eixo.
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
add Row Group(columnName)
Adiciona um novo grupo de linhas de pivot com base na coluna da fonte de dados especificada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | String | O nome da coluna da fonte de dados em que o grupo de pivote é baseado. |
Retornar
Pivot
: o novo grupo de pivot.
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
as Pivot Table()
Retorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.
Retornar
Pivot
: 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
cancel Data Refresh()
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 os métodos Spreadsheet
para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data
: 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
force Refresh Data()
Atualiza os dados desse objeto, independentemente do estado atual. Consulte refresh
para
mais detalhes. Se você quiser cancelar uma atualização em andamento desse objeto, consulte cancel
.
Gera uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos Spreadsheet
para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data
: 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
get Data Source()
Recebe a fonte de dados à qual o objeto está vinculado.
Retornar
Data
: 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
get Status()
Recebe o status de execução de dados do objeto.
Retornar
Data
: o 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
refresh Data()
Atualiza os dados do objeto.
Gera uma exceção se estiver no estado error
. Use Data
para atualizar a especificação. O método é
preferível a force
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 os métodos Spreadsheet
para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data
: 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
wait For Completion(timeoutInSeconds)
Aguarda até a conclusão da execução atual e expira 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
Nome | Tipo | Descrição |
---|---|---|
timeout | Integer | O tempo de espera para a execução dos dados, em segundos. O máximo é 300 segundos. |
Retornar
Data
: o 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