Acionadores simples e acionadores instaláveis permitem que o Apps Script execute uma função automaticamente se um determinado evento ocorrer. Quando um acionador é disparado, o Apps Script transmite à função um objeto de evento como argumento, normalmente chamado de e
. O objeto do evento contém informações sobre o contexto que causou o disparo do acionador. Por exemplo, o exemplo de código abaixo mostra um acionador onEdit(e)
simples para um script do Planilhas Google que usa o objeto de evento para determinar qual célula foi editada.
function onEdit(e){
// Set a comment on the edited cell to indicate when it was changed.
var range = e.range;
range.setNote('Last modified: ' + new Date());
}
Nesta página, detalhamos os campos no objeto de evento para diferentes tipos de acionadores.
Eventos do Planilhas Google
Os vários acionadores específicos do Planilhas Google permitem que os scripts respondam às ações de um usuário em uma planilha.
Abrir(simples e instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
source |
Um objeto Spreadsheet |
triggerUid |
ID do acionador que produziu esse evento (somente acionadores instaláveis). 4034124084959907503 |
user |
Um objeto amin@example.com |
Mudar(instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado FULL |
changeType |
O tipo de alteração ( INSERT_ROW |
source |
Um objeto
Spreadsheet |
triggerUid |
ID do acionador que produziu esse evento. 4034124084959907503 |
user |
Um objeto amin@example.com |
Editar(simples e instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
oldValue |
Valor da célula antes da edição, se houver. Disponível apenas se o intervalo editado for uma única célula. Será indefinido se a célula não tiver conteúdo anterior. 1234 |
range |
Um objeto Range |
source |
Um objeto Spreadsheet |
triggerUid |
ID do acionador que produziu esse evento (somente acionadores instaláveis). 4034124084959907503 |
user |
Um objeto amin@example.com |
value |
Novo valor da célula após a edição. Disponível apenas se o intervalo editado for uma única célula. 10 |
Envio de formulário(instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado FULL |
namedValues |
Um objeto que contém os nomes e valores das perguntas do envio do formulário. { 'First Name': ['Jane'], 'Timestamp': ['6/7/2015 20:54:13'], 'Last Name': ['Doe'] } |
range |
Um objeto Range |
triggerUid |
ID do acionador que produziu esse evento. 4034124084959907503 |
values |
Matriz com os valores na mesma ordem em que aparecem na planilha. ['2015/05/04 15:00', 'amin@example.com', 'Bob', '27', 'Bill', '28', 'Susan', '25'] |
Eventos dos Documentos Google
Os acionadores permitem que o Documentos Google responda quando um usuário abrir um arquivo.
Abrir(simples e instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
source |
Um objeto Document |
triggerUid |
ID do acionador que produziu esse evento (somente acionadores instaláveis). 4034124084959907503 |
user |
Um objeto amin@example.com |
Eventos do Apresentações Google
Os acionadores permitem que o Apresentações Google responda quando um usuário abrir uma apresentação.
Abrir(simples) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
source |
Um objeto Presentation |
user |
Um objeto amin@example.com |
Eventos dos Formulários Google
Os acionadores específicos do Formulários Google permitem que os scripts respondam quando um usuário edita um formulário ou envia uma resposta.
Abrir* (simples e instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
source |
Um objeto Form |
triggerUid |
ID do acionador que produziu esse evento (somente acionadores instaláveis). 4034124084959907503 |
user |
Um objeto amin@example.com |
* Esse evento não ocorre quando um usuário abre um formulário para responder, mas quando um editor abre o formulário para modificá-lo.
Envio de formulário(instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado FULL |
response |
Um objeto FormResponse |
source |
Um objeto Form |
triggerUid |
ID do acionador que produziu esse evento. 4034124084959907503 |
Eventos do Google Agenda
Os acionadores da agenda são disparados quando os eventos da agenda de um usuário são atualizados (criados, editados ou excluídos).
Esses acionadores não informam qual evento foi alterado ou como. Em vez disso, eles indicam que seu código precisa fazer uma operação de sincronização incremental para captar mudanças recentes na agenda. Para uma descrição completa desse procedimento, consulte o Guia de sincronização de recursos da API Calendar.
Para sincronizar com o Google Agenda no Apps Script, siga estas etapas:
- Ative o serviço avançado do Agenda para o projeto de script. O serviço Google Agenda integrado não é suficiente para este fluxo de trabalho.
- Determine quais agendas devem ser sincronizadas. Para cada agenda, execute uma operação de sincronização inicial usando o método Events.list() do serviço avançado do Agenda.
- O resultado da sincronização inicial retorna um
nextSyncToken
para essa agenda. Armazene esse token para uso posterior. - Quando o acionador
EventUpdated
do Apps Script for disparado indicando uma alteração em um evento da agenda, faça uma sincronização incremental para a agenda afetada usando onextSyncToken
armazenado. Essa é essencialmente outra solicitação Events.list(), mas fornecer onextSyncToken
limita a resposta apenas aos eventos que mudaram desde a última sincronização. - Examine a resposta da sincronização para saber quais eventos foram atualizados e fazer com que seu código responda de maneira adequada. Por exemplo, é possível registrar a alteração, atualizar uma planilha, enviar avisos por e-mail ou realizar outras ações.
- Atualize o
nextSyncToken
armazenado para essa agenda com o retornado pela solicitação de sincronização incremental. Isso força a próxima operação de sincronização a retornar apenas as alterações mais atuais.
EventUpdated(instalável) |
|
---|---|
authMode |
Um valor da enumeração FULL |
calendarId |
O ID da string da agenda em que a atualização do evento ocorreu. susan@example.com |
triggerUid |
ID do acionador que produziu esse evento. 4034124084959907503 |
Eventos de complementos do Google Workspace
O acionador onInstall()
é executado
automaticamente quando um usuário instala um complemento.
Instalar(simples) |
|
---|---|
authMode |
Um valor do tipo enumerado FULL |
Eventos do app Google Chat
Para saber mais sobre objetos de evento no Google Chat, consulte Receber e responder a interações com o app do Google Chat.
Eventos com base no tempo
Os gatilhos baseados em tempo (também chamados de gatilhos de relógio) permitem que os scripts sejam executados em um momento específico ou em um intervalo recorrente.
Baseado no tempo (instalável) | |
---|---|
authMode |
Um valor do tipo enumerado FULL |
day-of-month |
Entre Como esse nome de propriedade contém traços, ele precisa ser acessado por meio do 31 |
day-of-week |
Entre Como esse nome de propriedade contém traços, ele precisa ser acessado por meio do 7 |
hour |
Entre 23 |
minute |
Entre 59 |
month |
Entre 12 |
second |
Entre 59 |
timezone |
O fuso horário. UTC |
triggerUid |
ID do acionador que produziu esse evento. 4034124084959907503 |
week-of-year |
Entre Como esse nome de propriedade contém traços, ele precisa ser acessado por meio do 52 |
year |
O ano. 2015 |