Class Trigger

Trigger

טריגר לסקריפט.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getEventType()EventTypeמחזירה את סוג האירוע שהטריגר מופעל בו.
getHandlerFunction()Stringמחזירה את הפונקציה שמופעלת כשהטריגר מופעל.
getTriggerSource()TriggerSourceהפונקציה מחזירה את מקור האירועים שגורמים להפעלת הטריגר.
getTriggerSourceId()Stringמחזירה את המזהה הספציפי למקור.
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 – סוג האירוע שמוגדר כטריגר.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 – שם ה-method.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 — בעל התוכן הדיגיטלי שהפעולה הזו היא טריגר עבורו.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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