Class ClockTriggerBuilder

ClockTriggerBuilder

Ein Builder für Uhrzeitauslöser.

Methoden

MethodeRückgabetypKurzbeschreibung
after(durationMilliseconds)ClockTriggerBuilderGibt die Mindestdauer in Millisekunden an, nach der der Trigger nach der aktuellen Zeit ausgeführt wird.
at(date)ClockTriggerBuilderGibt an, wann der Trigger ausgeführt wird.
atDate(year, month, day)ClockTriggerBuilderGibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten).
atHour(hour)ClockTriggerBuilderGibt die Stunde an, zu der der Trigger ausgeführt wird.
create()TriggerErstellt den Trigger.
everyDays(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Tage ausgeführt werden soll.
everyHours(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Stunden ausgeführt werden soll.
everyMinutes(n)ClockTriggerBuilderHiermit wird angegeben, dass der Trigger alle n Minuten ausgeführt werden soll.
everyWeeks(n)ClockTriggerBuilderGibt an, dass der Trigger alle n Wochen ausgeführt werden soll.
inTimezone(timezone)ClockTriggerBuilderGibt die Zeitzone für die angegebenen Datumsangaben/Uhrzeiten an, zu denen der Trigger ausgeführt wird.
nearMinute(minute)ClockTriggerBuilderGibt die Minute an, zu der der Trigger ausgeführt wird (plus oder minus 15 Minuten).
onMonthDay(day)ClockTriggerBuilderGibt das Datum im Monat an, an dem der Trigger ausgeführt wird.
onWeekDay(day)ClockTriggerBuilderGibt den Wochentag an, an dem der Trigger ausgeführt wird.

Detaillierte Dokumentation

after(durationMilliseconds)

Gibt die Mindestdauer in Millisekunden an, nach der der Trigger nach der aktuellen Zeit ausgeführt wird. Die tatsächliche Dauer kann variieren, ist aber immer länger als die angegebene Mindestdauer.

// Creates a trigger that runs 10 minutes later
ScriptApp.newTrigger('myFunction').timeBased().after(10 * 60 * 1000).create();

Parameter

NameTypBeschreibung
durationMillisecondsIntegerDie Mindestdauer (in Millisekunden) nach der aktuellen Uhrzeit, nach der der Trigger ausgeführt werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


at(date)

Gibt an, wann der Trigger ausgeführt wird.

// Creates a trigger for December 1, 2012
const triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger('myFunction').timeBased().at(triggerDay).create();

Parameter

NameTypBeschreibung
dateDateEin Datumsobjekt, das angibt, wann der Trigger ausgeführt werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


atDate(year, month, day)

Gibt an, dass der Trigger am angegebenen Datum ausgelöst wird, standardmäßig gegen Mitternacht (+/- 15 Minuten).

// Schedules for January 1st, 2013
ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 1, 1).create();

Parameter

NameTypBeschreibung
yearIntegerDas Kalenderjahr, für das der Trigger geplant werden soll.
monthIntegerDer Kalendermonat, in dem der Trigger geplant werden soll. Muss eine Zahl zwischen 1 und 12 sein.
dayIntegerDer Kalendertag, an dem der Trigger geplant werden soll. Die Zahl muss zwischen 1 und 31 liegen.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


atHour(hour)

Gibt die Stunde an, zu der der Trigger ausgeführt wird.

// Runs between 5am-6am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

Parameter

NameTypBeschreibung
hourIntegerDie Stunde, zu der die Aktion ausgeführt werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


create()

Erstellt den Trigger.

Rückflug

Trigger: Der neu erstellte geplante Trigger.


everyDays(n)

Gibt an, dass der Trigger alle n Tage ausgeführt werden soll.

ScriptApp.newTrigger('myFunction').timeBased().everyDays(3).create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Tage zwischen den Ausführungen.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


everyHours(n)

Gibt an, dass der Trigger alle n Stunden ausgeführt werden soll.

ScriptApp.newTrigger('myFunction').timeBased().everyHours(12).create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Stunden zwischen den Ausführungen.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


everyMinutes(n)

Hiermit wird angegeben, dass der Trigger alle n Minuten ausgeführt werden soll. n muss 1, 5, 10, 15 oder 30 sein.

ScriptApp.newTrigger('myFunction').timeBased().everyMinutes(10).create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Minuten zwischen den Ausführungen.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


everyWeeks(n)

Gibt an, dass der Trigger alle n Wochen ausgeführt werden soll.

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .everyWeeks(2)
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

Parameter

NameTypBeschreibung
nIntegerDie Anzahl der Wochen zwischen den Ausführungen.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


inTimezone(timezone)

Gibt die Zeitzone für die angegebenen Datumsangaben/Uhrzeiten an, zu denen der Trigger ausgeführt wird. Standardmäßig ist die Zeitzone die des Scripts.

Die Liste der gültigen Zeitzonenstrings entspricht den gültigen Zeitzonenstrings, die auf Joda.org aufgeführt sind. Ein ungültiger Zeitzonenstring führt dazu, dass das Script einen Fehler auslöst.

// Schedule the trigger to execute at noon every day in the US/Pacific time zone
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(12)
    .everyDays(1)
    .inTimezone('America/Los_Angeles')
    .create();

Parameter

NameTypBeschreibung
timezoneStringDie Zeitzone, in der Zeitangaben im Ereignis behandelt werden sollen.

Rückflug

ClockTriggerBuilder – Dieses ClockTriggerBuilder für die Verkettung.


nearMinute(minute)

Gibt die Minute an, zu der der Trigger ausgeführt wird (plus oder minus 15 Minuten). Wenn nearMinute() nicht aufgerufen wird, wird ein zufälliger Minutenwert verwendet.

// Runs at approximately 5:30am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .nearMinute(30)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

Parameter

NameTypBeschreibung
minuteIntegerDie Minute, zu der die Aktion ausgeführt werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


onMonthDay(day)

Gibt das Datum im Monat an, an dem der Trigger ausgeführt wird.

// Schedules for the first of every month
ScriptApp.newTrigger('myFunction').timeBased().onMonthDay(1).create();

Parameter

NameTypBeschreibung
dayIntegerDer Tag des Monats, an dem der Trigger geplant werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.


onWeekDay(day)

Gibt den Wochentag an, an dem der Trigger ausgeführt wird.

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

Parameter

NameTypBeschreibung
dayWeekdayDer Wochentag, an dem die Aktion ausgeführt werden soll.

Rückflug

ClockTriggerBuilder – Der Builder zur Verkettung.