Class DataSourceRefreshSchedule
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
详细文档
getFrequency()
获取刷新时间表频率,该频率用于指定刷新的频率和时间。
返回
DataSourceRefreshScheduleFrequency
- 刷新时间表频率。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getScope()
获取此刷新时间表的范围。
返回
DataSourceRefreshScope
- 刷新范围。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTimeIntervalOfNextRun()
获取此刷新时间表的下次运行时间范围。仅在此刷新时间表处于启用状态时才适用。
返回
TimeInterval
- 下次运行的时间范围。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isEnabled()
确定此刷新时间表是否已启用。
返回
Boolean
- 此刷新时间表是否已启用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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\u003eDataSourceRefreshSchedule\u003c/code\u003e allows you to access and modify the refresh schedule of data connected to a database in Google Sheets.\u003c/p\u003e\n"],["\u003cp\u003eYou can get details like refresh frequency, scope, next run time window, and whether the schedule is enabled.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides methods like \u003ccode\u003egetFrequency()\u003c/code\u003e, \u003ccode\u003egetScope()\u003c/code\u003e, \u003ccode\u003egetTimeIntervalOfNextRun()\u003c/code\u003e, and \u003ccode\u003eisEnabled()\u003c/code\u003e to manage the refresh schedule.\u003c/p\u003e\n"],["\u003cp\u003eUsing these methods requires authorization with specific scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/spreadsheets\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class DataSourceRefreshSchedule\n\nDataSourceRefreshSchedule\n\nAccess and modify an existing refresh schedule. To get all refresh schedules, see [Spreadsheet.getDataSourceRefreshSchedules()](/apps-script/reference/spreadsheet/spreadsheet#getDataSourceRefreshSchedules()).\n\n\n**Only use this class with data that's connected to a database.** \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|\n| [getFrequency()](#getFrequency()) | [DataSourceRefreshScheduleFrequency](/apps-script/reference/spreadsheet/data-source-refresh-schedule-frequency) | Gets the refresh schedule frequency, which specifies how often and when to refresh. |\n| [getScope()](#getScope()) | [DataSourceRefreshScope](/apps-script/reference/spreadsheet/data-source-refresh-scope) | Gets the scope of this refresh schedule. |\n| [getTimeIntervalOfNextRun()](#getTimeIntervalOfNextRun()) | `Time``Interval` | Gets the time window of the next run of this refresh schedule. |\n| [isEnabled()](#isEnabled()) | `Boolean` | Determines whether this refresh schedule is enabled. |\n\nDetailed documentation\n----------------------\n\n### `get``Frequency()`\n\nGets the refresh schedule frequency, which specifies how often and when to refresh.\n\n#### Return\n\n\n[DataSourceRefreshScheduleFrequency](/apps-script/reference/spreadsheet/data-source-refresh-schedule-frequency) --- The refresh schedule frequency.\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``Scope()`\n\nGets the scope of this refresh schedule.\n\n#### Return\n\n\n[DataSourceRefreshScope](/apps-script/reference/spreadsheet/data-source-refresh-scope) --- The refresh scope.\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``Time``Interval``Of``Next``Run()`\n\nGets the time window of the next run of this refresh schedule. Only applies if this refresh\nschedule is enabled.\n\n#### Return\n\n\n`Time``Interval` --- The time window of the next run.\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### `is``Enabled()`\n\nDetermines whether this refresh schedule is enabled.\n\n#### Return\n\n\n`Boolean` --- Whether this refresh schedule is enabled.\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`"]]