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)ClockTriggerBuildern 時間ごとにトリガーを実行するように指定します。
everyMinutes(n)ClockTriggerBuildern 分ごとにトリガーを実行するように指定します。
everyWeeks(n)ClockTriggerBuildern 週間ごとにトリガーを実行するように指定します。
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
var 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 - チェーン用のビルダー。