Class 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 – שם השיטה

אישור

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

  • 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