Class TriggerBuilder

TriggerBuilder

Es un compilador genérico para activadores de secuencias de comandos.

Métodos

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

Documentación detallada

forDocument(document)

Crea y devuelve un DocumentTriggerBuilder vinculado al documento determinado.

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

Parámetros

NombreTipoDescripción
documentDocumentEs el documento.

Volver

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 devuelve un DocumentTriggerBuilder vinculado al documento con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringEs el ID del documento.

Volver

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 devuelve un FormTriggerBuilder vinculado al formulario determinado.

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

Parámetros

NombreTipoDescripción
formFormEs el formulario.

Volver

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 devuelve un FormTriggerBuilder vinculado al formulario con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringEs el ID del formulario.

Volver

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 devuelve un objeto SpreadsheetTriggerBuilder vinculado a la hoja de cálculo proporcionada.

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

Parámetros

NombreTipoDescripción
sheetSpreadsheetLa hoja de cálculo

Volver

SpreadsheetTriggerBuilder: El nuevo SpreadsheetTriggerBuilder.

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 devuelve un objeto SpreadsheetTriggerBuilder vinculado a la hoja de cálculo con el ID determinado.

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

Parámetros

NombreTipoDescripción
keyStringEs el ID de la hoja de cálculo.

Volver

SpreadsheetTriggerBuilder: El nuevo SpreadsheetTriggerBuilder.

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)

Devuelve un compilador para crear activadores de calendario.

Parámetros

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

Volver

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 devuelve un ClockTriggerBuilder para compilar activadores basados en el tiempo.

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

Volver

ClockTriggerBuilder: Es 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