Acessar e modificar a fonte de dados atual. Para criar uma tabela de fonte de dados com uma nova fonte, consulte DataSourceTable
.
Use essa classe apenas com dados conectados a um banco de dados.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createCalculatedColumn(name, formula) | DataSourceColumn | Cria uma coluna calculada. |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | Cria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página. |
createDataSourceTableOnNewSheet() | DataSourceTable | Cria uma tabela de fonte de dados com base nessa fonte de dados na primeira célula de uma nova planilha. |
getCalculatedColumnByName(columnName) | DataSourceColumn | Retorna a coluna calculada na fonte de dados que corresponde ao nome da coluna. |
getCalculatedColumns() | DataSourceColumn[] | Retorna todas as colunas calculadas na fonte de dados. |
getColumns() | DataSourceColumn[] | Retorna todas as colunas na fonte de dados. |
getDataSourceSheets() | DataSourceSheet[] | Retorna as páginas da fonte de dados associadas a essa fonte. |
getSpec() | DataSourceSpec | Recebe a especificação da fonte de dados. |
refreshAllLinkedDataSourceObjects() | void | Atualiza todos os objetos da fonte de dados vinculados a ela. |
updateSpec(spec) | DataSource | Atualiza a especificação da fonte de dados e atualiza os objetos vinculados a essa fonte com a nova especificação. |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | Atualiza a especificação da fonte de dados e o data
source sheets vinculado com a nova especificação. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda até que todas as execuções atuais dos objetos da fonte de dados vinculados sejam concluídas, expirando após o número de segundos fornecido. |
Documentação detalhada
createCalculatedColumn(name, formula)
Cria uma coluna calculada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O nome da coluna calculada. |
formula | String | A fórmula da coluna calculada. |
Retorno
DataSourceColumn
: a coluna calculada recém-criada.
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
createDataSourcePivotTableOnNewSheet()
Cria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página. Como efeito colateral, torna a nova página a ativa.
Retorno
DataSourcePivotTable
: a tabela dinâmica de fonte de dados recém-criada.
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
createDataSourceTableOnNewSheet()
Cria uma tabela de fonte de dados com base nessa fonte de dados na primeira célula de uma nova planilha. Como efeito colateral, transforma a nova página em ativa.
Retorno
DataSourceTable
: a tabela de fonte de dados recém-criada.
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
getCalculatedColumnByName(columnName)
Retorna a coluna calculada na fonte de dados que corresponde ao nome da coluna.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnName | String | O nome da coluna calculada a ser obtida. |
Retorno
DataSourceColumn
: a coluna calculada que corresponde ao nome da coluna ou null
se não houver essa coluna.
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
getCalculatedColumns()
Retorna todas as colunas calculadas na fonte de dados.
Retorno
DataSourceColumn[]
: uma matriz de todas as colunas calculadas na 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
getColumns()
Retorna todas as colunas na fonte de dados.
Retorno
DataSourceColumn[]
: uma matriz de todas as DataSourceColumn
na 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
getDataSourceSheets()
Retorna as páginas da fonte de dados associadas a essa fonte.
Retorno
DataSourceSheet[]
: uma matriz de páginas de 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
getSpec()
Recebe a especificação da fonte de dados.
Retorno
DataSourceSpec
: a especificação da 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
refreshAllLinkedDataSourceObjects()
Atualiza todos os objetos da fonte de dados vinculados a ela.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution()
para ativar a execução de dados para o tipo específico de 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
updateSpec(spec)
Atualiza a especificação da fonte de dados e atualiza os objetos vinculados a essa fonte com a nova especificação.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution()
para ativar a execução de dados para o tipo específico de fonte de dados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
spec | DataSourceSpec | A especificação da fonte de dados a ser usada para atualizar. |
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
updateSpec(spec, refreshAllLinkedObjects)
Atualiza a especificação da fonte de dados e o data
source sheets
vinculado com a nova especificação.
Lança uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos SpreadsheetApp#enable...Execution()
para ativar a execução de dados para o tipo específico de fonte de dados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
spec | DataSourceSpec | A especificação da fonte de dados a ser usada para atualizar. |
refreshAllLinkedObjects | Boolean | Se for true , também atualiza todos os objetos da fonte de dados
vinculados a essa fonte. |
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
waitForAllDataExecutionsCompletion(timeoutInSeconds)
Aguarda até que todas as execuções atuais dos objetos da fonte de dados vinculados sejam concluídas, expirando após o número de segundos fornecido. Gera uma exceção se as execuções não são concluídas quando o tempo limite é atingido, mas não cancela as execuções de dados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
timeoutInSeconds | Integer | O tempo de espera por execuções de dados, em segundos. O máximo é de 300 segundos. |
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