Class DataSourceRefreshSchedule
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Sourcede donnéesActualisationPlanifiée
Accéder à un calendrier d'actualisation existant et le modifier Pour obtenir tous les calendriers d'actualisation, consultez Spreadsheet.getDataSourceRefreshSchedules().
N'utilisez cette classe que pour les données connectées à une base de données.
Documentation détaillée
getFrequency()
Récupère la fréquence de planification de l'actualisation, qui spécifie la fréquence et le moment de l'actualisation.
Renvois
DataSourceRefreshScheduleFrequency : fréquence de planification de l'actualisation.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getScope()
Récupère le champ d'application de ce calendrier d'actualisation.
Renvois
DataSourceRefreshScope : champ d'application de l'actualisation.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTimeIntervalOfNextRun()
Récupère la période de la prochaine exécution de ce calendrier d'actualisation. Ne s'applique que si cette planification d'actualisation est activée.
Renvois
TimeInterval : période de la prochaine exécution.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isEnabled()
Indique si cette planification d'actualisation est activée.
Renvois
Boolean : indique si cette planification d'actualisation est activée.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\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`"]]
