Acionadores de complementos do Google Workspace

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Os acionadores do Apps Script fazem com que uma função de script especificada (a função de gatilho) seja executada sempre que ocorrer um evento especificado. Apenas determinados eventos podem acionar acionadores, e cada aplicativo do Google Workspace é compatível com um conjunto diferente de eventos.

Quando um acionador é disparado, um objeto de evento é criado. Essa estrutura JSON contém detalhes sobre o evento que ocorreu. As informações na estrutura do objeto de evento são organizadas de forma diferente com base no tipo de acionador.

Depois que o objeto de evento é criado, o Apps Script o transmite como um parâmetro para a função de acionador. O gatilho é uma função de callback que você precisa implementar para realizar as ações apropriadas para responder ao evento. Por exemplo, em um complemento do Google Workspace que estende o Gmail, é possível definir um gatilho que cria uma nova interface de card quando o usuário abre uma conversa de mensagens. Nesse caso, implemente uma função de callback contextual para criar os cards que compõem a nova IU usando os dados transmitidos no objeto de evento.

Nesta página, você verá diretrizes sobre o uso de acionadores em projetos complementares do Google Workspace.

Gatilhos do manifesto

Diferentemente dos complementos do editor, os complementos do Google Workspace atualmente não podem usar acionadores simples do Apps Script. Em vez disso, eles usam acionadores criados especificamente para complementos do Google Workspace: acionadores de manifesto.

Os gatilhos do manifesto são definidos completamente no manifesto dos complementos do Google Workspace. Veja alguns exemplos de acionadores de manifesto:

  • Acionadores da página inicial que criam e exibem a página inicial dos complementos.
  • Acionadores de evento do Agenda que exibem um novo cartão ou realizam outras ações quando um evento do Agenda é aberto.
  • Acionadores de eventUpdate do Agenda que exibem um novo cartão ou realizam outras ações quando um usuário edita e salva um evento do Agenda.
  • Acionadores onItemsSelected do Drive que exibem um novo cartão ou realizam outras ações quando um usuário seleciona um ou mais arquivos ou pastas no Drive.
  • Acionadores de escrita do Gmail que exibem um card de complemento quando o usuário abre o complemento na janela de texto do Gmail.
  • Acionadores contextuais do Gmail que exibem um novo cartão ou realizam outras ações quando o usuário abre uma mensagem do Gmail.
  • Gatilhos de onFileScopegranted do editor que exibem um novo card quando os usuários concedem autorização para o escopo do OAuth drive.file no documento do editor atual.

Na lista acima, somente os acionadores da página inicial não são contextuais. Os demais são acionadores contextuais. Consulte o Manifesto para mais informações sobre as definições dos acionadores de manifestos.

Além dos acionadores do manifesto, os complementos do Google Workspace também podem usar acionadores instaláveis do Apps Script.

Restrições

Os gatilhos do manifesto têm algumas restrições de uso.

  • Esses gatilhos são usados apenas em projetos de complementos do Google Workspace. Eles não têm finalidade em nenhum outro aplicativo.
  • Como eles são definidos no manifesto do complemento e não no código, não é possível usar o serviço Script do Apps Script para criar ou modificar esses acionadores.
  • No momento, os acionadores contextuais do Gmail só podem ter um critério unconditional. Isso significa que acionadores contextuais são acionados para cada mensagem de e-mail, independentemente do conteúdo.