Acessar e modificar um gráfico de fonte de dados.
Use essa classe apenas com dados conectados a um banco de dados do BigQuery.
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
cancel | Data | Cancela a atualização de dados associada a esse objeto se ela estiver em execução. |
force | Data | Atualiza os dados desse objeto, independentemente do estado atual. |
get | Data | Recebe a fonte de dados à qual o objeto está vinculado. |
get | Data | Recebe o status de execução de dados do objeto. |
refresh | Data | Atualiza os dados do objeto. |
wait | Data | Aguarda até a conclusão da execução atual e expira após o número de segundos fornecido. |
Documentação detalhada
cancel Data Refresh()
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 os métodos Spreadsheet para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data: 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
force Refresh Data()
Atualiza os dados desse objeto, independentemente do estado atual. Consulte refresh para
mais detalhes. Se você quiser cancelar uma atualização em andamento desse objeto, consulte cancel.
Gera uma exceção se o tipo de fonte de dados não estiver ativado. Use os métodos Spreadsheet para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data: 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
get Data Source()
Recebe a fonte de dados à qual o objeto está vinculado.
Retornar
Data: 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
get Status()
Recebe o status de execução de dados do objeto.
Retornar
Data: 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
refresh Data()
Atualiza os dados do objeto.
Gera uma exceção se estiver no estado error. Use Data para atualizar a especificação. O método é
preferível a force 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 os métodos Spreadsheet para ativar a execução de dados para um tipo específico de fonte de dados.
Retornar
Data: 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
wait For Completion(timeoutInSeconds)
Aguarda até a conclusão da execução atual e expira 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
| Nome | Tipo | Descrição |
|---|---|---|
timeout | Integer | O tempo de espera para a execução dos dados, em segundos. O máximo é 300 segundos. |
Retornar
Data: 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