本頁面由 Cloud Translation API 翻譯而成。

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

參數

名稱	類型	說明
`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：用於鏈結的建構工具。