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 construites et transmises en tant que paramètres aux fonctions de déclenchement ou de rappel lorsqu'un utilisateur interagit avec un module complémentaire. Les objets d'événement transmettent des informations côté client sur l'application hôte et le contexte actuel à la fonction de rappel côté serveur du module complémentaire.

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

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

    Les objets d'événement créés lorsque les déclencheurs de page d'accueil se déclenchent ne contiennent pas tous les champs inclus dans les autres cas. Les champs relatifs aux widgets et aux informations contextuelles sont omis.

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

    Lorsqu'un déclencheur contextuel se déclenche, l'application hôte appelle la fonction runFunction correspondante listée dans le fichier manifeste du module complémentaire, en lui transmettant un objet d'événement en tant que paramètre. Les objets d'événement créés lorsque des déclencheurs contextuels se déclenchent contiennent tous les champs inclus dans les objets d'événement de déclencheur de page d'accueil, ainsi que des champs contenant des informations contextuelles.

  • Actions du widget. Les objets d'événement fournissent l'interactivité des widgets, en utilisant le même modèle d'action que les modules complémentaires Gmail. Les modules complémentaires Google Workspace utilisent les mêmes fonctions de gestionnaire de widgets, objets Action et réponses d'action. Dans les modules complémentaires Google Workspace, les objets d'événement d'action incluent davantage d'informations sur lesquelles une fonction de rappel peut agir.

    Les objets d'événement créés à partir 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.

  • Prévisualiser les déclencheurs de lien. 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 correspondant au modèle, l'événement linkPreviewTriggers se déclenche et un objet d'événement contenant le lien est transmis à la fonction de rappel du déclencheur. Votre module complémentaire peut utiliser cet objet d'événement pour créer un chip intelligent et une fiche qui affichent des informations sur le lien dans l'application hôte. Vous pouvez également créer des actions de widget pour que les utilisateurs puissent interagir avec la fiche d'aperçu et son contenu.

  • Déclencheurs d'application Google Chat. Dans Google Chat, votre module complémentaire est présenté aux utilisateurs en tant qu'application Chat. Les utilisateurs peuvent interagir avec lui en l'ajoutant à des espaces, en envoyant des messages, en utilisant des commandes à barre oblique, etc. Pour créer des fonctionnalités interactives, vous devez configurer et utiliser différents déclencheurs d'application Chat. Chaque déclencheur envoie une charge utile d'objet d'événement différente qui vous aide à traiter chaque type d'interaction ou à y répondre.

Structure de l'objet 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 inclut un champ de premier niveau commonEventObject pour les informations indépendantes de l'hôte. Chaque objet d'événement peut également comporter l'un des champs de premier niveau spécifiques à l'hôte suivants, déterminés par l'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 les champs d'origine utilisés dans les objets d'événement d'action des modules complémentaires Gmail. Ces champs se trouvent sous "Champs du module complémentaire Gmail d'origine" et ne font pas partie de commonEventObject.

Les champs d'origine du module complémentaire Gmail sont obsolètes. Lorsque vous développez ou migrez un module complémentaire Google Workspace, utilisez plutôt la nouvelle structure d'objet d'événement. Ces champs pourront être supprimés dans une prochaine mise à jour.

Objet d'événement
eventObject.commonEventObject Common fields object
Objet contenant des informations communes à tous les objets d'événement, quelle que soit l'application hôte.
eventObject.calendar Calendar event object
Présent uniquement si l'hôte appelant est Google Agenda. Objet contenant des informations sur l'agenda et l'événement.
eventObject.chat Chat event object
Uniquement présent si l'hôte appelant est Google Chat. Objet contenant des informations sur Chat.
eventObject.drive Drive event object
Présent uniquement si l'hôte appelant est Google Drive. Objet contenant des informations sur Drive.
eventObject.gmail Gmail event object
Présent uniquement si l'hôte appelant est Gmail. Objet contenant des informations Gmail.
eventObject.docs Docs event object
Uniquement présent si l'hôte appelant est Google Docs. Objet contenant des informations sur Docs.
eventObject.sheets Sheets event object
Présent uniquement si l'hôte appelant est Google Sheets. Objet contenant des informations sur Sheets.
eventObject.slides Slides event object
Présent uniquement si l'hôte appelant est Google Slides. Objet contenant des informations sur Slides.
Champs d'origine du module complémentaire Gmail
eventObject.messageMetadata.accessToken string
Obsolète. Un jeton d'accès Vous pouvez l'utiliser pour activer l'accès aux données utilisateur à l'aide de champs d'application temporaires du module complémentaire Gmail.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Obsolète. ID du message du fil de discussion ouvert dans l'interface utilisateur de Gmail.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.gmail.messageId.

eventObject.clientPlatform string
Obsolète. Indique l'origine de l'événement (Web, iOS ou Android).

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.platform.

eventObject.formInput object
Obsolète. Mappage des valeurs actuelles de tous les widgets de formulaire de la fiche, limité à une valeur par widget. Les clés sont les ID de chaîne associés aux widgets, et les valeurs sont des chaînes. L'objet d'événement fournit formInput pour vous permettre de lire les données de plusieurs widgets avec des valeurs singulières attendues, telles que des entrées de texte et des commutateurs. Pour les widgets à valeurs multiples tels que les cases à cocher, lisez plutôt chaque valeur à partir de formInputs.

Pour les modules complémentaires Google Workspace, recherchez plutôt ces informations dans le champ eventObject.commonEventObject.formInputs. Les widgets à valeur unique sont représentés sous forme de tableaux à un seul élément.

eventObject.formInputs object
Obsolète. Mappage des valeurs actuelles des widgets de la fiche, présentées sous forme de listes de chaînes. Les clés sont les ID de chaîne associés au widget. Pour les widgets à valeur unique, la valeur est présentée dans un tableau à un seul élément. Pour les widgets à valeurs multiples tels que les groupes de cases à cocher, toutes les valeurs sont présentées dans une liste.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.formInputs.

eventObject.parameters object
Obsolète. Mappage de tous les paramètres supplémentaires que vous fournissez à Action à l'aide de Action.setParameters. Les clés et les valeurs de la carte sont des chaînes.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.parameters.

eventObject.userCountry string
Obsolète et désactivé par défaut. Code à deux lettres indiquant le pays ou la région de l'utilisateur. Il peut également s'agir d'un code pays UN M49 numérique.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Obsolète et désactivé par défaut. Code ISO 639 à deux lettres indiquant la langue de l'utilisateur. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Obsolète et désactivé par défaut. Identifiant de fuseau horaire du fuseau horaire de l'utilisateur. Voici quelques exemples : America/New_York, Europe/Vienna et Asia/Seoul. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Obsolète et désactivé par défaut. Décalage horaire par rapport au temps universel coordonné (UTC) du fuseau horaire de l'utilisateur, mesuré en millisecondes. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le champ eventObject.commonEventObject.timeZone.offset.

Objet d'événement courant

L'objet d'événement commun est la partie de l'objet d'événement global qui transmet au module complémentaire des informations générales, indépendantes de l'hôte, provenant du client de l'utilisateur. Ces informations incluent des détails tels que les paramètres régionaux de l'utilisateur, l'application hôte et la plate-forme.

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

Champs d'objets d'événement courants
commonEventObject.platform string
Indique l'origine de l'événement (WEB, IOS ou ANDROID).
commonEventObject.formInputs object
Une carte contenant les valeurs actuelles des widgets de la fiche affichée. Les clés de carte sont les ID de chaîne attribués à chaque widget.

La structure de l'objet de valeur de mappage dépend du type de widget :

  • Widgets à valeur unique (par exemple, une zone de texte) : liste de chaînes (un seul élément).

    Exemple : pour un widget de saisie de texte dont l'ID est employeeName, accédez à la valeur de saisie de texte avec e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Widgets à valeurs multiples (par exemple, groupes de cases à cocher) : liste de chaînes.

    Exemple : pour un widget à valeurs multiples dont l'ID est participants, accédez au tableau de valeurs avec e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker : un DateTimeInput object.

    Exemple : Pour un sélecteur dont l'ID est myDTPicker, accédez à l'objet DateTimeInput à l'aide de e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker : un DateInput object.

    Exemple : Pour un sélecteur dont l'ID est myDatePicker, accédez à l'objet DateInput à l'aide de e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker : un TimeInput object.

    Exemple : Pour un sélecteur dont l'ID est myTimePicker, accédez à l'objet TimeInput à l'aide de e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Indique l'application hôte dans laquelle le module complémentaire est actif lorsque l'objet d'événement est généré. Les valeurs possibles sont les suivantes :
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Tout paramètre supplémentaire que vous fournissez à une action à l'aide de actionParameters ou Action.setParameters.

Preview développeur  : pour les applications Google Chat, afin de suggérer des éléments en fonction de ce que les utilisateurs saisissent dans les menus à sélection multiple, utilisez la valeur de la clé "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Vous pouvez utiliser cette valeur pour interroger une base de données et suggérer des éléments sélectionnables aux utilisateurs à mesure qu'ils saisissent du texte. Pour en savoir plus, consultez Collecter et traiter les informations des utilisateurs de Google Chat.
commonEventObject.userLocale string
Désactivé par défaut. Identifiant de la langue et du pays/de la région de l'utilisateur au format code de langue ISO 639-code de pays/région ISO 3166. Par exemple, en-US.

Pour activer ce champ, vous devez définir addOns.common.useLocaleFromApp sur true dans le fichier manifeste de votre module complémentaire. La liste des champs d'application de votre module complémentaire doit également inclure https://www.googleapis.com/auth/script.locale. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

commonEventObject.timeZone string
Désactivé par défaut. ID et décalage du fuseau horaire. Pour activer ce champ, vous devez définir addOns.common.useLocaleFromApp sur true dans le fichier manifeste de votre module complémentaire. La liste des champs d'application de votre module complémentaire doit également inclure https://www.googleapis.com/auth/script.locale. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.
commonEventObject.timeZone.id string
Identifiant de fuseau horaire du fuseau horaire de l'utilisateur. Exemples : America/New_York, Europe/Vienna et Asia/Seoul. Pour activer ce champ, vous devez définir addOns.common.useLocaleFromApp sur true dans le fichier manifeste de votre module complémentaire. La liste des champs d'application de votre module complémentaire doit également inclure https://www.googleapis.com/auth/script.locale. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.
commonEventObject.timeZone.offset string
Décalage horaire par rapport au temps universel coordonné (UTC) du fuseau horaire de l'utilisateur, mesuré en millisecondes. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

Champs de formulaire de sélecteur de date/heure

Les fonctions de rappel d'action peuvent 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 les widgets de sélection de date ou d'heure. La structure des informations diffère selon que le widget a été configuré en tant que sélecteur de date et d'heure, sélecteur de date uniquement ou sélecteur d'heure uniquement. Les différences structurelles sont décrites dans le tableau suivant :

Objet DateTimeInput
dateTimeInput.hasDate boolean
true si la date et l'heure d'entrée incluent une date ; si false, seule une heure est incluse.
dateTimeInput.hasTime boolean
true si la date et l'heure d'entrée incluent une heure ; si false, seule une date est incluse.
dateTimeInput.msSinceEpoch string
Heure sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet DateInput
dateInput.msSinceEpoch string
Heure sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet TimeInput
timeInput.hours number
Numéro de l'heure sélectionné par l'utilisateur.
timeInput.minutes number
Nombre de minutes sélectionné par l'utilisateur.

Objet d'événement Chat

L'objet d'événement Chat est la partie de l'objet d'événement global qui contient des informations sur les interactions d'un utilisateur avec une application Chat. Il n'est présent dans un objet d'événement que si le module complémentaire étend Google Chat.

Chat
chat.user object (User)
Utilisateur Chat qui a interagi avec l'application Chat.
chat.space object (Space)
Espace Chat dans lequel un utilisateur a interagi avec l'application Chat.
chat.eventTime

string (Timestamp format)

Heure à laquelle l'interaction s'est produite.

Champ d'union payload. Pour un déclencheur App Home (lorsqu'un utilisateur ouvre l'onglet Accueil), payload n'est pas défini et chat contient chat.user et chat.eventTime.

payload ne peut être qu'un des éléments suivants :
chat.messagePayload

object (MessagePayload)

Charge utile que les applications Chat reçoivent d'un déclencheur Message.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Charge utile que les applications Chat reçoivent d'un déclencheur Ajouté à l'espace.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Charge utile que les applications Chat reçoivent d'un déclencheur Supprimé de l'espace.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Charge utile que les applications Chat reçoivent lorsque les utilisateurs cliquent sur un bouton d'un message ou d'une fiche. Si un utilisateur clique sur un bouton pour envoyer des informations, l'objet commonEventObject.formInputs contient les valeurs collectées auprès de l'utilisateur. Pour en savoir plus, consultez Collecter des informations auprès des utilisateurs de Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Charge utile que les applications Chat reçoivent lorsque les utilisateurs saisissent du texte dans le menu de sélection multiple d'un widget selectionInput. Les applications Chat peuvent utiliser cet objet d'événement pour renseigner les éléments suggérés à partir d'une source de données dynamique. Par exemple, pour renseigner des demandes d'assistance à partir d'une source de données externe, une application Chat peut interroger la source de données en fonction de ce que l'utilisateur saisit dans le menu, puis renvoyer les demandes d'assistance correspondantes en tant qu'éléments sélectionnables.

L'objet CommonEventObject.parameters['autocomplete_widget_query'] contient la valeur de chaîne que l'utilisateur saisit dans le menu.

chat.appCommandPayload

object (AppCommandPayload)

Charge utile que les applications Chat reçoivent lorsqu'un utilisateur utilise une commande de l'application Chat.

Charge utile

Selon le type d'interaction avec l'application Chat, l'événement contient une charge utile avec une ou plusieurs ressources de l'API Chat.

Charge utile du message
MessagePayload
chat.messagePayload.message object (Message)
Message de chat ayant déclenché l'événement.
chat.messagePayload.space object (Space)
Espace Chat dans lequel un utilisateur a envoyé le message qui a appelé l'application Chat.
chat.messagePayload.configCompleteRedirectUri string
URL vers laquelle l'application Chat doit rediriger l'utilisateur une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer votre module complémentaire Google Workspace à un service tiers.
Ajouté à la charge utile de l'espace
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Espace Chat auquel l'utilisateur a ajouté ou installé l'application Chat.

Lorsque les administrateurs installent des applications Chat, le champ space.adminInstalled est défini sur true.

chat.addedToSpacePayload.interactionAdd boolean
Indique si un utilisateur ajoute l'application Chat à un espace à l'aide d'un message. Par exemple, il @mentionne l'application Chat ou utilise une commande. Si la valeur est true, Chat envoie un autre objet d'événement avec un messagePayload contenant des informations sur le message.
chat.addedToSpacePayload.configCompleteRedirectUri string
URL vers laquelle l'application Chat doit rediriger l'utilisateur une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer votre module complémentaire Google Workspace à un service tiers.
Supprimé de la charge utile de l'espace
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Espace Chat duquel l'utilisateur a supprimé ou désinstallé l'application Chat.

Lorsque les administrateurs désinstallent des applications Chat, le champ space.adminInstalled est défini sur false.

Charge utile du clic sur un bouton
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Message de chat contenant le bouton sur lequel l'utilisateur a cliqué.
chat.buttonClickedPayload.space object (Space)
Espace Chat dans lequel l'utilisateur a cliqué sur un bouton d'un message d'application Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Indique si l'utilisateur a cliqué sur le bouton pour interagir avec une boîte de dialogue.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Si isDialogEvent est défini sur true, le type d'interaction dans une boîte de dialogue.

Énumération DialogEventType.

La valeur de dialogEventType ne peut être qu'un des éléments suivants :
TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
REQUEST_DIALOG Un utilisateur demande une boîte de dialogue. Par exemple, ils utilisent une commande ou cliquent sur un bouton dans un message.
SUBMIT_DIALOG Un utilisateur clique sur un élément interactif dans une boîte de dialogue. Par exemple, un utilisateur saisit des informations dans une boîte de dialogue et clique sur un bouton pour les envoyer.
Charge utile de mise à jour du widget
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Espace Chat où l'interaction a eu lieu.
Charge utile de la commande d'application
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Métadonnées sur la commande utilisée par l'utilisateur et la façon dont il l'a déclenchée.
chat.appCommandPayload.space object (Space)
Espace Chat dans lequel un utilisateur a utilisé la commande.
chat.appCommandPayload.thread object (Thread)
Si l'interaction s'est produite dans un fil de discussion, fil de discussion Chat dans lequel l'utilisateur a utilisé la commande.
chat.appCommandPayload.message object (Message)
Pour les commandes à barre oblique, le message contenant la commande à barre oblique.
chat.appCommandPayload.configCompleteRedirectUri string
Si une autorisation ou une configuration est requise pour la commande, URL vers laquelle l'utilisateur est redirigé une fois le processus terminé en dehors de Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Indique si la commande ouvre une boîte de dialogue.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Type d'interaction avec une boîte de dialogue.

Énumération DialogEventType.

La valeur de dialogEventType ne peut être qu'un des éléments suivants :
TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
REQUEST_DIALOG Un utilisateur demande une boîte de dialogue. Par exemple, ils utilisent une commande ou cliquent sur un bouton dans un message.
SUBMIT_DIALOG Un utilisateur clique sur un élément interactif dans une boîte de dialogue. Par exemple, un utilisateur saisit des informations dans une boîte de dialogue et clique sur un bouton pour les envoyer.
Métadonnées de commande d'appli
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

ID de la commande.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Type de commande.

Énumération AppCommandType.

La valeur de AppCommandType ne peut être qu'un des éléments suivants :
APP_COMMAND_TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
SLASH_COMMAND Un utilisateur utilise la commande en envoyant un message commençant par une barre oblique /.
QUICK_COMMAND L'utilisateur sélectionne la commande dans le menu Chat de la zone de réponse au message.

Objet d'événement d'agenda

L'objet d'événement d'agenda est la partie de l'objet d'é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 le module complémentaire étend Google Agenda.

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

De nombreux champs de cet objet et de ses sous-structures sont directement mappés aux champs de la ressource d'événement de l'API Calendar portant le même nom. Si les descriptions de champs diffèrent, les informations du tableau suivant sont correctes.

Objet d'événement d'agenda
calendar.attendees[] list of attendee objects
Données générées par l'utilisateur Liste des participants à l'événement d'agenda.
calendar.calendarId string
ID de l'agenda.
calendar.capabilities object
Données générées par l'utilisateur. Objet décrivant les fonctionnalités du module complémentaire pour afficher ou mettre à jour les informations sur l'événement.
calendar.capabilities.canAddAttendees boolean
Données générées par l'utilisateur. true si le module complémentaire peut ajouter des participants à la liste des participants à l'événement ; false sinon.
calendar.capabilities.canSeeAttendees boolean
Données générées par l'utilisateur. true si le module complémentaire peut lire la liste des participants à l'événement ; false sinon.
calendar.capabilities.canSeeConferenceData boolean
Données générées par l'utilisateur. true si le module complémentaire peut lire les données de conférence de l'événement ; false sinon.
calendar.capabilities.canSetConferenceData boolean
Données générées par l'utilisateur. true si le module complémentaire peut mettre à jour les données de conférence de l'événement ; false sinon.
calendar.capabilities.canAddAttachments boolean
Données générées par l'utilisateur. true si le module complémentaire peut ajouter de nouvelles pièces jointes à l'événement ; false sinon.
calendar.conferenceData Conference data object
Données générées par l'utilisateur Objet représentant les données de conférence associées à cet événement, telles que les détails de la conférence Google Meet.
calendar.id string
ID de l'événement.
calendar.organizer object
Objet représentant l'organisateur de l'événement.
calendar.organizer.email string
Adresse e-mail de l'organisateur de l'événement.
calendar.recurringEventId string
ID d'un événement périodique.

Participant

Les objets Attendee contiennent des informations sur les participants à des événements Google Agenda. Ces informations sont présentes 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 du fichier manifeste sur READ ou READ_WRITE.

Objet "Attendee"
attendee.additionalGuests number
Nombre d'invités supplémentaires que le participant a indiqué amener. Prend la valeur zéro par défaut.
attendee.comment string
Commentaire de réponse du participant, le cas échéant.
attendee.displayName string
Nom à afficher du participant.
attendee.email string
Adresse e-mail du participant.
attendee.optional boolean
true si la participation de ce participant est marquée comme facultative ; false sinon.
attendee.organizer boolean
true si le participant est un organisateur de cet événement.
attendee.resource boolean
true si le participant représente une ressource, telle qu'une salle ou un équipement ; false sinon.
attendee.responseStatus string
État de la réponse du participant. Les valeurs possibles sont les suivantes :
  • accepted : le participant a accepté l'invitation à l'événement.
  • declined : le participant a refusé l'invitation à l'événement.
  • needsAction : le participant n'a pas répondu à l'invitation à l'événement.
  • tentative : le participant a accepté provisoirement l'invitation à l'événement.
attendee.self boolean
true si ce participant représente l'agenda dans lequel cet événement apparaît ; false sinon.

Données de conférence

Les objets de données de conférence contiennent des informations sur les conférences associées à des é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 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 du manifeste sur READ ou READ_WRITE.

Objet de données de conférence
conferenceData.conferenceId string
ID de la conférence. Cet ID est destiné à permettre aux applications de suivre les conférences. Vous ne devez pas l'afficher aux utilisateurs.
conferenceData.conferenceSolution object
Objet représentant la solution de conférence, telle que Hangouts ou Google Meet.
conferenceData.conferenceSolution.iconUri string
URI de l'icône visible par l'utilisateur représentant cette solution de conférence.
conferenceData.conferenceSolution.key object
Clé qui identifie de manière unique la solution de conférence pour cet événement.
conferenceData.conferenceSolution.key.type string
Type de solution de conférence. Les valeurs possibles sont les suivantes :
  • eventHangout pour Hangouts pour les particuliers (http://hangouts.google.com).
  • eventNamedHangout pour la version classique de Hangouts pour les utilisateurs de Google Workspace (http://hangouts.google.com).
  • hangoutsMeet pour Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nom de cette solution de conférence visible par l'utilisateur (non localisé).
conferenceData.entryPoints[] list of entry point objects
Liste des points d'entrée de la conférence, tels que des URL ou des numéros de téléphone.
conferenceData.notes string
Remarques supplémentaires (telles que les instructions de l'administrateur du domaine ou les mentions légales) concernant la conférence à afficher pour l'utilisateur. Peut contenir du code HTML. La longueur maximale est de 2 048 caractères.
conferenceData.parameters object
Objet contenant un mappage des données de paramètres définies à utiliser par le module complémentaire.
conferenceData.parameters.addOnParameters object
Mappage des clés et des valeurs de chaîne de paramètre. Ces clés et valeurs sont définies par le développeur du module complémentaire pour associer des informations à une conférence spécifique à utiliser par le module complémentaire.

Point d'entrée

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

Objet de point d'entrée
entryPoint.accessCode string
Code d'accès utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.entryPointFeatures list
Caractéristiques du point d'entrée. Actuellement, ces fonctionnalités ne s'appliquent qu'aux points d'entrée phone :
  • toll : le point d'entrée est un appel téléphonique payant.
  • toll_free : le point d'entrée est un appel téléphonique sans frais.
entryPoint.entryPointType string
Type de point d'entrée. Les valeurs possibles sont les suivantes :
  • more : instructions supplémentaires pour rejoindre la conférence, telles que d'autres numéros de téléphone. Une conférence ne peut avoir qu'un seul point d'entrée more. S'il est présent, au moins un autre type de point d'entrée est également requis.
  • phone : rejoindre la conférence par téléphone. Une conférence peut comporter zéro ou plusieurs points d'entrée phone. Google Agenda n'affiche que les deux premiers points d'entrée téléphoniques, après mise en forme et tri par ordre alphabétique.
  • sip : participez à la conférence via SIP. Une conférence ne peut comporter qu'un seul point d'entrée sip.
  • video : rejoindre la conférence via HTTP. Une conférence ne peut avoir qu'un seul point d'entrée video.
entryPoint.label string
Libellé visible par l'utilisateur pour l'URI du point d'entrée (non localisé).
entryPoint.meetingCode string
Code de réunion utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.passcode string
Code secret utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.pin string
Code permettant d'accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.regionCode string
Code de région du numéro de téléphone. Requis par les utilisateurs si l'URI n'inclut pas de code pays. Les valeurs sont basées sur la liste publique des codes de région CLDR.
entryPoint.uri string
URI du point d'entrée. La longueur maximale est de 1 300 caractères. La mise en forme dépend du type de point d'entrée :
  • more : un schéma http: ou https: est requis.
  • phone : un schéma tel: est requis. L'URI doit inclure l'intégralité de la séquence de numérotation (par exemple, "tel:+12345678900,,,12345678;1234").
  • sip : un schéma sip: ou sips: est requis. Par exemple, "sip:12345678@myprovider.com".
  • video : un schéma http: ou https: est requis.

Objet d'événement Drive

L'objet d'événement Drive est la partie de l'objet d'événement global qui contient des informations sur le Google Drive d'un utilisateur et son contenu. Il n'est présent dans un objet d'événement que si le module complémentaire étend Google Drive.

Objet d'événement Drive
drive.activeCursorItem Drive item object
Élément Drive actuellement actif.
drive.selectedItems[] list of Drive item objects
Liste des éléments (fichiers ou dossiers) sélectionnés dans Drive.

Élément Drive

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

Objet d'élément Drive
item.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au champ d'application https://www.googleapis.com/auth/drive.file pour cet élément. Sinon, ce champ est défini sur false.
item.id string
ID de l'élément sélectionné.
item.iconUrl string
URL de l'icône représentant l'élément sélectionné.
item.mimeType string
Type MIME de l'élément sélectionné.
item.title string
Titre de l'élément sélectionné.

Objet d'événement Gmail

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

Objet d'événement Gmail
gmail.accessToken string
Jeton d'accès spécifique à Gmail. Utilisez ce jeton avec la méthode GmailApp.setCurrentMessageAccessToken pour accorder à votre module complémentaire un accès temporaire au message Gmail actuellement ouvert d'un utilisateur ou pour lui permettre de rédiger de nouveaux brouillons.
gmail.bccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires "Cci" actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, définissez le champ addOns.gmail.composeTrigger.draftAccess de votre fichier manifeste sur METADATA.
gmail.ccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires en "Cc" actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, définissez le champ addOns.gmail.composeTrigger.draftAccess de votre fichier manifeste sur METADATA.
gmail.messageId string
ID du message Gmail actuellement ouvert.
gmail.threadId string
ID du fil de discussion Gmail actuellement ouvert.
gmail.toRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires "À" actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, définissez le champ addOns.gmail.composeTrigger.draftAccess de votre fichier manifeste sur METADATA.

Objet d'é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 le module complémentaire étend Google Docs.

Objet d'événement Docs
docs.id string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur.
ID du document ouvert dans l'interface utilisateur de Docs.
docs.title string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur.
Titre du document ouvert dans l'interface utilisateur de Docs.
docs.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au champ d'application https://www.googleapis.com/auth/drive.file pour le document ouvert dans l'interface utilisateur de Docs. Sinon, ce champ est défini sur false.
docs.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies :
  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Docs. Pour utiliser ce champ, vous devez configurer LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.

Exemple de charge utile lorsqu'un utilisateur prévisualise le lien https://www.example.com/12345 : 

"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 dans un objet d'événement que si le module complémentaire étend Google Sheets.

Objet d'événement Sheets
sheets.id string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. ID de la feuille de calcul ouverte dans l'UI Sheets.
sheets.title string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. Titre de la feuille de calcul ouverte dans l'interface utilisateur de Sheets.
sheets.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au champ d'application https://www.googleapis.com/auth/drive.file pour la feuille de calcul ouverte dans l'UI Sheets. Sinon, ce champ est défini sur false.
sheets.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies :
  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Sheets. Pour utiliser ce champ, configurez LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.

Exemple de charge utile lorsqu'un utilisateur prévisualise le lien https://www.example.com/12345 :

"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 le module complémentaire étend Google Slides.

Objet d'événement Slides
slides.id string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. ID de la présentation ouverte dans l'UI Slides.
slides.title string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. Titre de la présentation ouverte dans l'UI Slides.
slides.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au champ d'application https://www.googleapis.com/auth/drive.file pour la présentation ouverte dans l'interface utilisateur de Slides. Sinon, ce champ est défini sur false.
slides.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies :
  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Slides. Pour utiliser ce champ, configurez LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les chips intelligents.

Exemple de charge utile lorsqu'un utilisateur prévisualise le lien https://www.example.com/12345 :

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