Acesse e modifique a fonte de dados existente. Para criar uma tabela de fonte de dados com uma nova fonte de dados, consulte DataSourceTable
.
Use essa classe apenas com os dados que estão 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 na fonte de dados na primeira célula de uma nova página. |
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 da fonte de dados. |
getDataSourceSheets() | DataSourceSheet[] | Retorna as planilhas de fonte de dados associadas a esta 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 da fonte vinculados a essa fonte com a nova especificação. |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | Atualiza a especificação da fonte de dados e atualiza o data
source sheets vinculado com a nova especificação. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda a conclusão de todas as execuções atuais dos objetos da fonte de dados vinculada, o que expira após o número de segundos informado. |
Documentação detalhada
createCalculatedColumn(name, formula)
Cria uma coluna calculada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | Nome da coluna calculada. |
formula | String | A fórmula da coluna calculada. |
Retornar
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.
Retornar
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 na fonte de dados na primeira célula de uma nova página. Como efeito colateral, torna a nova página a ativa.
Retornar
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 | Nome da coluna calculada a ser recebida. |
Retornar
DataSourceColumn
: a coluna calculada que corresponde ao nome da coluna, ou null
se não houver coluna calculada.
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.
Retornar
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 da fonte de dados.
Retornar
DataSourceColumn[]
: uma matriz de todos os 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 planilhas de fonte de dados associadas a esta fonte.
Retornar
DataSourceSheet[]
: uma matriz de páginas de origem 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.
Retornar
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.
Uma exceção vai ser gerada 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 dos 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 da fonte vinculados a essa fonte com a nova especificação.
Uma exceção vai ser gerada 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 dos 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 que será atualizada. |
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
updateSpec(spec, refreshAllLinkedObjects)
Atualiza a especificação da fonte de dados e atualiza o data
source sheets
vinculado com a nova especificação.
Uma exceção vai ser gerada 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 dos 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 que será atualizada. |
refreshAllLinkedObjects | Boolean | Se true , também atualiza todos os objetos da fonte de dados
vinculados a essa fonte. |
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
waitForAllDataExecutionsCompletion(timeoutInSeconds)
Aguarda a conclusão de todas as execuções atuais dos objetos da fonte de dados vinculada, o que expira após o número de segundos informado. Emite uma exceção se as execuções não forem concluídas ao expirar, mas não cancela as execuções de dados.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
timeoutInSeconds | Integer | Tempo de espera das 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