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 beim Auslösen des Triggers aufgerufen 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 Kennung zurück, mit der Trigger voneinander unterschieden werden können.

Detaillierte Dokumentation

getEventType()

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

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

Return

EventType – der Ereignistyp, für den dies ein Trigger ist.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getHandlerFunction()

Gibt die Funktion zurück, die beim Auslösen des Triggers aufgerufen 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"

Return

String: der Methodenname

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTriggerSource()

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

Ein onEdit-Trigger in einer Tabellenkalkulation gibt beispielsweise SPREADSHEETS und ein zeitbasierter Trigger CLOCK zurück.

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");
  }
}

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTriggerSourceId()

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

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getUniqueId()

Gibt eine eindeutige Kennung zurück, mit der Trigger voneinander unterschieden werden können.

Return

String: die eindeutige Kennung des Triggers

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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