Objetos de evento

Acionadores simples e acionadores instaláveis permitem que o Apps Script executar uma função automaticamente se um determinado evento ocorrer. Quando um acionador é disparado, O Apps Script transmite à função um objeto de evento como um argumento, normalmente chamado e: O objeto de evento contém informações sobre o contexto que causou a gatilho para disparar. Por exemplo, o exemplo de código abaixo mostra uma onEdit(e) simples acionador para um script das 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());
}

Esta página detalha os campos no objeto de evento para diferentes tipos de gatilhos.

Os eventos produzidos por acionadores instaláveis contêm um triggerUid identifica o gatilho que produziu o evento. Isso é útil para scripts que têm vários gatilhos instaláveis.

Eventos do Planilhas Google

Os vários gatilhos específicos do Planilhas Google permitem que os scripts respondam à solicitação ações em uma planilha.

Abrir (simples e instalável)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. LIMITED
source	Uma Spreadsheet que representa o arquivo do Planilhas Google ao qual o script está vinculado. Spreadsheet
triggerUid	ID do acionador que produziu este evento (somente acionadores instaláveis). 4034124084959907503
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]

Mudar (instalável)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. FULL
changeType	O tipo de alteração (EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT ou OTHER). INSERT_ROW
source	Um Spreadsheet , representando o arquivo do Planilhas Google no qual o script está presos. Spreadsheet
triggerUid	ID do acionador que produziu este evento. 4034124084959907503
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]

Editar (simples e instalável)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. LIMITED
oldValue	Valor da célula anterior à edição, se houver. Disponível apenas no o intervalo é uma única célula. Será indefinido se a célula não tiver valores anteriores conteúdo. 1234
range	Um objeto Range, que representa a célula ou intervalo de células que foi editado. Range
source	Uma Spreadsheet que representa o arquivo do Planilhas Google ao qual o script está vinculado. Spreadsheet
triggerUid	ID do acionador que produziu este evento (somente acionadores instaláveis). 4034124084959907503
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]
value	Novo valor da célula após a edição. Disponível apenas se o intervalo editado for um uma única célula. 10

Envio de formulário (instalável)
Cuidado:use o gatilho de envio de formulário com SpreadsheetTriggerBuilder.
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. 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, que representa a célula ou intervalo de células que foi editado. Range
triggerUid	ID do acionador que produziu este evento. 4034124084959907503
values	Matriz com valores na mesma ordem em que eles aparecem na planilha. ['2015/05/04 15:00', '[e-mail]', 'Bob', '27', 'Bill', '28', 'Susan', '25']

Eventos do Documentos Google

Os acionadores permitem que os Documentos Google respondam quando um usuário abre um arquivo.

Abrir (simples e instalável)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. LIMITED
source	Um objeto Document, que representa o arquivo dos Documentos Google ao qual o script está vinculado. Document
triggerUid	ID do acionador que produziu este evento (somente acionadores instaláveis). 4034124084959907503
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]

Eventos do Apresentações Google

Os acionadores permitem que o Apresentações Google responda quando um usuário abre uma apresentação.

Abrir (simples)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. LIMITED
source	Um objeto Presentation, representando o arquivo das Apresentações Google ao qual o script está vinculado. Presentation
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]

Eventos do app Formulários Google

Os acionadores específicos dos 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 ScriptApp.AuthMode. LIMITED
source	Um objeto Form, que representa o arquivo do Formulários Google ao qual o script está vinculado. Form
triggerUid	ID do acionador que produziu este evento (somente acionadores instaláveis). 4034124084959907503
user	Um objeto User, que representam o usuário ativo, se disponível (dependendo de um conjunto complexo de restrições de segurança). [e-mail]

* Esse evento não ocorre quando um usuário abre um formulário para responder, mas em vez quando um editor abre o formulário para modificá-lo.

Envio de formulário (instalável)
Cuidado:use o gatilho de envio de formulário com FormTriggerBuilder.
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. FULL
response	Um objeto FormResponse, que representa a resposta do usuário para o formulário como um todo. FormResponse
source	Um objeto Form, que representa o arquivo do Formulários Google ao qual o script está vinculado. Form
triggerUid	ID do acionador que produziu este evento. 4034124084959907503

Eventos do Google Agenda

Os acionadores da agenda são acionados quando os eventos da agenda de um usuário são atualizados (criados, editados ou excluídos).

Esses acionadores não informam qual evento mudou ou como ele mudou. Em vez disso, eles indicam que o código precisa fazer uma operação de sincronização incremental para selecionar as alterações recentes na agenda. Para uma descrição completa deste procedimento, consulte a Guia de sincronização de recursos para o API Calendar.

Para sincronizar com o Google Agenda no Apps Script, siga estas etapas:

1. Ative o serviço avançado do Agenda para o projeto de script. O modelo O serviço Agenda não é suficiente para: esse fluxo de trabalho.
2. Determine quais agendas devem ser sincronizadas. Para cada agenda desse tipo, executar uma sincronização inicial do Google Agenda usando a interface de usuário método Events.list().
3. O resultado da sincronização inicial retorna um nextSyncToken para essa agenda. Armazene esse token para uso posterior.
4. Quando o acionador EventUpdated do Apps Script é disparado, indicando uma agenda alteração de evento, faça uma sincronização incremental da agenda afetada usando o nextSyncToken armazenado. Isso é essencialmente outro Events.list() solicitação, mas fornecer o nextSyncToken limita a resposta apenas eventos que foram alterados desde a última sincronização.
5. Examine a resposta da sincronização para saber quais eventos foram atualizados e faça com que seu código responda adequadamente. Por exemplo, é possível registrar a alteração, atualizar uma planilha, enviar avisos por e-mail ou realizar outras ações.
6. 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 retorna apenas as alterações mais atuais.

.

Atenção: às vezes, os tokens de sincronização são invalidados pelo servidor, o que resulta 410. Quando isso acontece, o código deve realizar uma sincronização completa e substituir todos os dados e tokens sincronizados armazenados que você tem para essa agenda.

EventUpdated (instalável)
authMode	Um valor do parâmetro ScriptApp.AuthMode tipo enumerado. FULL
calendarId	O ID da string da agenda em que a atualização do evento ocorreu. [e-mail]
triggerUid	ID do acionador que produziu este evento. 4034124084959907503

Eventos de complementos do Google Workspace

O gatilho onInstall() é executado automaticamente quando um usuário instala um complemento.

Instalar (simples)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. FULL

Eventos do app Google Chat

Saiba mais sobre os objetos de evento no Google Chat em Receber e responder a interações com seu app do Google Chat.

Eventos baseados em tempo

Acionadores baseados em tempo (também chamados de gatilhos de relógio), permitem que os scripts sejam executados em um horário específico em um intervalo recorrente.

Baseado no tempo (instalável)
authMode	Um valor do tipo enumerado ScriptApp.AuthMode. FULL
day-of-month	Entre 1 e 31 Como esse nome de propriedade contém traços, ele precisa ser acessado por e['day-of-month'] em vez de uma notação de ponto. 31
day-of-week	Entre 1 (segunda-feira) e 7 (domingo). Como esse nome de propriedade contém traços, ele precisa ser acessado por e['day-of-week'] em vez de uma notação de ponto. 7
hour	Entre 0 e 23 23
minute	Entre 0 e 59 59
month	Entre 1 e 12 12
second	Entre 0 e 59 59
timezone	O fuso horário. UTC
triggerUid	ID do acionador que produziu este evento. 4034124084959907503
week-of-year	Entre 1 e 52 Como esse nome de propriedade contém traços, ele precisa ser acessado por e['week-of-year'] em vez de uma notação de ponto. 52
year	O ano. 2015