Acessa a frequência de uma programação de atualização, que especifica com que frequência e quando atualizar.
Use essa classe apenas com dados conectados a um banco de dados.
Para conferir a próxima vez que essa programação de atualização será executada, use DataSourceRefreshSchedule.getTimeIntervalOfNextRun().
Para atualizar, use DataSourceRefreshSchedule.setFrequency(newFrequency).
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
get | Integer[] | Recebe os dias do mês como números (1 a 28) em que a fonte de dados será atualizada. |
get | Weekday[] | Recebe os dias da semana em que a fonte de dados será atualizada. |
get | Frequency | Recebe o tipo de frequência. |
get | Integer | Recebe a hora de início (como um número de 0 a 23) do intervalo de tempo durante o qual a programação de atualização é executada. |
Documentação detalhada
getDaysOfTheMonth()
Recebe os dias do mês como números (1 a 28) em que a fonte de dados será atualizada. Só é aplicável se o tipo de frequência for mensal.
Retornar
Integer[]: os dias do mês em que a atualização será feita.
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
getDaysOfTheWeek()
Recebe os dias da semana em que a fonte de dados será atualizada. Só é aplicável se o tipo de frequência for semanal.
Retornar
Weekday[]: os dias da semana em que a atualização será feita.
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
getFrequencyType()
Recebe o tipo de frequência.
Retornar
FrequencyType: o tipo de frequência.
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
getStartHour()
Recebe a hora de início (como um número de 0 a 23) do intervalo de tempo durante o qual a programação de atualização é executada. Por exemplo, se a hora de início for 13 e a duração do intervalo de tempo for de 4 horas, a fonte de dados será atualizada entre 13h e 17h. A hora está no fuso horário da planilha.
Retornar
Integer: a hora de início.
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