Class DataSource

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
DataSource

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étodoTipo de retornoBreve descrição
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base na fonte de dados na primeira célula de uma nova página.
getCalculatedColumnByName(columnName)DataSourceColumnRetorna 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()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 da fonte vinculados a essa fonte 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)voidAguarda 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

NomeTipoDescrição
nameStringNome 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 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

NomeTipoDescrição
columnNameStringNome 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

NomeTipoDescrição
specDataSourceSpecA 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

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados que será atualizada.
refreshAllLinkedObjectsBooleanSe 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

NomeTipoDescrição
timeoutInSecondsIntegerTempo 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