Class TriggerBuilder

TriggerBuilder

Un compilador genérico para activadores de secuencias de comandos

Métodos

MétodoTipo de datos que se muestraDescripción breve
forDocument(document)DocumentTriggerBuilderCrea y muestra un DocumentTriggerBuilder vinculado al documento dado.
forDocument(key)DocumentTriggerBuilderCrea y muestra un DocumentTriggerBuilder vinculado al documento con el ID determinado.
forForm(form)FormTriggerBuilderCrea y muestra un FormTriggerBuilder vinculado al formulario dado.
forForm(key)FormTriggerBuilderCrea y muestra un FormTriggerBuilder vinculado al formulario con el ID determinado.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCrea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo determinada.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo con el ID determinado.
forUserCalendar(emailId)CalendarTriggerBuilderMuestra un compilador para compilar activadores de calendario.
timeBased()ClockTriggerBuilderCrea y muestra un ClockTriggerBuilder para compilar activadores basados en el tiempo.

Documentación detallada

forDocument(document)

Crea y muestra un DocumentTriggerBuilder vinculado al documento dado.

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

Parámetros

NombreTipoDescripción
documentDocumentel documento

Devolvedor

DocumentTriggerBuilder: Es el nuevo DocumentTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forDocument(key)

Crea y muestra un DocumentTriggerBuilder vinculado al documento con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringel ID del documento

Devolvedor

DocumentTriggerBuilder: Es el nuevo DocumentTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forForm(form)

Crea y muestra un FormTriggerBuilder vinculado al formulario dado.

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

Parámetros

NombreTipoDescripción
formFormel formulario

Devolvedor

FormTriggerBuilder: Es el nuevo FormTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forForm(key)

Crea y muestra un FormTriggerBuilder vinculado al formulario con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringel ID del formulario

Devolvedor

FormTriggerBuilder: Es el nuevo FormTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forSpreadsheet(sheet)

Crea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo determinada.

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

Parámetros

NombreTipoDescripción
sheetSpreadsheetla hoja de cálculo

Devolvedor

SpreadsheetTriggerBuilder: el nuevo spreadsheetsTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forSpreadsheet(key)

Crea y muestra un SpreadsheetTriggerBuilder vinculado a la hoja de cálculo con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringel ID de la hoja de cálculo

Devolvedor

SpreadsheetTriggerBuilder: el nuevo spreadsheetsTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

forUserCalendar(emailId)

Muestra un compilador para compilar activadores de calendario.

Parámetros

NombreTipoDescripción
emailIdStringID de correo electrónico del calendario del usuario que supervisa el activador.

Devolvedor

CalendarTriggerBuilder: Es el nuevo CalendarTriggerBuilder.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • 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()

Crea y muestra un ClockTriggerBuilder para compilar activadores basados en el tiempo.

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

Devolvedor

ClockTriggerBuilder: el nuevo ClockTriggerBuilder

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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