Actions complémentaires

Les actions de module complémentaire 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 de module complémentaire à l'aide d'objets Action fournis par le service de carte Apps Script. Chaque Action est associé à une fonction de rappel lorsque vous le créez. Vous implémentez 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 widget appropriée qui définit le type d'interaction qui déclenche le rappel Action.

Configurez un widget avec un Action en suivant cette procédure générale:

1. Créez l'objet Action, en spécifiant la fonction de rappel qu'il doit exécuter, ainsi que les paramètres requis.
2. Appelez la fonction de gestionnaire de widget appropriée sur le widget à l'aide de l'objet Action.
3. Implémentez la fonction de rappel pour appliquer le comportement requis.

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

Fonctions de gestionnaire de widget

Pour associer un widget à un Action spécifique ou à un autre comportement, vous devez utiliser une fonction de gestionnaire de widget. 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 de l'UI, le cas échéant, une fois l'action terminée.

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

Fonction de gestionnaire	Déclenche l'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 perd le focus, 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ètre 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ètre 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 Action qui crée un brouillon d'e-mail, puis présente ce brouillon à 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 en tant que 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 la section Créer des brouillons de messages dans Compose.
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 être effectuées 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. Lorsqu'il est fermé, vous pouvez demander à l'UI de recharger le module complémentaire.
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 n'avez besoin que de l'ouvrir. Sinon, utilisez setOnClickOpenLinkAction(). Vous pouvez ouvrir l'URL dans une nouvelle fenêtre ou dans une superposition. Lorsqu'il est fermé, vous pouvez demander à l'UI de recharger le module complémentaire.
setSuggestionsAction()	L'utilisateur saisit du texte dans un champ de saisie	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 la section Suggestions de saisie semi-automatique pour les entrées de texte.

Fonctions de rappel

Les fonctions de rappel s'exécutent lorsqu'un Action se déclenche. Étant donné que les fonctions de rappel sont des fonctions Apps Script, vous pouvez leur demander de faire presque tout ce que n'importe quelle autre fonction de script peut faire.

Avertissement :Le service de carte Apps Script limite les fonctions de rappel à un maximum de 30 secondes d'exécution. Si l'exécution prend plus de temps, il est possible que l'UI de votre module complémentaire ne mette pas à jour correctement l'affichage de la fiche en réponse à Action.

Une fonction de rappel renvoie parfois un objet de réponse spécifique. Ces types de réponses indiquent les opérations supplémentaires qui doivent être effectuées une fois l'exécution du rappel terminée, telles que l'affichage d'une nouvelle fiche 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 utilisez une classe de compilateur dans le service de carte 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:

Action tentée	La fonction de rappel doit renvoyer
Naviguer entre les fiches	ActionResponse
Afficher un Notification	ActionResponse
Ouvrir un lien à l'aide de 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 dans cet hôte. Pour en savoir plus, consultez les guides suivants:

• Actions dans l'agenda
• Actions Drive
• Actions Gmail
• Actions de l'éditeur

Remarque :Lorsque vous utilisez les classes de création de réponses, veillez à appeler build() pour générer les objets de réponse. Sinon, une erreur s'affiche.

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 UniversalActionResponse.

Objets d'événement d'action

Lorsque votre module complémentaire déclenche un Action, l'UI 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 côté client actuel de l'utilisateur, telles que les valeurs actuelles de tous les widgets interactifs de la fiche affichée.

Les objets d'événements 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 une explication complète de la structure des objets d'événement, consultez Objets d'événement.

Remarque :Les modules complémentaires Gmail utilisaient une version simplifiée de cette structure d'objet 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 inclus dans la nouvelle structure d'objet d'événement (voir la structure d'objet d'événement). Toutefois, les mêmes informations sont reproduites dans les sous-structures d'objet événement commun et événement Gmail. Si vous passez d'un module complémentaire Gmail à un module complémentaire Google Workspace, vous devez ajuster votre code pour utiliser les champs d'objet d'événement mis à jour. Les champs d'objet d'événement Gmail d'origine seront éventuellement supprimés.