スクリプト トリガー。
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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 を返します。
たとえば、トリガーのソースがスプレッドシートの場合、スプレッドシートの ID になります。クロック イベントの場合、null を返します。
リターン
String
- トリガーとなるパブリッシャー内のエンティティの ID
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/script.scriptapp
getUniqueId()
トリガーの識別に使用できる一意の識別子を返します。
リターン
String
- トリガーの一意の識別子
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/script.scriptapp