Os objetos Action permitem criar um comportamento
interativo nos complementos do Google Workspace. Elas definem
o que acontece quando um usuário interage com um widget (por exemplo, um botão) na
IU do complemento.
Uma ação é anexada a um determinado widget usando uma função do gerenciador de widgets, 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 carrega informações sobre as interações do usuário do lado do cliente. 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 crie e exiba um novo card quando
clicado. Para isso, crie um novo widget de botão e use a função
setOnClickAction(action)
para definir um Action de criação de cards. O Action definido por você 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 que você quer e retornar um
objeto
ActionResponse. O objeto de resposta instrui o complemento a mostrar o cartão que a função
de callback criou.
Esta página descreve as ações de widget específicas do Gmail que você pode incluir no seu complemento.
Interações do Gmail
Os complementos do Google Workspace que estendem o Gmail podem incluir uma outra ação de widget específica do Gmail para escrever mensagens de rascunho. Essa ação requer a função de callback da ação associada para retornar um objeto de resposta especializado:
| Tentativa de fazer uma ação | A função de callback precisa 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 isso, associe o widget
de acionamento a uma função de callback que retorne um
objeto
ComposeActionResponse. Quando a função de callback termina de ser executada, o Gmail usa esse objeto de resposta para abrir e preencher uma janela de escrita de rascunho.
Para ver mais detalhes e um exemplo, consulte Escrever mensagens de rascunho.