Class TriggerBuilder

TriggerBuilder

Ein generischer Builder für Skript-Auslöser.

Methoden

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

Detaillierte Dokumentation

forDocument(document)

Erstellt eine DocumentTriggerBuilder und gibt sie zurück, die mit dem angegebenen Dokument verknüpft sind.

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

Parameter

NameTypBeschreibung
documentDocumentdas Dokument

Rückflug

DocumentTriggerBuilder – der neue DocumentTriggerBuilder

Autorisierung

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

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

forDocument(key)

Erstellt eine DocumentTriggerBuilder und gibt sie zurück, die mit dem Dokument mit der angegebenen ID verknüpft sind.

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

Parameter

NameTypBeschreibung
keyStringID des Dokuments

Rückflug

DocumentTriggerBuilder – der neue DocumentTriggerBuilder

Autorisierung

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

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

forForm(form)

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

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

Parameter

NameTypBeschreibung
formFormdas Formular

Rückflug

FormTriggerBuilder – der neue FormTriggerBuilder

Autorisierung

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

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

forForm(key)

Erstellt eine FormTriggerBuilder und gibt sie zurück, die mit dem Formular mit der angegebenen ID verknüpft sind.

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

Parameter

NameTypBeschreibung
keyStringDie ID des Formulars

Rückflug

FormTriggerBuilder – der neue FormTriggerBuilder

Autorisierung

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

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

forSpreadsheet(sheet)

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

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

Parameter

NameTypBeschreibung
sheetSpreadsheetder Tabelle

Rückflug

SpreadsheetTriggerBuilder – der neue TableTriggerBuilder

Autorisierung

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

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

forSpreadsheet(key)

Erstellt eine SpreadsheetTriggerBuilder und gibt sie zurück, die mit der Tabelle mit den angegebenen ID.

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

Parameter

NameTypBeschreibung
keyStringdie ID der Tabelle

Rückflug

SpreadsheetTriggerBuilder – der neue TableTriggerBuilder

Autorisierung

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

  • 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
emailIdStringemail ID des Nutzerkalenders, den der Trigger überwacht.

Rückflug

CalendarTriggerBuilder: Der neue CalendarTriggerBuilder.

Autorisierung

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

  • 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 einen ClockTriggerBuilder und gibt ihn zurück, um zeitbasierte Trigger zu erstellen.

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

Rückflug

ClockTriggerBuilder – der neue ClockTriggerBuilder

Autorisierung

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

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