Acessa a frequência de uma programação de atualização, que especifica a frequência e o momento da atualização.
Use essa classe apenas com dados conectados a um banco de dados.
Para saber a próxima vez que essa programação de atualização está programada para execução, use DataSourceRefreshSchedule.getTimeIntervalOfNextRun().
Para atualizar, use DataSourceRefreshSchedule.setFrequency(newFrequency).
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getDaysOfTheMonth() | Integer[] | Recebe os dias do mês como números (1 a 28) para atualizar a fonte de dados. |
getDaysOfTheWeek() | Weekday[] | Extrai os dias da semana em que a fonte de dados é atualizada. |
getFrequencyType() | FrequencyType | Recebe o tipo de frequência. |
getStartHour() | Integer | Recebe a hora de início (como um número de 0 a 23) do intervalo de tempo em que a programação de atualização é executada. |
Documentação detalhada
getDaysOfTheMonth()
Recebe os dias do mês como números (1 a 28) para atualizar a fonte de dados. Só se aplica se o tipo de frequência for mensal.
Retorno
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()
Extrai os dias da semana em que a fonte de dados é atualizada. Só se aplica se o tipo de frequência for semanal.
Retorno
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.
Retorno
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 em que 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.
Retorno
Integer: o horário 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