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 pour déclencher ou rappeler des fonctions lorsqu'un utilisateur interagit avec un module complémentaire. Les objets d'événement transmettent des informations côté client concernant 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 la page d'accueil : Chaque fonction homepageTrigger que vous définissez reçoit automatiquement un objet événement lorsque la fonction du déclencheur de la page d'accueil est exécutée. Vous pouvez utiliser cet objet dans la fonction de déclenchement de votre 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 lors du déclenchement de la page d'accueil 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éclenchent lorsque l'utilisateur entre dans un contexte spécifique. Exemple :

    Lorsqu'un déclencheur contextuel s'exécute, l'application hôte appelle le runFunction correspondant listé 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 sont déclenchés contiennent tous les champs inclus dans les objets d'événement de déclencheur de la page d'accueil, ainsi que des champs contenant des informations contextuelles.

  • Actions du widget. Les objets d'événement permettent également de fournir une interactivité au niveau des widgets, à l'aide du même modèle d'action que celui utilisé par 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. 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 les widgets.

  • Déclencheurs du 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 correspond au modèle, 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 carte qui affichent 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 de l'objet de l'é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 d'objet d'événement inclut un champ commonEventObject de niveau supérieur pour les informations indépendantes de l'hôte. Chaque objet d'événement peut également comporter l'un des champs de premier niveau suivants, spécifiques à l'hôte, 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 également tous les champs d'origine utilisés dans les objets d'événement d'action des modules complémentaires Gmail. Ces champs sont répertoriés dans le tableau ci-dessous, sous "Champs d'origine des modules complémentaires Gmail". Les informations qu'ils contiennent sont reproduites dans la nouvelle structure d'objets.

Objet é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
Disponible uniquement si l'organisateur à l'origine de l'appel est Google Agenda. Objet contenant des informations d'agenda et d'événements.
eventObject.drive Drive event object
Disponible uniquement si l'organisateur à l'origine de l'appel est Google Drive. Objet contenant des informations Drive.
eventObject.gmail Gmail event object
Disponible uniquement si l'organisateur de l'appel est Gmail. Objet contenant des informations Gmail.
eventObject.docs Docs event object
Disponible uniquement si l'hôte appelant est Google Docs. Objet contenant des informations sur Docs.
eventObject.sheets Sheets event object
Disponible uniquement si l'hôte appelant est Google Sheets. Objet contenant des informations Sheets.
eventObject.slides Slides event object
Disponible uniquement si l'hôte appelant est Google Slides. Objet contenant des informations Slides.
Champs d'origine des modules complémentaires Gmail
eventObject.messageMetadata.accessToken string
Obsolète. Un jeton d'accès Cette option vous permet d'activer l'accès aux données utilisateur à l'aide de champs d'application temporaires de modules complémentaires Gmail.

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

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

Pour les modules complémentaires Google Workspace, recherchez 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, recherchez ces informations dans le champ eventObject.commonEventObject.platform.

eventObject.formInput object
Obsolète. Carte des valeurs actuelles de tous les widgets de formulaire de la fiche, limitée à une valeur par widget. Les clés sont les identifiants de chaîne associés aux widgets et les valeurs sont des chaînes. L'objet événement fournit formInput lorsque vous devez lire des données de plusieurs widgets avec des valeurs uniques attendues, telles que des entrées de texte et des commutateurs. Pour les widgets à valeurs multiples, tels que les cases à cocher, vous pouvez lire chaque valeur de formInputs à la place.

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

eventObject.formInputs object
Obsolète. Carte des valeurs actuelles des widgets de la fiche, présentée 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 à élément unique. Pour les widgets à valeurs multiples, tels que les groupes de cases, toutes les valeurs sont présentées sous forme de liste.

Pour les modules complémentaires Google Workspace, recherchez 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 du mappage sont des chaînes.

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

eventObject.userCountry string
Obsolète et désactivée 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 numérique UN M49.

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

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

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

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

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

eventObject.userTimezone.offset string
Obsolète et désactivée 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 aux fuseaux horaires de l'utilisateur.

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

Objet d'événement commun

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 à partir 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 de contexte, les modules complémentaires construisent et transmettent des objets d'événement aux fonctions de rappel d'action lorsque l'utilisateur interagit avec les 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'objet d'événement courants
commonEventObject.platform string
Indique l'origine de l'événement ("WEB", "IOS" ou "ANDROID").
commonEventObject.formInputs object
Carte contenant les valeurs actuelles des widgets dans la fiche affichée. Les clés de mappage correspondent aux ID de chaîne attribués à chaque widget.

La structure de l'objet de valeur de carte 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 ayant comme ID employeeName, accédez à la valeur d'entrée de texte avec: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

    Exemple : Pour un widget à valeurs multiples ayant comme ID participants, accédez au tableau de valeurs avec e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: un DateTimeInput object.

    Exemple: Pour un outil de sélection 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 outil de sélection 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 outil de sélection 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 é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 à Action à l'aide de Action.setParameters().
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 ou code 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 du 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 aux fuseaux horaires 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 du 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 aux fuseaux horaires 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 du 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 aux fuseaux horaires 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 aux fuseaux horaires de l'utilisateur.

Entrées du formulaire pour le sélecteur de date et d'heure

Les fonctions de rappel d'action peuvent recevoir les valeurs actuelles de 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électeur de date ou d'heure. Cependant, la structure des informations diffère selon que le widget a été configuré en tant que sélecteur de date/heure, de sélecteur de date uniquement ou de sélecteur d'heure. 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 d'heure sélectionné par l'utilisateur.
timeInput.minutes number
Numéro des minutes sélectionné par l'utilisateur.

Objet d'événement d'agenda

L'objet événement d'agenda correspond à 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 événement que si l'application hôte est Google Agenda.

Le tableau suivant répertorie les champs présents dans le champ 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 événement si et seulement si les données sont présentes dans l'événement Agenda et si le module complémentaire définit son champ manifest addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

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 permettant d'afficher ou de mettre à jour les informations d'événement.
calendar.capabilities.canAddAttendees boolean
Données générées par l'utilisateur. true si le module complémentaire permet d'ajouter de nouveaux participants à la liste des participants à l'événement ; false dans le cas contraire.
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 dans le cas contraire.
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 la conférence de l'événement ; false dans le cas contraire.
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 la conférence de l'événement ; false dans le cas contraire.
calendar.capabilities.canAddAttachments boolean
Données générées par l'utilisateur. true si le module complémentaire permet d'ajouter des pièces jointes à l'événement ; false dans le cas contraire.
calendar.conferenceData Conference data object
Données générées par l'utilisateur : Objet représentant toutes les données de conférence associées à cet événement, telles que les détails d'une 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 transmettent des informations sur chaque participant dans les événements Google Agenda. Ces informations ne sont présentes dans l'objet événement que si les données sont présentes dans l'événement Agenda et si le module complémentaire définit son champ manifest addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet Participant
attendee.additionalGuests number
Nombre d'invités supplémentaires que le participant a indiqués. Prend la valeur zéro par défaut.
attendee.comment string
Commentaire du participant dans sa réponse, le cas échéant.
attendee.displayName string
Nom du participant affiché.
attendee.email string
Adresse e-mail du participant.
attendee.optional boolean
true si la participation de ce participant est marquée comme facultative ; false dans le cas contraire.
attendee.organizer boolean
true si le participant est organisateur de l'événement.
attendee.resource boolean
true si le participant représente une ressource, telle qu'une salle ou un équipement, false dans le cas contraire.
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é l'invitation à l'événement.
attendee.self boolean
true si ce participant représente l'agenda dans lequel cet événement apparaît ; false dans le cas contraire.

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, telles que Google Meet, ou de conférences tierces. Ces informations ne sont présentes dans l'objet d'événement que si les données sont présentes dans l'événement Agenda et si le module complémentaire définit son champ manifest addOns.calendar.currentEventAccess 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 d'effectuer le suivi des conférences. Vous ne devez pas l'afficher pour les utilisateurs.
conferenceData.conferenceSolution object
Objet représentant une 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 les Hangouts grand public (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 (URL ou numéros de téléphone, par exemple).
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 à l'utilisateur. Peut contenir du code HTML. Il ne doit pas dépasser 2 048 caractères.
conferenceData.parameters object
Objet contenant un mappage de données de paramètres définis que le module complémentaire doit utiliser.
conferenceData.parameters.addOnParameters object
Mappage des clés et des valeurs de chaîne de paramètres. Ces clés et valeurs sont définies par le développeur du module complémentaire pour joindre des informations à une conférence spécifique pour l'utilisation du module complémentaire.

le point d'entrée,

Les objets de point d'entrée contiennent des informations sur le moyen établi d'accéder à une conférence donnée, par exemple par téléphone ou par vidéo. Ces informations ne sont présentes dans l'objet événement que si les données sont présentes dans l'événement Agenda et si le module complémentaire définit son champ manifest 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. Il ne doit pas dépasser 128 caractères. Les fournisseurs de services 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 l'organisateur de la conférence.
entryPoint.entryPointFeatures list
Caractéristiques du point d'entrée. Actuellement, les fonctionnalités suivantes 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 participer à une conférence (numéros de téléphone secondaires, par exemple). Une conférence ne peut avoir qu'un seul point d'entrée more. Si elle en comporte au moins un autre type est également requis.
  • phone: participez à la conférence via un numéro de téléphone. Une conférence peut avoir zéro, un ou plusieurs points d'entrée phone. Google Agenda n'affiche que les deux premiers points d'entrée du téléphone, après mise en forme et tri alphabétique.
  • sip: participez à la conférence via SIP. Une conférence ne peut avoir qu'un seul point d'entrée sip.
  • video: participer à 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. Il ne doit pas dépasser 128 caractères. Les fournisseurs de services 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 l'organisateur de la conférence.
entryPoint.passcode string
Code secret utilisé pour accéder à la conférence. Il ne doit pas dépasser 128 caractères. Les fournisseurs de services 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 l'organisateur de la conférence.
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. Il ne doit pas dépasser 128 caractères. Les fournisseurs de services 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 l'organisateur de la conférence.
entryPoint.pin string
Code utilisé pour accéder à la conférence. Il ne doit pas dépasser 128 caractères. Les fournisseurs de services 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 l'organisateur de la conférence.
entryPoint.regionCode string
Code régional 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. Il ne doit pas dépasser 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 la séquence de numérotation complète (par exemple, "tel:+12345678900,,,12345678;1234").
  • sip: un schéma sip: ou sips: est requis. Exemple : "sip:12345678@monfournisseur.com".
  • video: un schéma http: ou https: est requis.

Objet d'événement Drive

L'objet d'événement Drive correspond à 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 événement que si l'application hôte est 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 d'éléments (fichiers ou dossiers) sélectionnés dans 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 Drive item
item.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu https://www.googleapis.com/auth/drive.file autorisation de champ d'application pour cet élément. Sinon, ce champ est false.
item.id string
ID de l'élément sélectionné.
item.iconUrl string
URL de l'icône qui représente 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 correspond à 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 é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. Vous pouvez utiliser ce jeton avec la méthode GmailApp.setCurrentMessageAccessToken(accessToken) pour accorder à votre module complémentaire un accès temporaire au message Gmail ouvert d'un utilisateur ou laisser votre module complémentaire rédiger de nouveaux brouillons.
gmail.bccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires dans le champ "Cci:" actuellement incluses dans le brouillon du module complémentaire. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess dans votre fichier manifeste sur METADATA.
gmail.ccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires dans le champ "Cc" actuellement incluses dans le brouillon du module complémentaire en cours de rédaction. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess dans 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 le brouillon du module complémentaire. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess dans 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 l'application hôte est 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.
L'ID du document s'ouvre 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.
Le titre du document s'ouvre 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 de champ d'application https://www.googleapis.com/auth/drive.file pour le document ouvert dans l'interface utilisateur de Docs. Sinon, ce champ est 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 du module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.

Exemple de charge utile lorsqu'un utilisateur affiche un aperçu du 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 correspond à 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 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'interface utilisateur de 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 qui s'ouvre 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 de champ d'application https://www.googleapis.com/auth/drive.file pour la feuille de calcul ouverte dans l'interface utilisateur de Sheets. Sinon, ce champ indique 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, vous devez configurer LinkPreviewTriggers dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.

Exemple de charge utile pour lorsqu'un utilisateur affiche un aperçu du 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 correspond à 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.

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 à ouvrir dans l'interface utilisateur de 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 s'ouvrant dans l'interface utilisateur de Slides.
slides.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation de champ d'application https://www.googleapis.com/auth/drive.file pour la présentation ouverte dans l'interface utilisateur de Slides. Sinon, ce champ indique 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, vous devez configurer LinkPreviewTriggers dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.

Exemple de charge utile pour lorsqu'un utilisateur affiche un aperçu du lien https://www.example.com/12345:

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