Se usó la API de Cloud Translation para traducir esta página.

Class ClockTriggerBuilder

Es un compilador para activadores de reloj.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`after(durationMilliseconds)`	`ClockTriggerBuilder`	Especifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador.
`at(date)`	`ClockTriggerBuilder`	Especifica cuándo se ejecuta el activador.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Especifica que el activador se activa en la fecha determinada, de forma predeterminada, cerca de la medianoche (+/- 15 minutos).
`atHour(hour)`	`ClockTriggerBuilder`	Especifica la hora a la que se ejecuta el activador.
`create()`	`Trigger`	Crea el activador.
`everyDays(n)`	`ClockTriggerBuilder`	Especifica que se debe ejecutar el activador cada `n` días.
`everyHours(n)`	`ClockTriggerBuilder`	Especifica que se debe ejecutar el activador cada `n` horas.
`everyMinutes(n)`	`ClockTriggerBuilder`	Especifica que se debe ejecutar el activador cada `n` minutos.
`everyWeeks(n)`	`ClockTriggerBuilder`	Especifica que se debe ejecutar el activador cada `n` semanas.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Especifica la zona horaria para las fechas o horas especificadas cuando se ejecuta el activador.
`nearMinute(minute)`	`ClockTriggerBuilder`	Especifica el minuto en el que se ejecuta el activador (más o menos 15 minutos).
`onMonthDay(day)`	`ClockTriggerBuilder`	Especifica la fecha del mes en la que se ejecuta el activador.
`onWeekDay(day)`	`ClockTriggerBuilder`	Especifica el día de la semana en el que se ejecuta el activador.

Documentación detallada

`after(durationMilliseconds)`

Especifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador. La duración real puede variar, pero no será inferior al mínimo especificado.

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

Parámetros

Nombre	Tipo	Descripción
`durationMilliseconds`	`Integer`	Es la duración mínima (en milisegundos) después de la hora actual en la que se debe ejecutar el activador.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`at(date)`

Especifica cuándo se ejecuta el activador.

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

Parámetros

Nombre	Tipo	Descripción
`date`	`Date`	Un objeto Date que representa cuándo se debe ejecutar el activador.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`atDate(year, month, day)`

Especifica que el activador se activa en la fecha determinada, de forma predeterminada, cerca de la medianoche (+/- 15 minutos).

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

Parámetros

Nombre	Tipo	Descripción
`year`	`Integer`	Es el año calendario para programar el activador.
`month`	`Integer`	Es el mes calendario en el que se programará el activador (debe ser un número entre 1 y 12 inclusive).
`day`	`Integer`	Es el día del calendario en el que se programará el activador (debe ser un número entre 1 y 31 inclusive).

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`atHour(hour)`

Especifica la hora a la que se ejecuta el activador.

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

Nombre	Tipo	Descripción
`hour`	`Integer`	La hora a la que se debe activar.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`create()`

Crea el activador.

Volver

Trigger: Es el activador programado recién creado.

`everyDays(n)`

Especifica que se debe ejecutar el activador cada n días.

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

Parámetros

Nombre	Tipo	Descripción
`n`	`Integer`	Es la cantidad de días entre las ejecuciones.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`everyHours(n)`

Especifica que se debe ejecutar el activador cada n horas.

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

Parámetros

Nombre	Tipo	Descripción
`n`	`Integer`	Es la cantidad de horas entre las ejecuciones.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`everyMinutes(n)`

Especifica que se debe ejecutar el activador cada n minutos. n debe ser 1, 5, 10, 15 o 30.

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

Parámetros

Nombre	Tipo	Descripción
`n`	`Integer`	Es la cantidad de minutos entre las ejecuciones.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`everyWeeks(n)`

Especifica que se debe ejecutar el activador cada n semanas.

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

Parámetros

Nombre	Tipo	Descripción
`n`	`Integer`	Es la cantidad de semanas entre las ejecuciones.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`inTimezone(timezone)`

Especifica la zona horaria para las fechas o horas especificadas cuando se ejecuta el activador. De forma predeterminada, la zona horaria es la de la secuencia de comandos.

La lista de cadenas de zona horaria válidas corresponde a las cadenas de zona horaria válidas que enumera Joda.org. Una cadena de zona horaria no válida hace que la secuencia de comandos genere un error.

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

Nombre	Tipo	Descripción
`timezone`	`String`	Es la zona horaria con la que se debe tratar la información de hora en el evento.

Volver

ClockTriggerBuilder: Este ClockTriggerBuilder, para encadenar.

`nearMinute(minute)`

Especifica el minuto en el que se ejecuta el activador (más o menos 15 minutos). Si no se llama a nearMinute(), se usa un valor de minuto aleatorio.

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

Nombre	Tipo	Descripción
`minute`	`Integer`	Es el minuto en el que se debe activar.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`onMonthDay(day)`

Especifica la fecha del mes en la que se ejecuta el activador.

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

Parámetros

Nombre	Tipo	Descripción
`day`	`Integer`	Es el día del mes para el que se debe programar el activador.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.

`onWeekDay(day)`

Especifica el día de la semana en el que se ejecuta el activador.

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

Parámetros

Nombre	Tipo	Descripción
`day`	`Weekday`	El día de la semana en el que se debe activar.

Volver

ClockTriggerBuilder: Es el compilador para encadenar.