Class TriggerBuilder

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
TriggerBuilder

Um builder genérico para acionadores de scripts.

Métodos

MétodoTipo de retornoBreve descrição
forDocument(document)DocumentTriggerBuilderCria e retorna um DocumentTriggerBuilder vinculado ao documento especificado.
forDocument(key)DocumentTriggerBuilderCria e retorna um DocumentTriggerBuilder vinculado ao documento com o ID informado.
forForm(form)FormTriggerBuilderCria e retorna um FormTriggerBuilder vinculado ao formulário especificado.
forForm(key)FormTriggerBuilderCria e retorna um FormTriggerBuilder vinculado ao formulário com o ID fornecido.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCria e retorna um SpreadsheetTriggerBuilder vinculado à planilha especificada.
forSpreadsheet(key)SpreadsheetTriggerBuilderCria e retorna um SpreadsheetTriggerBuilder vinculado à planilha com o ID fornecido.
forUserCalendar(emailId)CalendarTriggerBuilderRetorna um builder para criar gatilhos de agenda.
timeBased()ClockTriggerBuilderCria e retorna um ClockTriggerBuilder para criar gatilhos baseados em tempo.

Documentação detalhada

forDocument(document)

Cria e retorna um DocumentTriggerBuilder vinculado ao documento especificado.

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

Parâmetros

NomeTipoDescrição
documentDocumento documento

Retornar

DocumentTriggerBuilder: o novo DocumentTriggerBuilder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forDocument(key)

Cria e retorna um DocumentTriggerBuilder vinculado ao documento com o ID informado.

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

Parâmetros

NomeTipoDescrição
keyStringo ID do documento

Retornar

DocumentTriggerBuilder: o novo DocumentTriggerBuilder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forForm(form)

Cria e retorna um FormTriggerBuilder vinculado ao formulário especificado.

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

Parâmetros

NomeTipoDescrição
formFormo formulário

Retornar

FormTriggerBuilder: o novo FormTriggerBuilder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forForm(key)

Cria e retorna um FormTriggerBuilder vinculado ao formulário com o ID fornecido.

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

Parâmetros

NomeTipoDescrição
keyStringo ID do formulário.

Retornar

FormTriggerBuilder: o novo FormTriggerBuilder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forSpreadsheet(sheet)

Cria e retorna um SpreadsheetTriggerBuilder vinculado à planilha especificada.

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

Parâmetros

NomeTipoDescrição
sheetSpreadsheeta planilha

Retornar

SpreadsheetTriggerBuilder: o novo spreadsheetTriggerBuilder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forSpreadsheet(key)

Cria e retorna um SpreadsheetTriggerBuilder vinculado à planilha com o ID fornecido.

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

Parâmetros

NomeTipoDescrição
keyStringo ID da planilha.

Retornar

SpreadsheetTriggerBuilder: o novo spreadsheetTriggerBuilder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

forUserCalendar(emailId)

Retorna um builder para criar gatilhos de agenda.

Parâmetros

NomeTipoDescrição
emailIdStringID do e-mail da agenda de usuários que o gatilho monitora.

Retornar

CalendarTriggerBuilder: o novo CalendarTriggerBuilder.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Cria e retorna um ClockTriggerBuilder para criar gatilhos baseados em tempo.

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

Retornar

ClockTriggerBuilder: o novo ClockTriggerBuilder

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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