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
interface do complemento.
Uma ação é anexada a um widget usando uma função de manipulador 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 no lado do cliente. Você precisa implementar a função de callback e fazer com que ela retorne um objeto de resposta específico.
Por exemplo, digamos que você queira um botão que crie e mostre um novo card quando
clicado. Para isso, crie um novo widget de botão e use a função de manipulador
do widget de botão
setOnClickAction(action)
para definir um Action
de criação de cards. O
Action
que você define especifica uma função de callback
do Apps Script que é executada quando o botão é clicado. Nesse caso, você
implementa a função de callback para criar o card que você quer e retornar um
objeto ActionResponse
. O objeto de resposta informa ao complemento para mostrar o card que a função de callback
criou.
Esta página descreve as ações de widgets específicas do Gmail que podem ser incluídas no complemento.
Interações com o Gmail
Os complementos do Google Workspace que estendem o Gmail podem incluir uma ação de widget específica do Gmail para compor mensagens de rascunho. Essa ação exige que a função de callback associada à ação retorne um objeto de resposta especializado:
Tentativa de ação | A função de callback precisa retornar |
---|---|
Escrever rascunhos de mensagens | ComposeActionResponse |
Para usar essas ações e objetos de resposta do widget, o complemento precisa
incluir o
escopo
https://www.googleapis.com/auth/gmail.addons.current.action.compose
no manifesto.
Escreva uma mensagem
Um complemento do Google Workspace que estende o Gmail pode
definir um widget que, quando interagido, gera mensagens de rascunho no Gmail
(novas mensagens ou respostas). Para fazer isso, você precisa associar o widget acionado
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 composição de rascunho.
Para mais detalhes e um exemplo, consulte Escrever mensagens de rascunho.