Class TriggerBuilder

TriggerBuilder

Ein generischer Builder für Skript-Trigger.

Methoden

MethodeRückgabetypKurzbeschreibung
forDocument(document)DocumentTriggerBuilderErstellt ein DocumentTriggerBuilder, das mit dem angegebenen Dokument verknüpft ist, und gibt es zurück.
forDocument(key)DocumentTriggerBuilderErstellt ein DocumentTriggerBuilder, das mit dem Dokument mit der angegebenen ID verknüpft ist, und gibt es zurück.
forForm(form)FormTriggerBuilderErstellt ein FormTriggerBuilder, das mit dem angegebenen Formular verknüpft ist, und gibt es zurück.
forForm(key)FormTriggerBuilderErstellt ein FormTriggerBuilder, das mit dem Formular mit der angegebenen ID verknüpft ist, und gibt es zurück.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderErstellt eine SpreadsheetTriggerBuilder, die mit der angegebenen Tabelle verknüpft ist, und gibt sie zurück.
forSpreadsheet(key)SpreadsheetTriggerBuilderErstellt ein SpreadsheetTriggerBuilder, das mit der Tabelle mit der angegebenen ID verknüpft ist, und gibt es zurück.
forUserCalendar(emailId)CalendarTriggerBuilderGibt einen Builder zum Erstellen von Kalendertriggern zurück.
timeBased()ClockTriggerBuilderErstellt ein ClockTriggerBuilder zum Erstellen zeitbasierter Trigger und gibt es zurück.

Detaillierte Dokumentation

forDocument(document)

Erstellt ein DocumentTriggerBuilder, das mit dem angegebenen Dokument verknüpft ist, und gibt es zurück. 

ScriptApp.newTrigger('myFunction')
    .forDocument(DocumentApp.getActiveDocument())
    .onOpen()
    .create();

Parameter

NameTypBeschreibung
documentDocumentDas Dokument.

Rückflug

DocumentTriggerBuilder: Der neue DocumentTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forDocument(key)

Erstellt ein DocumentTriggerBuilder, das mit dem Dokument mit der angegebenen ID verknüpft ist, und gibt es zurück. 

ScriptApp.newTrigger('myFunction')
    .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
    .onOpen()
    .create();

Parameter

NameTypBeschreibung
keyStringDie ID des Dokuments.

Rückflug

DocumentTriggerBuilder: Der neue DocumentTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forForm(form)

Erstellt ein FormTriggerBuilder, das mit dem angegebenen Formular verknüpft ist, und gibt es zurück. 

ScriptApp.newTrigger('myFunction')
    .forForm(FormApp.getActiveForm())
    .onFormSubmit()
    .create();

Parameter

NameTypBeschreibung
formFormDas Formular.

Rückflug

FormTriggerBuilder: Der neue FormTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forForm(key)

Erstellt ein FormTriggerBuilder, das mit dem Formular mit der angegebenen ID verknüpft ist, und gibt es zurück. 

ScriptApp.newTrigger('myFunction')
    .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
    .onFormSubmit()
    .create();

Parameter

NameTypBeschreibung
keyStringDie ID des Formulars.

Rückflug

FormTriggerBuilder: Der neue FormTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forSpreadsheet(sheet)

Erstellt eine SpreadsheetTriggerBuilder, die mit der angegebenen Tabelle verknüpft ist, und gibt sie zurück. 

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet(SpreadsheetApp.getActive())
    .onEdit()
    .create();

Parameter

NameTypBeschreibung
sheetSpreadsheetDie Tabelle.

Rückflug

SpreadsheetTriggerBuilder – Der neue SpreadsheetTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forSpreadsheet(key)

Erstellt ein SpreadsheetTriggerBuilder, das mit der Tabelle mit der angegebenen ID verknüpft ist, und gibt es zurück. 

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
    .onEdit()
    .create();

Parameter

NameTypBeschreibung
keyStringDie ID der Tabelle.

Rückflug

SpreadsheetTriggerBuilder – Der neue SpreadsheetTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forUserCalendar(emailId)

Gibt einen Builder zum Erstellen von Kalendertriggern zurück.

Parameter

NameTypBeschreibung
emailIdStringE-Mail-ID des Nutzerkalenders, der vom Trigger überwacht wird.

Rückflug

CalendarTriggerBuilder: Der neue CalendarTriggerBuilder.

Autorisierung

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

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.google.com/calendar/feeds

timeBased()

Erstellt ein ClockTriggerBuilder zum Erstellen zeitbasierter Trigger und gibt es zurück. 

ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 10, 31).create();

Rückflug

ClockTriggerBuilder: Der neue ClockTriggerBuilder.

Autorisierung

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

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