Acionadores simples e
acionadores instaláveis permitem que o Apps Script
execute uma função automaticamente se ocorrer um determinado evento. Quando um acionador é disparado, o Apps Script transmite à função um objeto de evento como um argumento, normalmente chamado de e
. O objeto de 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 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 acionadores.
Eventos do Planilhas Google
Os vários gatilhos 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 este 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 mudança ( INSERT_ROW |
source |
Um objeto
Spreadsheet |
triggerUid |
ID do acionador que produziu este 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 anterior à 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 este 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 este evento. 4034124084959907503 |
values |
Matriz com valores na mesma ordem em que eles aparecem na planilha. ['2015/05/04 15:00', 'amin@example.com', '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 LIMITED |
source |
Um objeto Document |
triggerUid |
ID do acionador que produziu este 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 abre uma apresentação.
Abrir(simples) |
|
---|---|
authMode |
Um valor do tipo enumerado LIMITED |
source |
Um objeto Presentation |
user |
Um objeto amin@example.com |
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 LIMITED |
source |
Um objeto Form |
triggerUid |
ID do acionador que produziu este 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 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 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 integrado do Agenda não é suficiente para esse fluxo de trabalho.
- Determine quais agendas devem ser sincronizadas. Para cada uma dessas agendas, 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 no evento, execute uma sincronização incremental na agenda afetada usando onextSyncToken
armazenado. Essencialmente, essa é outra solicitação Events.list(), mas fornecer onextSyncToken
limita a resposta apenas a eventos que mudaram desde a última sincronização. - Examine a resposta da sincronização para saber quais eventos foram atualizados e fazer com que o código responda adequadamente. Por exemplo, você pode 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 mudanças mais atuais.
EventUpdated(instalável) |
|
---|---|
authMode |
Um valor do tipo enumerado
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 este 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
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 acionadores de relógio) permitem que os scripts sejam executados em um horário específico ou em um intervalo recorrente.
Baseado no tempo (instalável) | |
---|---|
authMode |
Um valor do tipo enumerado FULL |
day-of-month |
Entre Como o nome da propriedade contém traços, ele precisa ser acessado usando 31 |
day-of-week |
Entre Como o nome da propriedade contém traços, ele precisa ser acessado usando 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 este evento. 4034124084959907503 |
week-of-year |
Entre Como o nome da propriedade contém traços, ele precisa ser acessado usando 52 |
year |
O ano. 2015 |