Os objetos Action permitem criar um comportamento interativo
nos complementos do Google Workspace. Eles definem
o que acontece quando um usuário interage com um widget (por exemplo, um botão) na
IU de complementos.
Uma ação é anexada a um determinado widget usando uma função de gerenciador de widget, que também define a condição que aciona a ação. Quando acionada, a ação executa uma função de callback designada. A função de callback recebe um objeto de evento que transporta informações sobre as interações do lado do cliente do usuário. Implemente a função de callback e faça com que ela retorne um objeto de resposta específico.
Por exemplo, digamos que você queira um botão que gere e exiba um novo cartão quando
clicado. Para isso, crie um novo widget de botão e use a função
setOnClickAction(action)
do gerenciador de botões para definir um Action de criação de cards. A Action definida especifica uma função de callback do Apps Script que é executada quando o botão é clicado. Nesse caso, implemente a função de callback para criar o cartão desejado e retorne um
objeto
ActionResponse. O objeto de resposta instrui o complemento a exibir o card que foi criado pela função
de callback.
Esta página descreve as ações de widget específicas do Gmail que você pode incluir no seu complemento.
Interações no Gmail
Os complementos do Google Workspace que estendem o Gmail podem incluir outra ação de widget específica do Gmail para escrever mensagens de rascunho. Essa ação exige a ação associada da função de callback para retornar um objeto de resposta especializado:
| Ação realizada | A função de callback vai retornar |
|---|---|
| Escrever rascunhos de mensagens | ComposeActionResponse |
Para usar essas ações de widget e objetos de resposta, o complemento precisa
incluir o
escopo
https://www.googleapis.com/auth/gmail.addons.current.action.compose no manifesto.
Escrever mensagem
Um complemento do Google Workspace que estende o Gmail pode
definir um widget que, ao interagir com ele, gera rascunhos de mensagens no Gmail
(novas mensagens ou respostas). Para fazer isso, você precisa associar o widget de acionamento a uma função de callback que retorne um objeto ComposeActionResponse. Quando a função de callback termina, o Gmail usa esse
objeto de resposta para abrir e preencher uma janela de rascunho.
Para ver mais detalhes e um exemplo, consulte Escrever rascunho de mensagens.