Class ClockTriggerBuilder

Especifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado. A duração real pode variar, mas não será menor que o mínimo especificado.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica quando o acionador é executado.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica que o acionador é acionado na data especificada, por padrão perto da meia-noite (+/- 15 minutos).

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica a hora em que o acionador é executado.

// 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();

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Cria o gatilho.

Retornar

Trigger: o gatilho programado recém-criado.

Especifica a execução do acionador a cada n dias.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica a execução do acionador a cada n horas.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica a execução do acionador a cada n minutos. n precisa ser 1, 5, 10, 15 ou 30.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica a execução do acionador a cada n semanas.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica o fuso horário para as datas/horas especificadas quando o acionador é executado. Por padrão, o fuso horário é o do script.

A lista de strings de fuso horário válidas corresponde às strings de fuso horário listadas pela Joda.org. Uma string de fuso horário inválida faz com que o script gere um erro.

// 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();

Parâmetros

Retornar

ClockTriggerBuilder: ClockTriggerBuilder para encadeamento.

Especifica o minuto em que o acionador é executado (mais ou menos 15 minutos). Se nearMinute() não for chamado, um valor aleatório de minutos será usado.

// 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();

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica a data do mês em que o acionador é executado.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.

Especifica o dia da semana em que o acionador é executado.

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

Parâmetros

Retornar

ClockTriggerBuilder: o builder para encadeamento.