Esta página foi traduzida pela API Cloud Translation.

Class DataSourceSheet

Acessar e modificar a página 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é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.
`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 da fonte de dados referente ao nome da coluna fornecido.
`getSheetValues(columnName, startRow, numRows)`	`Object[]`	Retorna todos os valores da página de fonte de dados referentes ao nome da coluna fornecido a partir da linha inicial fornecida (base-1) até a `numRows` fornecida.
`getSortSpecs()`	`SortSpec[]`	Recebe todas as especificações de classificação na planilha 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 planilha 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 planilha da fonte de dados.
`setSortSpec(columnName, sortOrder)`	`DataSourceSheet`	Define a especificação de classificação em uma coluna na planilha 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 à página 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.

Retorno

DataSourceSheet: a página 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 planilha de fonte de dados como um objeto de planilha normal.

Retorno

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

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

Retorno

DataSourceSheet: essa 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[]`	A lista de nomes de colunas a serem atualizadas.

Retorno

DataSourceSheet: essa 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

`forceRefreshData()`

Atualiza os dados desse objeto, independentemente do estado atual. Consulte refreshData() para mais detalhes.

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

Retorno

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

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

Retorno

Integer: a largura da coluna, ou null se a coluna 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 à qual o objeto está vinculado.

Retorno

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.

Retorno

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

Retorno

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 página de fonte de dados referentes ao nome da coluna fornecido a partir da linha inicial fornecida (base-1) até a numRows fornecida.

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 em que a busca de valores começa.
`numRows`	`Integer`	O número de linhas a serem buscadas.

Retorno

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.

Retorno

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.

Retorno

DataExecutionStatus — 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 em relação a forceRefreshData() para evitar edições inesperadas na fonte de dados.

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

Retorno

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 serão removidos.

Retorno

DataSourceSheet: a página 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 de uma coluna na planilha da fonte de dados.

Parâmetros

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

Retorno

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

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

Retorno

DataSourceSheet: essa 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 de colunas a serem atualizadas.
`width`	`Integer`	A nova largura das colunas.

Retorno

DataSourceSheet: essa 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

`setSortSpec(columnName, ascending)`

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

Parâmetros

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

Retorno

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

Retorno

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

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

Parâmetros

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

Retorno

DataExecutionStatus — 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