Action

Es una acción que describe el comportamiento cuando se envía el formulario. Por ejemplo, puedes invocar una secuencia de comandos de Apps Script para controlar el formulario. Si se activa la acción, los valores del formulario se envían al servidor.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

Representación JSON
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Campos
function

string

Es una función personalizada que se invoca cuando se hace clic en el elemento contenedor o se activa de otra manera.

Para ver un ejemplo de uso, consulta Cómo leer datos de formularios.

parameters[]

object (ActionParameter)

Es una lista de parámetros de acción.

loadIndicator

enum (LoadIndicator)

Especifica el indicador de carga que muestra la acción mientras se realiza la llamada a la acción.

persistValues

boolean

Indica si los valores del formulario persisten después de la acción. El valor predeterminado es false.

Si es true, los valores del formulario se conservan después de que se activa la acción. Para permitir que el usuario realice cambios mientras se procesa la acción, establece LoadIndicator en NONE. En el caso de los mensajes de tarjeta en las apps de Chat, también debes establecer el ResponseType de la acción en UPDATE_MESSAGE y usar el mismo cardId de la tarjeta que contenía la acción.

Si es false, los valores del formulario se borran cuando se activa la acción. Para evitar que el usuario realice cambios mientras se procesa la acción, establece LoadIndicator en SPINNER.

interaction

enum (Interaction)

Opcional. Es obligatorio cuando se abre un diálogo.

Qué hacer en respuesta a una interacción con un usuario, como cuando un usuario hace clic en un botón de un mensaje de tarjeta.

Si no se especifica, la app responde ejecutando un action, como abrir un vínculo o ejecutar una función, de forma normal.

Si especificas un interaction, la app puede responder de formas interactivas especiales. Por ejemplo, si configuras interaction como OPEN_DIALOG, la app puede abrir un diálogo. Cuando se especifica, no se muestra un indicador de carga. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.

requiredWidgets[]

string

Opcional. Completa esta lista con los nombres de los widgets que esta acción necesita para un envío válido.

Si los widgets que se indican aquí no tienen un valor cuando se invoca esta acción, se cancelará el envío del formulario.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

allWidgetsAreRequired

boolean

Opcional. Si es verdadero, esta acción considera que todos los widgets son obligatorios.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

ActionParameter

Es la lista de parámetros de cadena que se deben proporcionar cuando se invoca el método de acción. Por ejemplo, considera tres botones para posponer: posponer ahora, posponer un día o posponer la próxima semana. Puedes usar action method = snooze() y pasar el tipo y la hora de posposición en la lista de parámetros de cadena.

Para obtener más información, consulta CommonEventObject.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

Representación JSON
{
  "key": string,
  "value": string
}
Campos
key

string

Es el nombre del parámetro de la secuencia de comandos de la acción.

value

string

El valor del parámetro.

LoadIndicator

Especifica el indicador de carga que muestra la acción mientras se realiza la llamada a la acción.

Disponible para las apps de Google Chat y los complementos de Google Workspace.

Enums
SPINNER Muestra un ícono giratorio para indicar que se está cargando el contenido.
NONE No se muestra nada.

Interacción

Opcional. Es obligatorio cuando se abre un diálogo.

Qué hacer en respuesta a una interacción con un usuario, como cuando un usuario hace clic en un botón de un mensaje de tarjeta.

Si no se especifica, la app responde ejecutando un action, como abrir un vínculo o ejecutar una función, de forma normal.

Si especificas un interaction, la app puede responder de formas interactivas especiales. Por ejemplo, si configuras interaction como OPEN_DIALOG, la app puede abrir un diálogo.

Cuando se especifica, no se muestra un indicador de carga. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.

Enums
INTERACTION_UNSPECIFIED Valor predeterminado El action se ejecuta con normalidad.
OPEN_DIALOG

Abre un diálogo, una interfaz basada en tarjetas y ventanas que las apps de Chat usan para interactuar con los usuarios.

Solo lo admiten las apps de Chat en respuesta a los clics en los botones de los mensajes de tarjeta. Si se especifica para un complemento, se quita toda la tarjeta y no se muestra nada en el cliente.

Disponible para las apps de Google Chat y no disponible para los complementos de Google Workspace.