Class DataSource

Fonte dedados

Acessar e modificar uma fonte de dados. 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étodoTipo de retornoBreve descrição
cancelAllLinkedDataSourceObjectRefreshes()voidCancela todas as atualizações em execução de objetos da fonte de dados vinculados a esta fonte.
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte na primeira célula de uma nova planilha.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base nessa fonte na primeira célula de uma nova planilha.
getCalculatedColumnByName(columnName)DataSourceColumn|nullRetorna 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 planilhas de origem de dados associadas a esta fonte de dados.
getSpec()DataSourceSpecRecebe a especificação da fonte de dados.
refreshAllLinkedDataSourceObjects()voidAtualiza todos os objetos da fonte de dados vinculados a ela.
updateSpec(spec)DataSourceAtualiza a especificação da fonte de dados e atualiza os objetos vinculados a ela com a nova especificação.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAtualiza a especificação da fonte de dados e atualiza o data source sheets vinculado com a nova especificação.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarde até que todas as execuções atuais dos objetos de fonte de dados vinculados sejam concluídas, atingindo o tempo limite 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 esta fonte.

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

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

Gera uma exceção 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 o tipo de fonte 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

createCalculatedColumn(name, formula)

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

Parâmetros

NomeTipoDescrição
nameStringO nome da coluna calculada.
formulaStringA 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 na primeira célula de uma nova planilha. Como um efeito colateral, torna a nova planilha a planilha ativa.

Retornar

DataSourcePivotTable: a tabela dinâmica da 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 na primeira célula de uma nova planilha. Como um efeito colateral, torna a nova planilha a planilha ativa.

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

Retornar

DataSourceTable: a tabela da 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

NomeTipoDescrição
columnNameStringO nome da coluna calculada a ser recebida.

Retornar

DataSourceColumn|null: a coluna calculada que corresponde ao nome da coluna ou null se não houver uma 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.

Especificações de fonte de dados do tipo DataSourceType.LOOKER retornam 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 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.

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 origem de dados associadas a esta fonte de dados.

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

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.

Gera uma exceção 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 o tipo de fonte 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 atualiza os objetos vinculados a ela com a nova especificação.

Gera uma exceção 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 o tipo de fonte de dados específico.

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

Parâmetros

NomeTipoDescrição
specDataSourceSpecA 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 fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para o tipo de fonte de dados específico.

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

Parâmetros

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados a ser atualizada.
refreshAllLinkedObjectsBooleanSe true, também atualiza todos os objetos da fonte de dados vinculados a ela.

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)

Aguarde até que todas as execuções atuais dos objetos de fonte de dados vinculados sejam concluídas, atingindo o tempo limite após o número de segundos fornecido. Gera uma exceção se as execuções não forem concluídas quando o tempo limite expirar, mas não cancela as execuções de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerO tempo de espera para execuções de dados, em segundos. O máximo é 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