Class Trigger

トリガー

スクリプト トリガー。

メソッド

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

詳細なドキュメント

getEventType()

トリガーがトリガーされるイベントタイプを返します。

const triggers = ScriptApp.getProjectTriggers();
for (let 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 を返します。

const triggers = ScriptApp.getProjectTriggers();
for (let 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 を返します。

たとえば、トリガーのソースがスプレッドシートの場合、これはスプレッドシートの ID になります。時計イベントの場合、null が返されます。

戻る

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

承認

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

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

getUniqueId()

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

戻る

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

承認

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

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