このページは 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
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 - チェーン用の 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 - チェーン用のビルダー。