Objets d'événement

Cette page décrit la structure des objets d'événement des modules complémentaires Google Workspace.

Les objets d'événement sont des structures JSON qui sont automatiquement créées et transmises en tant que paramètres pour déclencher ou appeler des fonctions lorsqu'un utilisateur interagit avec un module complémentaire. Les objets d'événement contiennent des informations côté client concernant l'application hôte et l'objet le contexte actuel dans la fonction de rappel côté serveur du module complémentaire.

Les modules complémentaires Google Workspace utilisent des objets d'événement dans les emplacements suivants :

• Déclencheurs de la page d'accueil : Chaque fonction homepageTrigger que vous définissez reçoit automatiquement un objet d'événement lorsque la fonction de déclencheur de la page d'accueil se déclenche. Vous pouvez utiliser cet objet dans la fonction de déclencheur de votre page d'accueil pour identifier l'application hôte active, la plate-forme, les paramètres régionaux de l'utilisateur et d'autres informations.

  Les objets d'événement créés lorsque la page d'accueil déclenche le déclenchement ne contiennent pas tous les champs inclus dans les deux autres cas. Les champs concernant les widgets et les informations contextuelles sont omis.

• Déclencheurs contextuels : Chaque application hôte fournit un ensemble différent de déclencheurs contextuels qui se déclencher lorsque l'utilisateur entre dans un contexte spécifique. Exemple :

  • Gmail fournit un déclencheur contextuel lorsqu'un utilisateur ouvre un message et une autre lorsqu'un utilisateur rédige un message.
  • Google Agenda fournit un déclencheur contextuel lorsqu'un utilisateur ouvre un événement.
  • Google Drive fournit un déclencheur contextuel lorsqu'un utilisateur sélectionne des fichiers Drive.

  Lorsqu'un déclencheur contextuel est exécuté, l'application hôte appelle la méthode l'élément runFunction correspondant répertorié dans le fichier manifeste du module complémentaire, en lui transmettant une comme paramètre. Les objets d'événement créés Les déclencheurs active contiennent tous les champs inclus dans l'événement de déclencheur de la page d'accueil des objets, ainsi que des champs contenant des informations contextuelles.

• Actions du widget Objets "Événement" servent également à fournir des widgets, l'interactivité, en utilisant modèle d'action que les modules complémentaires Gmail utiliser. Les modules complémentaires Google Workspace utilisent toutes les mêmes fonctions de gestionnaire de widgets, objets Action et réponses d'action. Toutefois, dans les modules complémentaires Google Workspace, les objets d'événement d'action incluent encore plus d'informations sur lesquelles une fonction de rappel peut agir.

  Les objets d'événement créés à la suite d'actions de widget contiennent tous les champs inclus dans les objets d'événement de déclencheur contextuel, ainsi que des champs contenant des informations sur le widget.

• Déclencheurs de lien d'aperçu : Dans Google Docs, Sheets et Slides, vous pouvez : configurer des aperçus de liens pour des services tiers en fonction de formats d'URL spécifiques. Lorsque les utilisateurs interagissent avec un lien qui répond le modèle, le linkPreviewTriggers et un objet d'événement contenant le lien est transmis au de rappel. Votre module complémentaire peut utiliser cet objet d'événement pour créer un chip et une fiche intelligents qui présentent des informations sur le lien dans l'application hôte. Vous pouvez également créer des actions de widget pour permettre aux utilisateurs d'interagir avec la fiche d'aperçu et son contenu.

Structure des objets d'événement

Le tableau suivant décrit la structure de premier niveau des objets d'événement des modules complémentaires Google Workspace. La structure de l'objet d'événement inclut un champ de niveau supérieur commonEventObject pour les informations indépendantes de l'hôte. Chaque objet d'événement peut également sont associés à l'un des champs de premier niveau suivants, spécifiques à l'hôte. Ces champs sont déterminés par le application hôte active: gmailEventObject, calendarEventObject ou driveEventObject.

Pour assurer la rétrocompatibilité, les objets d'événement des modules complémentaires Google Workspace incluent également tous les champs d'origine utilisés dans les objets d'événement d'action des modules complémentaires Gmail. Ces champs sont listés dans le tableau ci-dessous sous "Champs d'origine des modules complémentaires Gmail". Les informations contenues dans ces champs sont reproduites dans la nouvelle structure d'objet.

Objet d'événement commun

L'objet d'événement commun est la partie de l'objet d'événement global qui contient des informations générales indépendantes de l'hôte au module complémentaire depuis le client de l'utilisateur. Ce Ces informations incluent, entre autres, les paramètres régionaux de l'utilisateur, l'application hôte et la plate-forme.

En plus de la page d'accueil et des déclencheurs contextuels, les modules complémentaires conçoivent des objets d'événement aux fonctions de rappel d'action ; lorsque l'utilisateur interagit avec les widgets. La fonction de rappel du module complémentaire peut interroger l'objet d'événement commun pour déterminer le contenu des widgets ouverts dans le client. Par exemple, votre module complémentaire peut localiser le texte qu'un utilisateur a saisi dans un widget TextInput dans l'objet eventObject.commentEventObject.formInputs.

Saisies du formulaire de sélecteur de date et heure

Fonctions de rappel d'action peut recevoir les valeurs actuelles du widget dans le champ commonEventObject.formInputs. Cela inclut les valeurs de date ou d'heure sélectionnées par l'utilisateur dans le sélecteur de date ou d'heure widgets. Toutefois, la structure des informations varie selon que le widget a été configuré en tant que sélecteur de date et heure, de date uniquement ou d'heure uniquement. Les différences structurelles sont décrites dans le tableau suivant :

Objet événement d'agenda

L'objet Événement d'agenda est la partie de l'objet événement global qui contient des informations sur l'agenda et les événements d'agenda d'un utilisateur. Il n'est présent dans un objet d'événement que si l'application hôte est Google Agenda.

Le tableau suivant répertorie les champs présents dans calendarEventObject. d'un objet événement. Les champs marqués comme Données générées par l'utilisateur sont présents dans l'objet d'événement si et seulement si les données sont présentes dans l'événement Agenda et que le module complémentaire définit son champ addOns.calendar.currentEventAccess fichier manifeste sur READ ou READ_WRITE.

Participant

Les objets des participants transfèrent les informations sur les participants individuels dans Google Agenda. événements. L'objet événement inclut ces informations si et seulement si les données est présent dans l'événement Agenda et que le module complémentaire définit addOns.calendar.currentEventAccess fichier manifeste pour READ ou READ_WRITE.

Données de conférence

Les objets de données de conférence contiennent des informations sur les conférences associées. aux événements Google Agenda. Il peut s'agir de solutions de conférence Google, comme Google Meet, ou de conférences tierces. Ces informations sont présentes dans l'objet de l'événement si et seulement si les données sont présentes dans l'événement Agenda et que le module complémentaire définit son champ fichier manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Point d'entrée

Les objets de point d'entrée contiennent des informations sur les moyens établis d'accéder à une conférence donnée, par exemple par téléphone ou par vidéo. Ces informations sont présentes dans l'objet de l'événement si et seulement si les données sont présentes dans l'événement Agenda et que le module complémentaire définit son champ fichier manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet événement Drive

L'objet événement Drive correspond à la partie de l'objet événement global qui contient des informations sur le Google Drive d'un utilisateur et son contenu. Il est uniquement est présent dans un objet d'événement si l'application hôte est Google Drive.

Élément Drive

Les objets Drive contiennent des informations sur des éléments Drive spécifiques, tels que des fichiers. ou des dossiers.

Objet événement Gmail

L'objet événement Gmail correspond à la partie de l'objet événement global qui contient sur les messages Gmail d'un utilisateur. Il n'est présent que dans un objet événement. si l'application hôte est Gmail.

Objet événement Docs

L'objet d'événement Docs est la partie de l'objet d'événement global qui contient des informations sur le document d'un utilisateur et son contenu. Il n'est présent dans un objet d'événement que si l'application hôte est Google Docs.

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Objet d'événement Sheets

L'objet d'événement Sheets est la partie de l'objet d'événement global qui contient des informations sur le document d'un utilisateur et son contenu. Il n'est présent que dans un si l'application hôte est Google Sheets.

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Objet d'événement Slides

L'objet d'événement Slides est la partie de l'objet d'événement global qui contient des informations sur le document d'un utilisateur et son contenu. Il n'est présent dans un objet d'événement que si l'application hôte est Google Slides.

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}