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 especificado. |
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 um SpreadsheetTriggerBuilder vinculado à planilha com o ID fornecido. |
forUserCalendar(emailId) | CalendarTriggerBuilder | Retorna um builder para criar acionadores da 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 |
Retorno
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 fornecido.
ScriptApp.newTrigger('myFunction') .forDocument('1234567890abcdefghijklmnopqrstuvwxyz') .onOpen() .create();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | o ID do documento |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
form | Form | o formulário |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
key | String | o ID do formulário |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
sheet | Spreadsheet | na planilha |
Retorno
SpreadsheetTriggerBuilder
: o novo sheetsTriggerBuilder
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
Nome | Tipo | Descrição |
---|---|---|
key | String | o ID da planilha |
Retorno
SpreadsheetTriggerBuilder
: o novo sheetsTriggerBuilder
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 acionadores da agenda.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
emailId | String | ID de e-mail da agenda do usuário que o acionador monitora. |
Retorno
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();
Retorno
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