Class DataSourceRefreshScheduleFrequency
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
详细文档
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
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-26。
[null,null,["最后更新时间 (UTC):2025-07-26。"],[[["\u003cp\u003e\u003ccode\u003eDataSourceRefreshScheduleFrequency\u003c/code\u003e allows you to access and manage the frequency of data source refreshes for spreadsheet data connected to a database.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve information about the refresh schedule, including the days of the month or week, the frequency type, and the start hour of the refresh.\u003c/p\u003e\n"],["\u003cp\u003eUse \u003ccode\u003eDataSourceRefreshSchedule.getTimeIntervalOfNextRun()\u003c/code\u003e to determine the next scheduled refresh time.\u003c/p\u003e\n"],["\u003cp\u003eUpdate the refresh frequency using \u003ccode\u003eDataSourceRefreshSchedule.setFrequency(newFrequency)\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eScripts using these methods require authorization with specific scopes related to spreadsheet access.\u003c/p\u003e\n"]]],["This content describes the `DataSourceRefreshScheduleFrequency` class for managing data refresh schedules connected to databases. Key actions include accessing the refresh frequency, determining the next run time via `getTimeIntervalOfNextRun()`, and updating the schedule with `setFrequency()`. Information can be retrieved for monthly refreshes, with `getDaysOfTheMonth()`, or for weekly refreshes, with `getDaysOfTheWeek()`. `getFrequencyType()` retrieves the type, and `getStartHour()` the start time. The relevant authorization scopes are also specified.\n"],null,["# Class DataSourceRefreshScheduleFrequency\n\nDataSourceRefreshScheduleFrequency\n\nAccess a refresh schedule's frequency, which specifies how often and when to refresh.\n\n\n**Only use this class with data that's connected to a database.**\n\n\nTo see the next time this refresh schedule is scheduled to run, use [DataSourceRefreshSchedule.getTimeIntervalOfNextRun()](/apps-script/reference/spreadsheet/data-source-refresh-schedule#getTimeIntervalOfNextRun()).\n\nTo update, use `Data``Source``Refresh``Schedule.setFrequency(newFrequency)`. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|\n| [getDaysOfTheMonth()](#getDaysOfTheMonth()) | `Integer[]` | Gets the days of the month as numbers (1-28) on which to refresh the data source. |\n| [getDaysOfTheWeek()](#getDaysOfTheWeek()) | [Weekday[]](../base/weekday.html) | Gets the days of the week on which to refresh the data source. |\n| [getFrequencyType()](#getFrequencyType()) | [FrequencyType](/apps-script/reference/spreadsheet/frequency-type) | Gets the frequency type. |\n| [getStartHour()](#getStartHour()) | `Integer` | Gets the start hour (as a number 0-23) of the time interval during which the refresh schedule runs. |\n\nDetailed documentation\n----------------------\n\n### `get``Days``Of``The``Month()`\n\nGets the days of the month as numbers (1-28) on which to refresh the data source. Only applies\nif frequency type is monthly.\n\n#### Return\n\n\n`Integer[]` --- The days of the month on which to refresh.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Days``Of``The``Week()`\n\nGets the days of the week on which to refresh the data source. Only applies if the frequency\ntype is weekly.\n\n#### Return\n\n\n[Weekday[]](../base/weekday.html) --- The days of the week on which to refresh.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Frequency``Type()`\n\nGets the frequency type.\n\n#### Return\n\n\n[FrequencyType](/apps-script/reference/spreadsheet/frequency-type) --- The frequency type.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Start``Hour()`\n\nGets the start hour (as a number 0-23) of the time interval during which the refresh schedule\nruns. For example, if the start hour is 13 and the time interval's duration is 4 hours, then\nthe data source is refreshed between 1 p.m. and 5 p.m. The hour is in the timezone of the\nspreadsheet.\n\n#### Return\n\n\n`Integer` --- The start hour.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]