Class DataSourceSheet

DataSourceSheet

Acessar e modificar a planilha da fonte de dados atual. Para criar uma nova página de fonte de dados, use Spreadsheet.insertDataSourceSheet(spec).

Use essa classe apenas com dados conectados a um banco de dados.

Métodos

MétodoTipo de retornoBreve descrição
addFilter(columnName, filterCriteria)DataSourceSheetAdiciona um filtro aplicado à página da fonte de dados.
asSheet()SheetRetorna a página de fonte de dados como um objeto de página comum.
autoResizeColumn(columnName)DataSourceSheetRedimensiona automaticamente a largura da coluna especificada.
autoResizeColumns(columnNames)DataSourceSheetRedimensiona automaticamente a largura das colunas especificadas.
cancelDataRefresh()DataSourceSheetCancela a atualização de dados associada a esse objeto, se ela estiver em execução.
forceRefreshData()DataSourceSheetAtualiza os dados desse objeto, independente do estado atual.
getColumnWidth(columnName)Integer|nullRetorna a largura da coluna especificada.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getFilters()DataSourceSheetFilter[]Retorna todos os filtros aplicados à página da fonte de dados.
getSheetValues(columnName)Object[]Retorna todos os valores da planilha de origem de dados para o nome da coluna fornecido.
getSheetValues(columnName, startRow, numRows)Object[]Retorna todos os valores da planilha de origem de dados para o nome da coluna fornecido, da linha inicial (com base em 1) até o numRows fornecido.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na planilha da fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceSheetAtualiza os dados do objeto.
removeFilters(columnName)DataSourceSheetRemove todos os filtros aplicados à coluna da planilha de fonte de dados.
removeSortSpec(columnName)DataSourceSheetRemove a especificação de classificação em uma coluna na planilha da fonte de dados.
setColumnWidth(columnName, width)DataSourceSheetDefine a largura da coluna especificada.
setColumnWidths(columnNames, width)DataSourceSheetDefine a largura das colunas especificadas.
setSortSpec(columnName, ascending)DataSourceSheetDefine a especificação de classificação em uma coluna na página de origem de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na página de origem de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

Documentação detalhada

addFilter(columnName, filterCriteria)

Adiciona um filtro aplicado à página da fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna a que esse filtro será aplicado.
filterCriteriaFilterCriteriaOs critérios de filtragem a serem aplicados.

Retornar

DataSourceSheet: a planilha da fonte de dados para encadeamento de métodos.

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

asSheet()

Retorna a página de fonte de dados como um objeto de página comum.

Retornar

Sheet: a planilha normal.

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

autoResizeColumn(columnName)

Redimensiona automaticamente a largura da coluna especificada.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna.

Retornar

DataSourceSheet: esta planilha de fonte de dados para encadeamento.

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

autoResizeColumns(columnNames)

Redimensiona automaticamente a largura das colunas especificadas.

Parâmetros

NomeTipoDescrição
columnNamesString[]A lista de nomes de colunas a serem atualizados.

Retornar

DataSourceSheet: esta planilha de fonte de dados para encadeamento.

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

cancelDataRefresh()

Cancela a atualização de dados associada a esse objeto, se ela estiver em execução.

Este exemplo mostra como cancelar uma atualização de fórmula. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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 um tipo específico de fonte de dados.

Retornar

DataSourceSheet: o objeto 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

forceRefreshData()

Atualiza os dados desse objeto, independente do estado atual. Consulte refreshData() para mais detalhes. Se quiser cancelar uma atualização em andamento desse objeto, consulte cancelDataRefresh().

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 um tipo específico de fonte de dados.

Retornar

DataSourceSheet: o objeto 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

getColumnWidth(columnName)

Retorna a largura da coluna especificada.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna.

Retornar

Integer|null: a largura da coluna ou null se ela usar a largura padrão.

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

getDataSource()

Recebe a fonte de dados a que o objeto está vinculado.

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

getFilters()

Retorna todos os filtros aplicados à página da fonte de dados.

Retornar

DataSourceSheetFilter[]: uma matriz de todos os filtros aplicados à planilha 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

getSheetValues(columnName)

Retorna todos os valores da planilha de origem de dados para o nome da coluna fornecido.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados para buscar valores.

Retornar

Object[]: uma matriz unidimensional de valores.

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

getSheetValues(columnName, startRow, numRows)

Retorna todos os valores da planilha de origem de dados para o nome da coluna fornecido, da linha inicial (com base em 1) até o numRows fornecido.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna da fonte de dados para buscar valores.
startRowIntegerA posição da linha para começar a buscar valores.
numRowsIntegerO número de linhas a serem buscadas.

Retornar

Object[]: uma matriz unidimensional de valores.

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

getSortSpecs()

Recebe todas as especificações de classificação na planilha da fonte de dados.

Retornar

SortSpec[]: uma lista de especificações de classificação.

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

getStatus()

Recebe o status de execução de dados do objeto.

Retornar

DataExecutionStatus: o status da execução 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

refreshData()

Atualiza os dados do objeto.

Gera uma exceção se estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método é preferível a forceRefreshData() para evitar edições inesperadas na fonte de dados.

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 um tipo específico de fonte de dados.

Retornar

DataSourceSheet: o objeto 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

removeFilters(columnName)

Remove todos os filtros aplicados à coluna da planilha de fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna de que os filtros serão removidos.

Retornar

DataSourceSheet: a planilha da fonte de dados para encadeamento de métodos.

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

removeSortSpec(columnName)

Remove a especificação de classificação em uma coluna na planilha da fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna.

Retornar

DataSourceSheet: a planilha da fonte de dados, para encadeamento.

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

setColumnWidth(columnName, width)

Define a largura da coluna especificada.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna.
widthIntegerA nova largura da coluna.

Retornar

DataSourceSheet: esta planilha de fonte de dados para encadeamento.

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

setColumnWidths(columnNames, width)

Define a largura das colunas especificadas.

Parâmetros

NomeTipoDescrição
columnNamesString[]A lista de nomes de colunas a serem atualizados.
widthIntegerA nova largura das colunas.

Retornar

DataSourceSheet: esta planilha de fonte de dados para encadeamento.

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

setSortSpec(columnName, ascending)

Define a especificação de classificação em uma coluna na página de origem de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna a ser classificada.
ascendingBooleanSe true, classifique a coluna em ordem crescente; se false, classifique a coluna em ordem decrescente.

Retornar

DataSourceSheet: a planilha da fonte de dados, para encadeamento.

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

setSortSpec(columnName, sortOrder)

Define a especificação de classificação em uma coluna na página de origem de dados.

Parâmetros

NomeTipoDescrição
columnNameStringO nome da coluna a ser classificada.
sortOrderSortOrderA ordem de classificação.

Retornar

DataSourceSheet: a planilha da fonte de dados, para encadeamento.

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

waitForCompletion(timeoutInSeconds)

Aguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido. Gera uma exceção se a execução não for concluída quando o tempo limite expirar, mas não cancela a execução de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerO tempo de espera para a execução de dados, em segundos. O máximo é 300 segundos.

Retornar

DataExecutionStatus: o status da execução 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