Class ClockTriggerBuilder

ClockTriggerBuilder

クロック トリガーのビルダー。

メソッド

メソッド戻り値の型概要
after(durationMilliseconds)ClockTriggerBuilderトリガーが実行されるまでの現在時刻からの最小期間（ミリ秒単位）を指定します。
at(date)ClockTriggerBuilderトリガーが実行されるタイミングを指定します。
atDate(year, month, day)ClockTriggerBuilderトリガーが指定された日付に（デフォルトでは午前 0 時の前後 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)

トリガーが指定された日付に（デフォルトでは午前 0 時の前後 15 分以内）発動することを指定します。

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

パラメータ

名前タイプ説明
yearIntegerトリガーをスケジュールするカレンダー年。
monthIntegerトリガーをスケジュールするカレンダー月（1 ～ 12 の数値（両端を含む）である必要があります）。
dayIntegerトリガーをスケジュールするカレンダーの日（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 - チェーン用のビルダー。