Esta página foi traduzida pela API Cloud Translation.

Class DataSource

Acessar e modificar a fonte de dados atual. Para criar uma tabela de origem 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
`cancelAllLinkedDataSourceObjectRefreshes()`	`void`	Cancela todas as atualizações em execução de objetos da fonte de dados vinculados a essa fonte.
`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 esta fonte.
`getSpec()`	`DataSourceSpec`	Consegue a especificação da fonte de dados.
`refreshAllLinkedDataSourceObjects()`	`void`	Atualiza todos os objetos da fonte de dados vinculados à fonte.
`updateSpec(spec)`	`DataSource`	Atualiza a especificação da fonte de dados e os objetos da fonte de dados vinculados a ela 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

`cancelAllLinkedDataSourceObjectRefreshes()`

Cancela todas as atualizações em execução de objetos da fonte de dados vinculados a essa fonte de dados.

Este exemplo mostra como cancelar todas as atualizações de uma fonte de dados.

SpreadsheetApp.enableBigQueryExecution();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Gera 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 de origem de dados específico.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`createCalculatedColumn(name, formula)`

Cria uma coluna calculada. Esse método está disponível apenas para fontes de dados do BigQuery.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O 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 precisam de 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 torna a nova página a página ativa.

Retornar

DataSourcePivotTable: a tabela dinâmica de fonte de dados recém-criada.

Autorização

Os scripts que usam esse método precisam de 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 um lado torna a nova página a página ativa.

Esse método está disponível apenas para fontes de dados do BigQuery.

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`	O nome da coluna calculada a ser exibida.

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 precisam de 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.

As especificações da fonte de dados do tipo DataSourceType.LOOKER retorna uma matriz vazia.

Retornar

DataSourceColumn[]: uma matriz de todas as colunas calculadas na fonte de dados.

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

DataSourceColumn[]: uma matriz de todos os DataSourceColumn na fonte de dados.

Autorização

Os scripts que usam esse método precisam de 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 esta fonte.

Retornar

DataSourceSheet[]: uma matriz de páginas de fontes 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()`

Consegue 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 à fonte.

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 de origem de dados específico.

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 os objetos da fonte de dados vinculados a ela com a nova especificação.

Gera uma exceção se o tipo de especificação da fonte de dados for diferente do o tipo de fonte de dados atual.

Parâmetros

Nome	Tipo	Descrição
`spec`	`DataSourceSpec`	A especificação da fonte de dados a 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.

Gera uma exceção se o tipo de especificação da fonte de dados for diferente do o tipo de fonte de dados atual.

Parâmetros

Nome	Tipo	Descrição
`spec`	`DataSourceSpec`	A especificação da fonte de dados a ser atualizada.
`refreshAllLinkedObjects`	`Boolean`	Se `true`, também atualiza todos os objetos da fonte de dados. vinculado a essa fonte de dados.

Retornar

DataSource: a fonte de dados.

Autorização

Os scripts que usam esse método precisam de 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 de origem de dados vinculados sejam concluídas, com um tempo limite após o número de segundos fornecido. Gera uma exceção quando as execuções não são concluídas ao atingir o tempo limite, mas não cancela as execuções de dados.

Parâmetros

Nome	Tipo	Descrição
`timeoutInSeconds`	`Integer`	O tempo para aguardar execuções de dados, em segundos. O máximo é 300 segundos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets