Action

Uma ação que descreve o comportamento quando o formulário é enviado. Por exemplo, é possível invocar um script do Apps Script para processar o formulário. Se a ação for acionada, os valores do formulário serão enviados ao servidor.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Campos
function

string

Uma função personalizada a ser invocada quando o elemento que a contém é clicado ou ativado de outra forma.

Para ver um exemplo de uso, consulte Ler dados de formulário.
parameters[]

object (ActionParameter)

Lista de parâmetros de ação.
loadIndicator

enum (LoadIndicator)

Especifica o indicador de carregamento que a ação mostra ao fazer a chamada para a ação.
persistValues

boolean

Indica se os valores do formulário persistem após a ação. O valor padrão é false.

Se for true, os valores do formulário vão permanecer após a ação ser acionada. Para permitir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como NONE. Para mensagens de card em apps do Chat, você também precisa definir o ResponseType da ação como UPDATE_MESSAGE e usar o mesmo cardId do card que continha a ação.

Se for false, os valores do formulário serão apagados quando a ação for acionada. Para impedir que o usuário faça mudanças enquanto a ação está sendo processada, defina LoadIndicator como SPINNER.
interaction

enum (Interaction)

Opcional. Obrigatório ao abrir uma caixa de diálogo.

O que fazer em resposta a uma interação com um usuário, como um usuário clicando em um botão em uma mensagem de card.

Se não for especificado, o app vai responder executando uma action, como abrir um link ou executar uma função, normalmente.

Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo. Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, o card inteiro é removido e nada é mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.
requiredWidgets[]

string

Opcional. Preencha essa lista com os nomes dos widgets que essa ação precisa para um envio válido.

Se os widgets listados aqui não tiverem um valor quando essa ação for invocada, o envio do formulário será cancelado.

Disponível para apps do Google Chat e complementos do Google Workspace.
allWidgetsAreRequired

boolean

Opcional. Se for verdadeiro, todos os widgets serão considerados obrigatórios por essa ação.

Disponível para apps do Google Chat e complementos do Google Workspace.

ActionParameter

Lista de parâmetros de string a serem fornecidos quando o método de ação é invocado. Por exemplo, considere três botões de adiamento: adiar agora, adiar por um dia ou adiar para a próxima semana. Você pode usar action method = snooze(), transmitindo o tipo e o tempo de adiamento na lista de parâmetros de string.

Para saber mais, confira CommonEventObject.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string

O nome do parâmetro do script de ação.
value

string

O valor do parâmetro.

LoadIndicator

Especifica o indicador de carregamento que a ação mostra ao fazer a chamada para a ação.

Disponível para apps do Google Chat e complementos do Google Workspace.

Tipos enumerados
SPINNER Mostra um ícone de carregamento para indicar que o conteúdo está sendo carregado.
NONE Nada é exibido.

Interação

Opcional. Obrigatório ao abrir uma caixa de diálogo.

O que fazer em resposta a uma interação com um usuário, como um usuário clicando em um botão em uma mensagem de card.

Se não for especificado, o app vai responder executando uma action, como abrir um link ou executar uma função, normalmente.

Ao especificar um interaction, o app pode responder de maneiras interativas especiais. Por exemplo, ao definir interaction como OPEN_DIALOG, o app pode abrir uma caixa de diálogo.

Quando especificado, um indicador de carregamento não é mostrado. Se especificado para um complemento, o card inteiro é removido e nada é mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Tipos enumerados
INTERACTION_UNSPECIFIED Valor padrão. O action é executado normalmente.
OPEN_DIALOG

Abre uma caixa de diálogo, uma interface em janela baseada em cards que os apps do Chat usam para interagir com os usuários.

Só é compatível com apps do Chat em resposta a cliques em botões em mensagens de card. Se especificado para um complemento, o card inteiro é removido e nada é mostrado no cliente.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.