Class DataSourceRefreshScheduleFrequency

数据源刷新时间表频率

查看刷新时间表的频率，该频率用于指定刷新的频率和时间。

请仅将此类与连接到数据库的数据搭配使用。

如需查看此刷新时间表的下次运行时间，请使用 DataSourceRefreshSchedule.getTimeIntervalOfNextRun()。

如需更新，请使用 DataSourceRefreshSchedule.setFrequency(newFrequency)。

方法

方法返回类型简介
getDaysOfTheMonth()Integer[]获取要刷新数据源的月份中的某一天（以数字 [1-28] 表示）。
getDaysOfTheWeek()Weekday[]获取要刷新数据源的星期几。
getFrequencyType()FrequencyType获取频次类型。
getStartHour()Integer获取刷新时间表运行时段的开始小时（以 0-23 之间的数字表示）。

详细文档

getDaysOfTheMonth()

获取要刷新数据源的月份中的某一天（以数字 1-28 表示）。仅适用于频率类型为“每月”时。

返回

Integer[] - 刷新的日期。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDaysOfTheWeek()

获取要刷新数据源的星期几。仅当频率类型为每周时才适用。

返回

Weekday[] - 刷新的日期。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFrequencyType()

获取频次类型。

返回

FrequencyType - 频率类型。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStartHour()

获取刷新时间表运行时段的开始小时（以 0-23 之间的数字表示）。例如，如果开始小时为 13 小时，时间间隔时长为 4 小时，则数据源会在下午 1 点到下午 5 点之间刷新。小时是指电子表格的时区。

返回

Integer - 开始小时。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets