Class ClockTriggerBuilder

時鐘觸發事件建構工具

時鐘觸發事件的建構工具。

方法

方法傳回類型簡短說明
after(durationMilliseconds)ClockTriggerBuilder指定觸發條件在目前時間執行後，最短的持續時間 (以毫秒為單位)。
at(date)ClockTriggerBuilder指定觸發條件執行的時間。
atDate(year, month, day)ClockTriggerBuilder指定觸發條件會在指定日期 (預設為午夜前後 15 分鐘) 觸發。
atHour(hour)ClockTriggerBuilder指定觸發條件執行的時間。
create()Trigger建立觸發條件。
everyDays(n)ClockTriggerBuilder指定每 n 天執行一次觸發事件。
everyHours(n)ClockTriggerBuilder指定每 n 小時執行一次觸發事件。
everyMinutes(n)ClockTriggerBuilder指定每 n 分鐘執行一次觸發事件。
everyWeeks(n)ClockTriggerBuilder指定每 n 週執行一次觸發條件。
inTimezone(timezone)ClockTriggerBuilder指定觸發條件執行時的指定日期/時間時區。
nearMinute(minute)ClockTriggerBuilder指定觸發條件執行的時間 (加減 15 分鐘)。
onMonthDay(day)ClockTriggerBuilder指定觸發條件執行月份的日期。
onWeekDay(day)ClockTriggerBuilder指定觸發條件執行的星期幾。

內容詳盡的說明文件

after(durationMilliseconds)

指定觸發條件在目前時間執行後，最短的持續時間 (以毫秒為單位)。實際播放時間可能會有所不同，但不會少於您指定的最小值。 

// Creates a trigger that runs 10 minutes later
ScriptApp.newTrigger('myFunction').timeBased().after(10 * 60 * 1000).create();

參數

名稱類型說明
durationMillisecondsInteger觸發條件應在目前時間過後的最低時間長度 (以毫秒為單位)。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

at(date)

指定觸發條件執行的時間。

// Creates a trigger for December 1, 2012
const triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger('myFunction').timeBased().at(triggerDay).create();

參數

名稱類型說明
dateDate代表觸發條件應執行時間的 Date 物件。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

atDate(year, month, day)

指定觸發條件會在指定日期 (預設為午夜前後 15 分鐘) 觸發。

// Schedules for January 1st, 2013
ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 1, 1).create();

參數

名稱類型說明
yearInteger排定觸發事件的年份。
monthInteger排定觸發事件的農曆月份 (應為 1 到 12 之間的數字，含 1 和 12)。
dayInteger排定觸發事件的日曆日 (應為介於 1 到 31 之間的數字，包含 1 和 31)。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

atHour(hour)

指定觸發條件執行的時間。

// Runs between 5am-6am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

參數

名稱類型說明
hourInteger觸發時段。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

create()

建立觸發條件。

回攻員

Trigger：新建立的排程觸發條件。

everyDays(n)

指定每 n 天執行觸發事件。

ScriptApp.newTrigger('myFunction').timeBased().everyDays(3).create();

參數

名稱類型說明
nInteger執行作業之間的天數。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

everyHours(n)

指定每 n 小時執行一次觸發事件。

ScriptApp.newTrigger('myFunction').timeBased().everyHours(12).create();

參數

名稱類型說明
nInteger執行作業之間的時間長度 (以小時為單位)。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

everyMinutes(n)

指定每 n 分鐘執行一次觸發事件。n 必須為 1、5、10、15 或 30。

ScriptApp.newTrigger('myFunction').timeBased().everyMinutes(10).create();

參數

名稱類型說明
nInteger執行作業之間的時間間隔 (分鐘)。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

everyWeeks(n)

指定每 n 週執行觸發事件。

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .everyWeeks(2)
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

參數

名稱類型說明
nInteger執行作業之間的週數。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

inTimezone(timezone)

指定觸發條件執行時的指定日期/時間時區。根據預設，時區會與指令碼相同。

有效時區字串清單對應 Joda.org 所列的有效時區字串。無效的時區字串會導致指令碼擲回錯誤。

// Schedule the trigger to execute at noon every day in the US/Pacific time zone
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(12)
    .everyDays(1)
    .inTimezone('America/Los_Angeles')
    .create();

參數

名稱類型說明
timezoneString處理事件中時間資訊的時區。

回攻員

ClockTriggerBuilder：這個 ClockTriggerBuilder，用於鏈結。

nearMinute(minute)

指定觸發條件執行的時間 (加上或減去 15 分鐘)。如果未呼叫 nearMinute()，系統會使用隨機分鐘值。

// Runs at approximately 5:30am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .nearMinute(30)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

參數

名稱類型說明
minuteInteger觸發事件的時間點。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

onMonthDay(day)

指定觸發條件執行月份的日期。

// Schedules for the first of every month
ScriptApp.newTrigger('myFunction').timeBased().onMonthDay(1).create();

參數

名稱類型說明
dayInteger應排定觸發事件的月份。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。

onWeekDay(day)

指定觸發條件執行的星期幾。

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

參數

名稱類型說明
dayWeekday要觸發的星期幾。

回攻員

ClockTriggerBuilder：用於鏈結的建構工具。