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 :

    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 "É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
N'est présent que si l'hôte appelant est Google Agenda. Un objet contenant des informations d'agenda et d'événements.
eventObject.drive Drive event object
Présent uniquement si l'hôte appelant est Google Drive. Un objet contenant des informations Drive.
eventObject.gmail Gmail event object
Présent uniquement si l'hôte appelant est Gmail. Un objet contenant des informations Gmail.
eventObject.docs Docs event object
Présent uniquement si l'hôte appelant est Google Docs. Objet contenant des informations Docs.
eventObject.sheets Sheets event object
Présent uniquement si l'hôte appelant est Google Sheets. Un objet contenant des informations Sheets.
eventObject.slides Slides event object
Présent uniquement si l'hôte appelant est Google Slides. Un objet contenant des informations 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 d'étendues de module complémentaire Gmail temporaires.

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 dans le fil de discussion ouvrir dans l'interface utilisateur de Gmail.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le 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 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 ID de chaîne associés aux widgets, et les valeurs sont des chaînes. L'objet événement fournit formInput en tant que pratique lorsque vous avez besoin de lire des données provenant de plusieurs widgets avec les valeurs singulières attendues, telles que les entrées de texte et les commutateurs. Pour widgets à valeurs multiples, tels que les cases à cocher, vous pouvez lire chaque valeur formInputs à la place.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le eventObject.commonEventObject.formInputs . Les widgets à valeurs uniques sont représentés sous forme de tableaux un seul élément.

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

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

eventObject.parameters object
Obsolète. Carte 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, vous trouverez ces informations dans le champ eventObject.commonEventObject.parameters.

eventObject.userCountry string
Obsolète et désactivé par défaut La code à deux lettres indiquant le pays ou la région de l'utilisateur. Il peut aussi être une valeur numérique Code pays UN M49.

Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le 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 la section 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 du fuseau horaire de l'utilisateur. Voici quelques exemples: America/New_York, Europe/Vienna et Asia/Seoul Pour en savoir plus, consultez la section 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 eventObject.commonEventObject.timeZone.id .

eventObject.userTimezone.offset string
Obsolète et désactivé par défaut La <ph type="x-smartling-placeholder"></ph> le décalage horaire par rapport au temps universel coordonné (UTC) de et le fuseau horaire, mesuré en millisecondes. Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.

Pour les modules complémentaires Google Workspace, vous trouverez 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 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.

Champs d'objets 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 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 map est en fonction du type de widget:

  • Widgets à valeur unique (par exemple, une zone de texte): une 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 à plusieurs valeurs avec participants comme ID, accédez à la valeur avec: e.commonEventObject.formInputs.participants.stringInputs.value

  • A date-time picker : DateTimeInput object.

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

  • A date-only picker : DateInput object.

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

  • A time-only picker: a TimeInput object

    Exemple: Pour un sélecteur dont l'ID est myTimePicker, accéder au objet TimeInput utilisant 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 à Action à l'aide de Action.setParameters().
commonEventObject.userLocale string
Désactivé par défaut. Code de langue et identifiant de pays/région de l'utilisateur au format ISO 639-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 inclure https://www.googleapis.com/auth/script.locale. Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.

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 Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
commonEventObject.timeZone.id string
Identifiant du 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 à 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 Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
commonEventObject.timeZone.offset string
Le le décalage horaire par rapport au temps universel coordonné (UTC) de et le fuseau horaire, mesuré en millisecondes. Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.

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 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
Durée sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet DateInput
dateInput.msSinceEpoch string
Durée sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet TimeInput
timeInput.hours number
Nombre d'heures sélectionné par l'utilisateur.
timeInput.minutes number
Nombre de minutes sélectionné par l'utilisateur.

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.

Objet événement d'agenda
calendar.attendees[] list of attendee objects
Données générées par l'utilisateur. La liste des participants à l'agenda .
calendar.calendarId string
ID de l'agenda.
calendar.capabilities object
Données générées par l'utilisateur Un objet décrivant les fonctionnalités du module complémentaire d'affichage ou de mise à jour de l'événement des informations.
calendar.capabilities.canAddAttendees boolean
Données générées par l'utilisateur true si le module complémentaire peut 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 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 la 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 la 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 des 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 toutes 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 du .
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 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.

Objet "participant"
attendee.additionalGuests number
Nombre d'invités supplémentaires par le participant avaient indiqué qu'ils apportaient. Prend la valeur zéro par défaut.
attendee.comment string
Commentaire dans la 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 cet participant est marquée comme facultative ; false dans le cas contraire.
attendee.organizer boolean
true si le participant est organisateur de cet é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 de l'participant. Les valeurs possibles sont les suivantes :
  • accepted: le participant a accepté l'événement. invitation.
  • declined : le participant a refusé l'invitation à l'événement.
  • needsAction : le participant n'a pas répondu à l'invitation à l'événement.
  • tentative : l'invité 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, sinon false.

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.

Objet de données de conférence
conferenceData.conferenceId string
ID de la conférence. Cet ID signifie pour permettre aux applications de suivre les conférences ; vous ne devriez pas présenter l'ID aux utilisateurs.
conferenceData.conferenceSolution object
Objet représentant la solution de conférence, comme 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 visible de l'utilisateur pour cette solution de conférence (non localisé).
conferenceData.entryPoints[] list of entry point objects
Liste des points d'entrée des conférences, tels que des URL ou des numéros de téléphone.
conferenceData.notes string
Notes supplémentaires (telles que des instructions de l'administrateur du domaine ou des avis juridiques) sur la conférence à afficher à 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ètre définies à utiliser par le module complémentaire.
conferenceData.parameters.addOnParameters object
Carte des clés et des valeurs de la chaîne de paramètres. Ces clés et valeurs sont définies par le développeur du module complémentaire à une conférence spécifique pour l'utilisation du module complémentaire.

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 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. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} à donnent accès à des conférences. Correspondent et n'affichent que les champs utilisé par le fournisseur de services de conférence.
entryPoint.entryPointFeatures list
Fonctionnalités 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 surtaxé.
  • toll_free : le point d'entrée est un appel téléphonique gratuit.
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 des numéros de téléphone alternatifs. Une conférence ne peut avoir qu'un seul point d'entrée more. Si un autre type de point d'entrée est présent, au moins un autre type de point d'entrée est également requis.
  • phone: participez à la conférence via un numéro de téléphone. Une conférence peut avoir zéro ou plusieurs points d'entrée phone. Google Agenda n'affiche que les deux premiers points d'entrée, après le formatage et le tri alphabétique.
  • sip: rejoindre la conférence via SIP. Une conférence peut comporter au maximum un point d'entrée sip.
  • video: participez à 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. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} à donnent accès à des conférences. Correspondent et n'affichent que les champs utilisé par le fournisseur de services 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érences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir un accès aux conférences. Correspondent et n'affichent que les champs utilisé par le fournisseur de services de conférence.
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} à donnent accès à des conférences. Correspondent et n'affichent que les champs utilisé par le fournisseur de services de conférence.
entryPoint.pin string
Code utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} à donnent accès à des conférences. Correspondent et n'affichent que les champs utilisé par le fournisseur de services de conférence.
entryPoint.regionCode string
Code de région du numéro de téléphone. Requis par utilisateurs si l'URI n'inclut pas de code pays. Les valeurs sont basées sur le public Liste des codes régionaux 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 point d'entrée type: <ph type="x-smartling-placeholder">
    </ph>
  • more: http: ou https: est nécessaire.
  • phone : un schéma tel: est obligatoire. L'URI doit inclure l'intégralité de la séquence de numérotation (par exemple, "tel:+12345678900,,,12345678;1234").
  • sip: sip: ou sips: est nécessaire. Exemple : "sip:12345678@monfournisseur.com".
  • video : un schéma http: ou https: est requis.

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.

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 Drive contiennent des informations sur des éléments Drive spécifiques, tels que des fichiers. ou des dossiers.

Objet élément Drive
item.addonHasFileScopePermission boolean
Si true, le module complémentaire a demandé et ont reçu https://www.googleapis.com/auth/drive.file une autorisation de portée 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 représentant la 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 é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 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 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 en "Cci" actuellement incluses dans un brouillon que le module complémentaire compose. Pour activer ce champ, vous devez définir 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 rédige. Pour activer ce champ, vous devez définir le addOns.gmail.composeTrigger.draftAccess dans votre fichier manifeste pour 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. La liste de "À :" des adresses e-mail des destinataires actuellement incluses dans un brouillon. un module complémentaire en cours de rédaction. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess de votre fichier manifeste sur METADATA.

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.

Objet é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 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ée par l'utilisateur.
Le titre du document s'ouvre dans l'interface utilisateur de Docs.
docs.addonHasFileScopePermission boolean
Si true, le module complémentaire a demandé et ont reçu https://www.googleapis.com/auth/drive.file autorisation du champ d'application du document ouverte dans l'interface utilisateur de Docs sinon ceci 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 des liens avec des 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 que dans un 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. L'ID de la feuille de calcul s'ouvre 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 ouvert dans Sheets UI.
sheets.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu une autorisation de champ d'application https://www.googleapis.com/auth/drive.file pour la feuille de calcul ouverte dans l'interface utilisateur de Sheets. Dans le cas contraire, ce champ est false.
sheets.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies:
  • L'utilisateur a autorisé https://www.googleapis.com/auth/workspace.linkpreview.
  • 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 des liens avec des 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 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 ouverte dans Slides UI.
slides.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 de la présentation s'ouvre dans Interface utilisateur de Slides
slides.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu une autorisation de champ d'application https://www.googleapis.com/auth/drive.file pour la présentation ouverte dans l'interface utilisateur de Slides. Dans le cas contraire, ce champ est false.
slides.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies :
  • L'utilisateur a autorisé https://www.googleapis.com/auth/workspace.linkpreview.
  • 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 le LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.

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

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