指令碼觸發條件。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getEventType() | EventType | 傳回觸發事件觸發的事件類型。 |
getHandlerFunction() | String | 傳回當觸發條件啟動時要呼叫的函式。 |
getTriggerSource() | TriggerSource | 傳回將觸發觸發條件的事件來源。 |
getTriggerSourceId() | String | 傳回來源專屬的 ID。 |
getUniqueId() | String | 傳回可用於區分觸發條件的專屬 ID。 |
內容詳盡的說明文件
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
:觸發此動作的事件類型
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
:方法名稱
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
:發布商是觸發網址的對象
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/script.scriptapp
getTriggerSourceId()
傳回來源專屬的 ID。
舉例來說,如果觸發事件來源是試算表,則這組 ID 會是 試算表。如果是時鐘事件,則會傳回空值。
回攻員
String
:發布商中做為觸發條件的實體 ID
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/script.scriptapp
getUniqueId()
傳回可用於區分觸發條件的專屬 ID。
回攻員
String
:觸發條件的專屬 ID
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/script.scriptapp