Gatilhos para complementos do Google Workspace

Os acionadores do Apps Script causam um script especificado. (a função de gatilho) para ser executada sempre que um evento especificado de segurança. Somente determinados eventos podem acionar gatilhos, e cada O 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 no evento a estrutura de objetos é organizada de maneira diferente com base no tipo de gatilho.

Depois que o objeto do evento é criado, o Apps Script o transmite como um parâmetro ao função gatilho. A função de gatilho é uma função de callback que você precisa implementar por conta própria, tomar as medidas apropriadas para responder à evento. Por exemplo, em um como complemento do Google Workspace, que estende o Gmail, é possível Definir um gatilho que cria uma nova interface de cartão quando o usuário abre uma mensagem fio Nesse caso, você implementa uma função de callback contextual para criar os cartões que compõem a nova interface usando os dados transmitidos no objeto de evento.

Esta página fornece diretrizes sobre como usar acionadores no Google Workspace. em projetos complementares.

Gatilhos do manifesto

Ao contrário dos complementos dos Editores, os do Google Workspace não é possível usar acionadores simples do Apps Script no momento. Em vez disso, usam gatilhos projetados especificamente para Complementos do Google Workspace: acionadores de manifesto.

Os acionadores de manifesto são definidos completamente no Complementos do Google Workspace manifesto. Exemplos de acionadores de manifesto incluem seguintes:

  • Acionadores da página inicial que criam e exibem a página inicial do complemento.
  • Acionadores de evento da agenda que exibem um novo cartão ou levam outras ações quando um evento da Agenda é aberto.
  • Acionadores de evento de atualização da agenda que exibem um novo cartão ou recebem outras ações quando um usuário edita e salva um evento da agenda.
  • Acionadores onItemsSelected que mostram um novo card ou recebem outras ações quando um usuário seleciona um ou mais arquivos ou pastas no Google Drive.
  • Acionadores da mensagem do Gmail que mostram um card de complemento quando o o usuário abre o complemento na janela "Escrever" do Gmail.
  • Acionadores contextuais do Gmail que exibem um novo card ou recebem ações quando o usuário abre uma mensagem do Gmail.
  • Acionadores do editor onFileScopeGranted que mostram um novo card quando os usuários conceder autorização para o escopo drive.file do OAuth no editor atual documento.

Na lista acima, somente os acionadores da página inicial não são contextuais. o restante é acionadores contextuais. Consulte o Manifesto para mais informações sobre definições de gatilhos de manifesto.

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

Restrições

Os acionadores de manifesto têm determinadas restrições de uso.

  • Esses gatilhos são usados apenas em projetos de complementos do Google Workspace. elas não têm propósito 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 Apps Script Script serviço para criar ou modificar esses gatilhos.
  • 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 conteúdo.
  • Cada complemento pode ter apenas um acionador de cada tipo, por usuário e por documento.