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
var triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger("myFunction")
  .timeBased()
  .at(triggerDay)
  .create();

參數

名稱	類型	說明
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 — 此 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 — 建構工具，用於鏈結。