Class ClockTriggerBuilder

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();

參數

名稱	類型	說明
durationMilliseconds	Integer	觸發條件應執行的最短時間 (以毫秒為單位)，此時間以目前時間為準。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

at(date)

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

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

參數

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

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

atDate(year, month, day)

指定觸發條件在特定日期觸發，預設時間為午夜前後 15 分鐘。

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

參數

名稱	類型	說明
year	Integer	排定觸發條件的年份。
month	Integer	排定觸發條件的日曆月份 (應為介於 1 到 12 之間的數字，含首尾)。
day	Integer	排定觸發條件的日曆日期 (應為介於 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();

參數

名稱	類型	說明
hour	Integer	觸發時間 (小時)。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

create()

建立觸發條件。

回攻員

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

---

everyDays(n)

指定每 n 天執行一次觸發條件。

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

參數

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

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

everyHours(n)

指定每 n 小時執行一次觸發程序。

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

參數

名稱	類型	說明
n	Integer	執行作業之間的小時數。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

everyMinutes(n)

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

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

參數

名稱	類型	說明
n	Integer	執行作業之間的間隔分鐘數。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

everyWeeks(n)

指定每 n 週執行一次觸發條件。

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

參數

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

回攻員

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();

參數

名稱	類型	說明
timezone	String	活動中時間資訊的時區。

回攻員

ClockTriggerBuilder - This 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();

參數

名稱	類型	說明
minute	Integer	觸發時間 (分鐘)。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

onMonthDay(day)

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

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

參數

名稱	類型	說明
day	Integer	觸發條件的排定日期 (當月第幾天)。

回攻員

ClockTriggerBuilder - 鏈結的建構工具。

---

onWeekDay(day)

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

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

參數

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

回攻員

ClockTriggerBuilder - 鏈結的建構工具。