Class Trigger

トリガー

スクリプト トリガー。

メソッド

メソッド戻り値の型概要
getEventType()EventTypeトリガーが発動したイベントタイプを返します。
getHandlerFunction()Stringトリガーの起動時に呼び出される関数を返します。
getTriggerSource()TriggerSourceトリガーを起動するイベントのソースを返します。
getTriggerSourceId()Stringソースに固有の ID を返します。
getUniqueId()Stringトリガーの区別に使用できる一意の識別子を返します。

詳細なドキュメント

getEventType()

トリガーが発動したイベントタイプを返します。 

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getEventType() == ScriptApp.EventType.CLOCK) {
    // Some code here - other options are:
    // ScriptApp.EventType.ON_EDIT
    // ScriptApp.EventType.ON_FORM_SUBMIT
    // ScriptApp.EventType.ON_OPEN
  }
}

戻る

EventType - トリガーするイベントタイプ

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

  • https://www.googleapis.com/auth/script.scriptapp

getHandlerFunction()

トリガーの起動時に呼び出される関数を返します。 

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction').forSpreadsheet('id of my spreadsheet').onEdit().create();
Logger.log(ScriptApp.getProjectTriggers()[0].getHandlerFunction()); // logs "myFunction"

戻る

String - メソッド名

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSource()

トリガーを起動するイベントのソースを返します。

たとえば、スプレッドシートの onEdit トリガーは SPREADSHEETS または時間ベースのトリガーを返します。 CLOCK を返します。 

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.CLOCK) {
    Logger.log(triggers[i].getUniqueId() + " source is clock");
  } else if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.SPREADSHEETS) {
    Logger.log(triggers[i].getUniqueId() + " source is spreadsheets");
  }
}

戻る

TriggerSource - トリガーとなるパブリッシャー

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSourceId()

ソースに固有の ID を返します。

たとえば、トリガーソースがスプレッドシートの場合、これは 表示されます。クロックイベントの場合、これは null を返します。

戻る

String - トリガーの対象となるパブリッシャー内のエンティティの ID

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

  • https://www.googleapis.com/auth/script.scriptapp

getUniqueId()

トリガーの区別に使用できる一意の識別子を返します。

戻る

String - トリガーの一意の識別子

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

  • https://www.googleapis.com/auth/script.scriptapp