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