טריגר לסקריפט.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
getEventType() | EventType | מחזירה את סוג האירוע שבו הטריגר מופעל. |
getHandlerFunction() | String | מחזירה את הפונקציה שתיקרא כשהטריגר מופעל. |
getTriggerSource() | TriggerSource | מחזירה את המקור של האירועים שיגרמו להפעלה של הטריגר. |
getTriggerSourceId() | String | מחזירה את המזהה הספציפי למקור. |
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
– סוג האירוע שעבורו רוצים להפעיל את המודעה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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()
מחזירה את המזהה הספציפי למקור.
לדוגמה, אם מקור ההפעלה הוא גיליון אלקטרוני, זהו המזהה של הגיליון האלקטרוני. לאירועי שעון, הערך מחזיר null.
החזרות
String
– המזהה של הישות בעל התוכן הדיגיטלי שעבורה מתבצעת ההפעלה הזאת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/script.scriptapp
getUniqueId()
הפונקציה מחזירה מזהה ייחודי שאפשר להשתמש בו כדי להבדיל בין טריגרים אחד מהשני.
החזרות
String
– המזהה הייחודי של הטריגר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/script.scriptapp