Esta página foi traduzida pela API Cloud Translation.

Class TriggerBuilder

Um builder genérico para acionadores de script.

Métodos

Método	Tipo de retorno	Breve descrição
`forDocument(document)`	`DocumentTriggerBuilder`	Cria e retorna um `DocumentTriggerBuilder` vinculado ao documento especificado.
`forDocument(key)`	`DocumentTriggerBuilder`	Cria e retorna um `DocumentTriggerBuilder` vinculado ao documento com o ID fornecido.
`forForm(form)`	`FormTriggerBuilder`	Cria e retorna um `FormTriggerBuilder` vinculado ao formulário fornecido.
`forForm(key)`	`FormTriggerBuilder`	Cria e retorna um `FormTriggerBuilder` vinculado ao formulário com o ID fornecido.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	Cria e retorna um `SpreadsheetTriggerBuilder` vinculado à planilha especificada.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	Cria e retorna uma `SpreadsheetTriggerBuilder` vinculada à planilha com a ID.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	Retorna um builder para criar acionadores de agenda.
`timeBased()`	`ClockTriggerBuilder`	Cria 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

Nome	Tipo	Descrição
`document`	`Document`	o documento

Retornar

DocumentTriggerBuilder: o novo DocumentTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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 fornecido.

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	o ID do documento

Retornar

DocumentTriggerBuilder: o novo DocumentTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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 fornecido.

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

Parâmetros

Nome	Tipo	Descrição
`form`	`Form`	o formulário

Retornar

FormTriggerBuilder: o novo FormTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`key`	`String`	o ID do formulário

Retornar

FormTriggerBuilder: o novo FormTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
`sheet`	`Spreadsheet`	na planilha

Retornar

SpreadsheetTriggerBuilder: o novo SpreadsheetTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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 uma SpreadsheetTriggerBuilder vinculada à planilha com a ID.

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	o ID da planilha

Retornar

SpreadsheetTriggerBuilder: o novo SpreadsheetTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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 acionadores de agenda.

Parâmetros

Nome	Tipo	Descrição
`emailId`	`String`	ID de e-mail da agenda do usuário monitorada pelo acionador.

Retornar

CalendarTriggerBuilder: o novo CalendarTriggerBuilder.

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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