Actions complémentaires

Les actions complémentaires fournissent un comportement interactif aux widgets. En créant une action, vous définissez ce qui se passe lorsque l'utilisateur sélectionne ou met à jour un widget.

Dans la plupart des cas, vous pouvez définir des actions complémentaires à l'aide d'objets Action fournis par le service des cartes Apps Script. Chaque Action est associée à une fonction de rappel lorsque vous la créez. Vous mettez en œuvre la fonction de rappel pour effectuer les étapes souhaitées lorsque l'utilisateur interagit avec le widget. Vous devez également associer Action au widget à l'aide d'une fonction de gestionnaire de widgets appropriée qui définit le type d'interaction qui déclenche le rappel Action.

Configurez un widget avec une Action en procédant comme suit:

1. Créez l'objet Action, en spécifiant la fonction de rappel à exécuter et tous les paramètres requis.
2. Appelez la fonction de gestionnaire de widgets appropriée sur le widget à l'aide de l'objet Action.
3. Implémentez la fonction de rappel pour implémenter le comportement requis.

Remarque :Ne confondez pas les objets Action et les objets CardAction. Les objets CardAction sont des éléments de menu de l'en-tête de fiche, tandis que les objets Action définissent des réponses aux interactions de l'utilisateur avec l'interface utilisateur.

Fonctions du gestionnaire de widgets

Pour associer un widget à un Action spécifique ou à un autre comportement, vous devez utiliser une fonction de gestionnaire de widgets. La fonction de gestionnaire détermine le type d'interaction (par exemple, cliquer sur le widget ou modifier un champ de texte) qui déclenche le comportement d'action. La fonction de gestionnaire définit également les étapes que l'interface utilisateur effectue, le cas échéant, une fois l'action terminée.

Le tableau suivant répertorie les différents types de gestionnaires de widgets et les widgets avec lesquels ils sont utilisés:

Fonction de gestionnaire	Déclenche une action	Widgets applicables	Description
setOnChangeAction()	La valeur du widget change	DatePicker DateTimePicker SelectionInput Switch TextInput TimePicker	Définit un Action qui exécute une fonction Apps Script lorsque le widget n'est plus sélectionné, par exemple lorsque l'utilisateur saisit du texte dans une entrée et appuie sur Entrée. Le gestionnaire transmet automatiquement un objet d'événement à la fonction qu'il appelle. Si vous le souhaitez, vous pouvez insérer des informations de paramètres supplémentaires dans cet objet d'événement.
setOnClickAction()	L'utilisateur clique sur le widget.	CardAction Image ImageButton DecoratedText TextButton	Définit un Action qui exécute une fonction Apps Script lorsque l'utilisateur clique sur le widget. Le gestionnaire transmet automatiquement un objet d'événement à la fonction qu'il appelle. Vous pouvez insérer des informations de paramètres facultatives dans cet objet d'événement.
setComposeAction()	L'utilisateur clique sur le widget.	CardAction Image ImageButton DecoratedText TextButton	Spécifique à Gmail. Définit un objet Action qui génère un brouillon d'e-mail, puis le présente à l'utilisateur dans une fenêtre de rédaction de l'UI Gmail. Vous pouvez créer le brouillon en tant que nouveau message ou réponse au message ouvert dans Gmail. Lorsque le gestionnaire appelle la fonction de rappel de création de brouillon, il transmet un objet d'événement à la fonction de rappel. Pour en savoir plus, consultez Rédiger des brouillons de message.
setOnClickOpenLinkAction()	L'utilisateur clique sur le widget.	CardAction Image ImageButton DecoratedText TextButton	Définit un Action pour ouvrir une URL lorsque l'utilisateur clique sur le widget. Utilisez ce gestionnaire lorsque vous devez créer l'URL ou que d'autres actions doivent avoir lieu avant l'ouverture du lien. Sinon, il est généralement plus simple d'utiliser setOpenLink(). Vous ne pouvez ouvrir l'URL que dans une nouvelle fenêtre. Une fois le module complémentaire fermé, vous pouvez le recharger dans l'interface utilisateur.
setOpenLink()	L'utilisateur clique sur le widget.	CardAction Image ImageButton DecoratedText TextButton	Ouvre directement une URL lorsque l'utilisateur clique sur le widget. Utilisez ce gestionnaire lorsque vous connaissez l'URL et que vous ne devez l'ouvrir que. Sinon, utilisez setOnClickOpenLinkAction(). Vous pouvez ouvrir l'URL dans une nouvelle fenêtre ou en superposition. Lorsqu'il est fermé, vous pouvez forcer l'UI à actualiser le module complémentaire.
setSuggestionsAction()	L'utilisateur saisit du texte dans une entrée.	TextInput	Définit un Action qui exécute une fonction Apps Script lorsque l'utilisateur saisit du texte dans un widget de saisie de texte. Le gestionnaire transmet automatiquement un objet d'événement à la fonction qu'il appelle. Pour en savoir plus, consultez Suggestions de saisie semi-automatique pour la saisie de texte.

Fonctions de rappel

Les fonctions de rappel s'exécutent lorsqu'un déclencheur Action se déclenche. Étant donné que les fonctions de rappel sont des fonctions Apps Script, vous pouvez leur demander d'effectuer pratiquement toutes les opérations autorisées par n'importe quelle autre fonction de script.

Avertissement :Le service de cartes Apps Script limite les fonctions de rappel à 30 secondes d'exécution au maximum. Si l'exécution prend plus de temps, l'interface utilisateur du module complémentaire risque de ne pas mettre à jour l'affichage de la carte correctement en réponse à la requête Action.

Une fonction de rappel renvoie parfois un objet de réponse spécifique. Ces types de réponses indiquent des opérations supplémentaires qui doivent se produire une fois l'exécution du rappel terminée, par exemple l'affichage d'une nouvelle carte ou la présentation de suggestions de saisie semi-automatique. Lorsque votre fonction de rappel doit renvoyer un objet de réponse spécifique, vous devez utiliser une classe de compilateur dans le service Card pour créer cet objet.

Le tableau suivant indique quand vos fonctions de rappel doivent renvoyer un objet de réponse spécifique pour des actions spécifiques. Ces actions sont toutes indépendantes de l'application hôte spécifique que le module complémentaire étend:

Tentative d'action	La fonction de rappel doit renvoyer
Naviguer entre les cartes	ActionResponse
Afficher un Notification	ActionResponse
Ouvrir un lien avec setOnClickOpenLinkAction()	ActionResponse
Afficher les suggestions de saisie semi-automatique	SuggestionResponse
Utiliser une action universelle	UniversalActionResponse
Autres actions	Nothing

En plus de ces actions, chaque application hôte dispose de son propre ensemble d'actions qui ne peuvent être effectuées que sur cet hôte. Pour en savoir plus, consultez les guides suivants:

• Actions dans l'agenda
• Inciter à l'action
• Actions Gmail
• Actions de l'éditeur

Remarque :Lorsque vous utilisez les classes du générateur de réponses, veillez à appeler build() pour produire les objets de réponse. À défaut, une erreur se produit.

Remarque :Les actions universelles sont définies dans le fichier manifeste du projet et n'ont pas besoin d'objets Action, mais leurs fonctions de rappel doivent renvoyer un résultat UniversalActionResponse.

Objets d'événement d'action

Lorsque votre module complémentaire déclenche un Action, l'interface utilisateur crée automatiquement un objet d'événement JSON et le transmet en tant qu'argument à la fonction de rappel Action. Cet objet d'événement contient des informations sur le contexte actuel de l'utilisateur côté client, telles que les valeurs actuelles de tous les widgets interactifs de la fiche affichée.

Les objets d'événement d'action ont une structure JSON spécifique qui organise les informations qu'ils contiennent. La même structure est utilisée lorsqu'un déclencheur de page d'accueil se déclenche pour créer une page d'accueil, ou lorsqu'un déclencheur contextuel se déclenche pour mettre à jour l'affichage du module complémentaire.

Pour obtenir une explication complète de la structure des objets d'événements, consultez la page Objets d'événement.

Remarque :Les modules complémentaires Gmail utilisaient une version simplifiée de cette structure d'objets d'événement, qui est désormais obsolète. Pour assurer la rétrocompatibilité, tous les champs d'objet d'événement des modules complémentaires Gmail d'origine sont toujours contenus dans la nouvelle structure d'objets d'événements (voir Structure d'objet d'événement). Cependant, les mêmes informations sont reproduites dans les sous-structures d'objets événement courant et événement Gmail. Si vous convertissez un module complémentaire Gmail en module complémentaire Google Workspace, vous devez modifier votre code afin d'utiliser les champs d'objet d'événement mis à jour. À terme, les champs d'objet d'événement Gmail d'origine seront supprimés.