Acesse e modifique a página de fonte de dados existente. Para criar uma nova página de fonte de dados, use Spreadsheet.insertDataSourceSheet(spec).
Use essa classe apenas com os dados que estão conectados a um banco de dados.
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Adiciona um filtro aplicado à planilha da fonte de dados. |
asSheet() | Sheet | Retorna a planilha de fonte de dados como um objeto normal da página. |
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 deste objeto, independentemente do estado atual. |
getColumnWidth(columnName) | Integer | Retorna a largura da coluna especificada. |
getDataSource() | DataSource | Acessa a fonte de dados vinculada ao objeto. |
getFilters() | DataSourceSheetFilter[] | Retorna todos os filtros aplicados à planilha da fonte de dados. |
getSheetValues(columnName) | Object[] | Retorna todos os valores da página de fonte de dados para o nome da coluna fornecida. |
getSheetValues(columnName, startRow, numRows) | Object[] | Retorna todos os valores da página de fonte de dados do nome da coluna fornecida, da linha inicial fornecida (base-1) até o numRows fornecido. |
getSortSpecs() | SortSpec[] | Recebe todas as especificações de classificação na planilha da fonte de dados. |
getStatus() | DataExecutionStatus | Acessa 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 informado. |
Documentação detalhada
addFilter(columnName, filterCriteria)
Adiciona um filtro aplicado à planilha da fonte de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | Nome da coluna a que este filtro será aplicado. |
filterCriteria | FilterCriteria | São os critérios de filtro a serem aplicados. |
Retornar
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 normal da página.
Retornar
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 | Nome da coluna. |
Retornar
DataSourceSheet: esta 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 atualizados. |
Retornar
DataSourceSheet: esta 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 deste objeto, independentemente do estado atual. Consulte refreshData() para
ver mais detalhes.
Uma exceção vai ser gerada 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
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | Nome da coluna. |
Retornar
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()
Acessa a fonte de dados vinculada ao objeto.
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 à planilha da fonte de dados.
Retornar
DataSourceSheetFilter[]: uma matriz de todos os filtros aplicados à página 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
getSheetValues(columnName)
Retorna todos os valores da página de fonte de dados para o nome da coluna fornecida.
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 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 do nome da coluna fornecida, da linha inicial fornecida (base-1) 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 na 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 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()
Acessa 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.
Lança 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.
Uma exceção vai ser gerada 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 página da fonte de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | Nome da coluna de que os filtros serão removidos. |
Retornar
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 página da fonte de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | O nome da coluna. |
Retornar
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 | Nome da coluna. |
width | Integer | É a nova largura da coluna. |
Retornar
DataSourceSheet: esta 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 atualizados. |
width | Integer | A nova largura das colunas. |
Retornar
DataSourceSheet: esta 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 página da fonte de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | Nome da coluna a ser classificada. |
ascending | Boolean | Se true, classifique a coluna em ordem crescente. Se false, classifique a coluna em ordem decrescente. |
Retornar
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 página da fonte de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
columnName | String | 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 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 informado. Emite uma exceção se a execução não é concluída ao expirar, mas não cancela a execução de dados.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
timeoutInSeconds | Integer | Tempo de espera da execução de dados, em segundos. O máximo é de 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