Class Trigger

Trigger

Ein Skript-Trigger.

Methoden

MethodeRückgabetypKurzbeschreibung
getEventType()EventTypeGibt den Ereignistyp zurück, bei dem der Trigger ausgelöst wird.
getHandlerFunction()StringGibt die Funktion zurück, die aufgerufen wird, wenn der Trigger ausgelöst wird.
getTriggerSource()TriggerSourceGibt die Quelle der Ereignisse zurück, die den Trigger auslösen.
getTriggerSourceId()StringGibt die für die Quelle spezifische ID zurück.
getUniqueId()StringGibt eine eindeutige ID zurück, mit der sich Trigger voneinander unterscheiden lassen.

Detaillierte Dokumentation

getEventType()

Gibt den Ereignistyp zurück, bei dem der Trigger ausgelöst wird.

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
  }
}

Rückgabe

EventType : Der Ereignistyp, für den dies ein Trigger ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/script.scriptapp

getHandlerFunction()

Gibt die Funktion zurück, die aufgerufen wird, wenn der Trigger ausgelöst wird.

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('id of my spreadsheet')
    .onEdit()
    .create();
Logger.log(ScriptApp.getProjectTriggers()[0]
               .getHandlerFunction());  // logs "myFunction"

Rückgabe

String : Der Methodenname.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSource()

Gibt die Quelle der Ereignisse zurück, die den Trigger auslösen.

Beispiel: Ein Tabellenkalkulations-Trigger vom Typ „onEdit“ gibt SPREADSHEETS zurück, ein zeitbasierter Trigger 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`);
  }
}

Rückgabe

TriggerSource : Der Publisher, für den dies ein Trigger ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSourceId()

Gibt die für die Quelle spezifische ID zurück.

Wenn die Triggerquelle beispielsweise eine Tabellenkalkulation ist, ist dies die ID der Tabellenkalkulation. Bei Uhrzeitereignissen wird null zurückgegeben.

Rückgabe

String : Die ID der Entität im Publisher, für die dies ein Trigger ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/script.scriptapp

getUniqueId()

Gibt eine eindeutige ID zurück, mit der sich Trigger voneinander unterscheiden lassen.

Rückgabe

String : Die eindeutige ID des Triggers.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/script.scriptapp