Esta página foi traduzida pela API Cloud Translation.

Class DataSourceSheet

Acessar e modificar uma planilha de fonte de dados. 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étodo	Tipo de retorno	Breve descrição
`addFilter(columnName, filterCriteria)`	`DataSourceSheet`	Adiciona um filtro aplicado à página da fonte de dados.
`asSheet()`	`Sheet`	Retorna a planilha de fonte de dados como um objeto de planilha normal.
`autoResizeColumn(columnName)`	`DataSourceSheet`	Redimensiona automaticamente a largura da coluna especificada.
`autoResizeColumns(columnNames)`	`DataSourceSheet`	Redimensiona automaticamente a largura das colunas especificadas.
`cancelDataRefresh()`	`DataSourceSheet`	Cancela a atualização de dados associada a esse objeto se ela estiver em execução.
`forceRefreshData()`	`DataSourceSheet`	Atualiza os dados desse objeto, independentemente do estado atual.
`getColumnWidth(columnName)`	`Integer`	Retorna a largura da coluna especificada.
`getDataSource()`	`DataSource`	Recebe a fonte de dados à qual 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 de início (baseada em 1) até o `numRows` fornecido.
`getSortSpecs()`	`SortSpec[]`	Recebe todas as especificações de classificação na página da fonte de dados.
`getStatus()`	`DataExecutionStatus`	Recebe o status de execução de dados do objeto.
`refreshData()`	`DataSourceSheet`	Atualiza os dados do objeto.
`removeFilters(columnName)`	`DataSourceSheet`	Remove todos os filtros aplicados à coluna da página da fonte de dados.
`removeSortSpec(columnName)`	`DataSourceSheet`	Remove a especificação de classificação de uma coluna na página da fonte de dados.
`setColumnWidth(columnName, width)`	`DataSourceSheet`	Define a largura da coluna especificada.
`setColumnWidths(columnNames, width)`	`DataSourceSheet`	Define a largura das colunas especificadas.
`setSortSpec(columnName, ascending)`	`DataSourceSheet`	Define a especificação de classificação em uma coluna na página da fonte de dados.
`setSortSpec(columnName, sortOrder)`	`DataSourceSheet`	Define a especificação de classificação em uma coluna na página da fonte de dados.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido.

Documentação detalhada

`addFilter(columnName, filterCriteria)`

Adiciona um filtro aplicado à planilha da fonte de dados.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna à qual esse filtro será aplicado.
`filterCriteria`	`FilterCriteria`	Os critérios de filtro a serem aplicados.

Retornar

DataSourceSheet: a página de fonte de dados para o encadeamento de métodos.

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

`asSheet()`

Retorna a planilha de fonte de dados como um objeto de planilha normal.

Retornar

Sheet: a folha normal.

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

`autoResizeColumn(columnName)`

Redimensiona automaticamente a largura da coluna especificada.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna.

Retornar

DataSourceSheet: página 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

Nome	Tipo	Descrição
`columnNames`	`String[]`	Lista de nomes de colunas a serem atualizados.

Retornar

DataSourceSheet: página de fonte de dados para encadeamento.

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

`cancelDataRefresh()`

Cancela a atualização de dados associada ao objeto se ele estiver em execução no momento.

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. Usar métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados em uma fonte de dados específica não é válido.

Retornar

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

`forceRefreshData()`

Atualiza os dados deste objeto, independentemente do estado atual. Consulte refreshData() para mais detalhes. Se você quiser cancelar uma atualização desse objeto em execução no momento, consulte cancelDataRefresh().

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

Retornar

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

`getColumnWidth(columnName)`

Retorna a largura da coluna especificada.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna.

Retornar

Integer: a largura da coluna ou null se a coluna usa a largura padrão.

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

`getDataSource()`

Recebe a fonte de dados à qual o objeto está vinculado.

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

`getFilters()`

Retorna todos os filtros aplicados à planilha de fonte de dados.

Retornar

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

`getSheetValues(columnName)`

Retorna todos os valores da página da fonte de dados para o nome de coluna fornecido.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna da fonte de dados em que os valores serão buscados.

Retornar

Object[]: uma matriz unidimensional de valores.

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

`getSheetValues(columnName, startRow, numRows)`

Retorna todos os valores da página da fonte de dados para o nome de coluna fornecido no linha inicial (base-1) e até o numRows fornecido.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna da fonte de dados em que os valores serão buscados.
`startRow`	`Integer`	A posição da linha para começar a buscar valores.
`numRows`	`Integer`	O 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 página da fonte de dados.

Retornar

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

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

`getStatus()`

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

Retornar

DataExecutionStatus: o status de execução dos 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 é tem preferência sobre forceRefreshData() para evitar edições inesperadas na 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 página da fonte de dados.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna da qual os filtros devem ser removidos.

Retornar

DataSourceSheet: a página de fonte de dados para o encadeamento de métodos.

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

`removeSortSpec(columnName)`

Remove a especificação de classificação de uma coluna na página da fonte de dados.

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna.

Retornar

DataSourceSheet: a planilha da origem 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

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna.
`width`	`Integer`	A nova largura da coluna.

Retornar

DataSourceSheet: página 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

Nome	Tipo	Descrição
`columnNames`	`String[]`	A lista de nomes das colunas a serem atualizadas.
`width`	`Integer`	A nova largura das colunas.

Retornar

DataSourceSheet: esta página de origem de dados, para encadeamento.

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

`setSortSpec(columnName, ascending)`

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

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna a ser classificada.
`ascending`	`Boolean`	Se for `true`, classifique a coluna em ordem crescente. Se for `false`, classificar da coluna em ordem decrescente.

Retornar

DataSourceSheet: a página da fonte de dados para encadeamento.

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

`setSortSpec(columnName, sortOrder)`

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

Parâmetros

Nome	Tipo	Descrição
`columnName`	`String`	O nome da coluna a ser classificada.
`sortOrder`	`SortOrder`	A ordem de classificação.

Retornar

DataSourceSheet: a página da fonte de dados para encadeamento.

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

`waitForCompletion(timeoutInSeconds)`

Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. Gera uma exceção se a execução não é concluída ao atingir o tempo limite, mas não cancela a a execução de dados.

Parâmetros

Nome	Tipo	Descrição
`timeoutInSeconds`	`Integer`	O tempo de espera pela execução dos dados, em segundos. O máximo é 300 segundos.

Retornar

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