Action

Action qui décrit le comportement lorsque le formulaire est envoyé. Par exemple, vous pouvez appeler un script Apps Script pour gérer le formulaire. Si l'action est déclenchée, les valeurs du formulaire sont envoyées au serveur.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
Champs
function

string

Fonction personnalisée à appeler lorsque l'utilisateur clique sur l'élément conteneur ou l'active d'une autre manière.

Pour obtenir un exemple d'utilisation, consultez Lire les données d'un formulaire.
parameters[]

object (ActionParameter)

Liste des paramètres d'action.
loadIndicator

enum (LoadIndicator)

Spécifie l'indicateur de chargement que l'action affiche lors de l'appel de l'action.
persistValues

boolean

Indique si les valeurs du formulaire sont conservées après l'action. La valeur par défaut est false.

Si la valeur est true, les valeurs du formulaire sont conservées après le déclenchement de l'action. Pour permettre à l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator sur NONE. Pour les messages de fiches dans les applications Chat, vous devez également définir le paramètre ResponseType de l'action sur UPDATE_MESSAGE et utiliser le même cardId que celui de la fiche contenant l'action.

Si la valeur est false, les valeurs du formulaire sont effacées lorsque l'action est déclenchée. Pour empêcher l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator sur SPINNER.
interaction

enum (Interaction)

Facultatif. Obligatoire lors de l'ouverture d'une boîte de dialogue.

Que faire en réponse à une interaction avec un utilisateur, par exemple lorsqu'un utilisateur clique sur un bouton dans un message de fiche.

Si aucune valeur n'est spécifiée, l'application répond en exécutant un action (par exemple, en ouvrant un lien ou en exécutant une fonction) comme d'habitude.

En spécifiant un interaction, l'application peut répondre de manière interactive et spécifique. Par exemple, en définissant interaction sur OPEN_DIALOG, l'application peut ouvrir une boîte de dialogue. Lorsqu'il est spécifié, aucun indicateur de chargement ne s'affiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
requiredWidgets[]

string

Facultatif. Remplissez cette liste avec les noms des widgets dont cette action a besoin pour un envoi valide.

Si les widgets listés ici n'ont pas de valeur lorsque cette action est appelée, l'envoi du formulaire est annulé.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
allWidgetsAreRequired

boolean

Facultatif. Si la valeur est "true", tous les widgets sont considérés comme requis par cette action.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

ActionParameter

Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. Par exemple, imaginez trois boutons de report : "Reporter maintenant", "Reporter d'un jour" ou "Reporter à la semaine prochaine". Vous pouvez utiliser action method = snooze(), en transmettant le type et la durée de répétition dans la liste des paramètres de chaîne.

Pour en savoir plus, consultez CommonEventObject.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string

Nom du paramètre du script d'action.
value

string

Valeur du paramètre.

LoadIndicator

Spécifie l'indicateur de chargement que l'action affiche lors de l'appel de l'action.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
SPINNER Affiche un indicateur de chargement pour indiquer que le contenu est en cours de chargement.
NONE Rien ne s'affiche.

Interaction

Facultatif. Obligatoire lors de l'ouverture d'une boîte de dialogue.

Que faire en réponse à une interaction avec un utilisateur, par exemple lorsqu'un utilisateur clique sur un bouton dans un message de fiche.

Si aucune valeur n'est spécifiée, l'application répond en exécutant un action (par exemple, en ouvrant un lien ou en exécutant une fonction) comme d'habitude.

En spécifiant un interaction, l'application peut répondre de manière interactive et spécifique. Par exemple, en définissant interaction sur OPEN_DIALOG, l'application peut ouvrir une boîte de dialogue.

Lorsqu'il est spécifié, aucun indicateur de chargement ne s'affiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Enums
INTERACTION_UNSPECIFIED Valeur par défaut. Le action s'exécute normalement.
OPEN_DIALOG

Ouvre une boîte de dialogue, une interface fenêtrée basée sur des fiches que les applications Chat utilisent pour interagir avec les utilisateurs.

Uniquement compatible avec les applications Chat en réponse aux clics sur les boutons des messages de fiches. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.