Class DataSourceRefreshScheduleFrequency
Stay organized with collections
Save and categorize content based on your preferences.
DataSourceRefreshScheduleFrequency
Access a refresh schedule's frequency, which specifies how often and when to refresh.
Only use this class with data that's connected to a database.
To see the next time this refresh schedule is scheduled to run, use DataSourceRefreshSchedule.getTimeIntervalOfNextRun().
To update, use DataSourceRefreshSchedule.setFrequency(newFrequency).
Detailed documentation
getDaysOfTheMonth()
Gets the days of the month as numbers (1-28) on which to refresh the data source. Only applies
if frequency type is monthly.
Return
Integer[] — The days of the month on which to refresh.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDaysOfTheWeek()
Gets the days of the week on which to refresh the data source. Only applies if the frequency
type is weekly.
Return
Weekday[] — The days of the week on which to refresh.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrequencyType()
Gets the frequency type.
Return
FrequencyType — The frequency type.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStartHour()
Gets the start hour (as a number 0-23) of the time interval during which the refresh schedule
runs. For example, if the start hour is 13 and the time interval's duration is 4 hours, then
the data source is refreshed between 1 p.m. and 5 p.m. The hour is in the timezone of the
spreadsheet.
Return
Integer — The start hour.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\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`"]]
