Objets d'événement

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 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 à trois endroits:

  • 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éclenchement de la page d'accueil se déclenche. Vous pouvez utiliser cet objet dans la fonction de déclenchement de la 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 la page d'accueil se déclenche 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. Par exemple, Gmail fournit un déclencheur contextuel lorsqu'un utilisateur ouvre un message et un autre lorsqu'il compose un message. Google Agenda fournit un déclencheur contextuel lorsqu'un utilisateur ouvre un événement. Google Drive fournit un déclencheur contextuel lorsqu'un utilisateur sélectionne les fichiers Drive.

    Lorsqu'un déclencheur contextuel se déclenche, l'application hôte appelle l'élément runFunction correspondant répertorié 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 lors du déclenchement des déclencheurs contextuels 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 d'assurer l'interactivité des widgets avec le 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, les mêmes objets Action et les mêmes réponses d'action. Toutefois, dans les modules complémentaires Google Workspace, les objets d'événement d'action incluent des informations supplémentaires sur lesquelles une fonction de rappel peut agir.

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

Cette page présente la nouvelle structure des objets d'événement du module complémentaire Google Workspace.

Structure de l'objet de l'événement

Le tableau suivant décrit la structure de premier niveau des objets d'événement du module complémentaire Google Workspace. La structure d'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 comporter l'un des champs de niveau supérieur propres à l'hôte suivants, déterminé 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énements de modules complémentaires Gmail. Ces champs sont répertoriés dans le tableau ci-dessous sous "Champs d'origine du module complémentaire Gmail". Les informations qu'ils contiennent sont reproduites dans une 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
Uniquement si l'organisateur de l'appel est Google Agenda. Objet contenant des informations d'agenda et d'événement.
eventObject.drive Drive event object
Uniquement si l'organisateur de l'appel est Google Drive. Objet contenant des informations Drive.
eventObject.gmail Gmail event object
Uniquement si l'organisateur de l'appel est Gmail. Objet contenant des informations Gmail.
eventObject.docs Docs event object
Uniquement si l'hôte de l'appel est Google Docs. Objet contenant des informations sur Docs.
eventObject.sheets Sheets event object
Uniquement si l'organisateur de l'appel est Google Sheets. Objet contenant des informations Sheets.
eventObject.slides Slides event object
Uniquement si l'organisateur de l'appel est Google Slides. Objet contenant des informations Slides.
Champs complémentaires Gmail d'origine
eventObject.messageMetadata.accessToken string
Obsolète. Un jeton d'accès Vous pouvez l'utiliser pour autoriser l'accès aux données utilisateur à l'aide de champs d'application temporaires de Gmail.

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

eventObject.clientPlatform string
Obsolète. Indique la provenance 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 ID de chaîne associés aux widgets et les valeurs sont des chaînes. L'objet événement fournit formInput lorsque vous devez lire les données de plusieurs widgets avec les valeurs singulières attendues, telles que des entrées de texte et des interrupteurs. Pour les widgets à valeurs multiples, tels que les cases à cocher, vous pouvez plutôt lire chaque valeur 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 avec un seul élément.

eventObject.formInputs object
Obsolète. Carte des valeurs actuelles des widgets dans la fiche, présentée sous forme de listes de chaînes. Les clés correspondent aux 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, recherchez ces informations dans le champ eventObject.commonEventObject.formInputs.

eventObject.parameters object
Obsolète. Carte des paramètres supplémentaires que vous fournissez à Action à l'aide de Action.setParameters() Les clés et les valeurs de 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 UN M49 numérique.

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 qui indique 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, 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 au fuseau horaire 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 au fuseau horaire de l'utilisateur.

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

Objet événement courant

L'objet événement courant est la partie de l'objet événement global qui contient des informations générales, indépendantes de l'hôte, du module complémentaire du client de l'utilisateur. Ces informations incluent des informations telles que 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 créent et transmettent des objets d'événement à des fonctions de rappel d'action lorsque l'utilisateur interagit avec les widgets. Votre fonction de rappel 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 sont les ID de chaîne attribués à chaque widget, et chaque valeur correspond à un autre objet wrapper doté d'une seule clé "". 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 avec employeeName comme ID, accédez à la valeur de saisie de texte avec e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0].

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

    Exemple : Pour un widget à valeurs multiples avec l'ID participants, accédez au tableau de valeurs avec e.commonEventObject.formInputs.participants[""].stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Exemple: Pour un sélecteur avec l'ID 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 l'ID myDatePicker, accédez à l'objet DateInput à l'aide de e.commonEventObject.formInputs.myDatePicker[""].dateInput.

  • A time-only picker: TimeInput object.

    Exemple : Pour un sélecteur avec l'ID 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
Tous les paramètres supplémentaires que vous fournissez au Action à l'aide de Action.setParameters().
commonEventObject.userLocale string
Désactivé par défaut. Langue et identifiant de pays/région de l'utilisateur au format ISO 639-Code de pays 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. Votre liste de champs d'application du 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 du fuseau horaire et décalage (offset). 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 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
L'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 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 (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.

Entrées du formulaire du sélecteur d'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électeur de date ou d'heure. Cependant, la structure des informations varie selon que le widget a été configuré comme un sélecteur de date/heure, ou un sélecteur de date ou 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 écoulées depuis l'époque (00:00:00 UTC du 1er janvier 1970).
Objet DateInput
dateInput.msSinceEpoch string
Heure sélectionnée par l'utilisateur, en millisecondes écoulées depuis l'époque (00:00:00 UTC du 1er janvier 1970).
Objet TimeInput
timeInput.hours number
Numéro d'heure sélectionné par l'utilisateur.
timeInput.minutes number
Nombre de minutes sélectionné par l'utilisateur.

Objet d'événement d'agenda

L'objet événement Agenda correspond à la partie de l'objet événement global qui contient des informations sur l'agenda et les événements d'agenda d'un utilisateur. Elle n'est présente 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 le champ calendarEventObject d'un objet d'événement. Les champs marqués comme Données générées par l'utilisateur ne figurent dans l'objet événement que 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 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 sur les événements.
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 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. Sinon, false.
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 des événements. Sinon, false.
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 des événements. Sinon, false.
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. Sinon, false.
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 de participants transportent des informations sur les participants individuels aux événements Google Agenda. Ces informations sont présentes dans l'objet é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 participant
attendee.additionalGuests number
Nombre de participants supplémentaires que le participant a indiqué apporter. Prend la valeur zéro par défaut.
attendee.comment string
Réponse du participant (le cas échéant).
attendee.displayName string
Nom du participant affiché.
attendee.email string
Adresse e-mail des participants.
attendee.optional boolean
true si la participation à ce participant est marquée comme facultative ; false dans le cas contraire.
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. Sinon, false.
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 provisoirement 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 la 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. Cette information est présente dans l'objet é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 la conférence
conferenceData.conferenceId string
ID de la conférence. Cet identifiant est destiné à permettre aux applications de suivre les conférences. Il ne doit pas être visible par les utilisateurs.
conferenceData.conferenceSolution object
Objet représentant la solution de conférence, tel 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 le 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 par l'utilisateur de cette solution de conférence (non localisé).
conferenceData.entryPoints[] list of entry point objects
Liste des points d'entrée des conférences, comme les URL ou les numéros de téléphone.
conferenceData.notes string
Remarques supplémentaires concernant la conférence (par exemple, les instructions de l'administrateur du domaine ou les mentions légales) à présenter à l'utilisateur. Peut contenir du code HTML. Ne doit pas dépasser 2 048 caractères
conferenceData.parameters object
Objet contenant une carte 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 ces valeurs sont définies par le développeur du module complémentaire pour associer des informations à une conférence spécifique qui seront utilisées par le module complémentaire.

Point d'entrée

Les objets de point d'entrée contiennent des informations sur les moyens établis d'accès à une conférence donnée, par exemple par téléphone ou vidéo. Ces informations sont présentes dans l'objet é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 point d'entrée
entryPoint.accessCode string
Code d'accès utilisé pour accéder à la conférence. Ne doit pas dépasser 128 caractères Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour permettre l'accès aux conférences. Faites correspondre les champs et n'affichez que ceux que le fournisseur de conférence utilise.
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 numéro vert.
entryPoint.entryPointType string
Type de point d'entrée. Les valeurs possibles sont les suivantes :
  • more : instructions supplémentaires pour participer à une conférence, telles que des numéros de téléphone secondaires. Une conférence ne peut avoir qu'un seul point d'entrée more. Au moins un autre type de point d'entrée est également requis.
  • phone : participez à 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 du téléphone, après mise en forme et tri par ordre alphabétique.
  • sip : participez à la conférence via SIP. Une conférence ne peut pas comporter plus de sip point d'entrée.
  • video : participez à la conférence via HTTP. Une conférence ne peut comporter 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. Ne doit pas dépasser 128 caractères Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour permettre l'accès aux conférences. Faites correspondre les champs et n'affichez que ceux que le fournisseur de conférence utilise.
entryPoint.passcode string
Le code secret permettant d'accéder à la conférence. Ne doit pas dépasser 128 caractères Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour permettre l'accès aux conférences. Faites correspondre les champs et n'affichez que ceux que le fournisseur de conférence utilise.
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. Ne doit pas dépasser 128 caractères Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour permettre l'accès aux conférences. Faites correspondre les champs et n'affichez que ceux que le fournisseur de conférence utilise.
entryPoint.pin string
Code utilisé pour accéder à la conférence. Ne doit pas dépasser 128 caractères Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour permettre l'accès aux conférences. Faites correspondre les champs et n'affichez que ceux que le fournisseur de conférence utilise.
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 CLDR de codes régionaux publique.
entryPoint.uri string
URI du point d'entrée. 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 l'intégralité de la séquence de numérotation (par exemple, &telt: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 événement Drive est la partie de l'objet événement global qui contient des informations sur le Google Drive d'un utilisateur et son contenu. Elle n'est présente dans un objet d'é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 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 la valeur est true, le module complémentaire a demandé et reçu l'autorisation https://www.googleapis.com/auth/drive.file du champ d'application pour cet élément. Sinon, ce champ est false.
item.id string
Identifiant de l'article 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 événement Gmail est la partie de l'objet événement global qui contient les informations concernant les messages Gmail d'un utilisateur. Elle n'est présente 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. Vous pouvez utiliser ce jeton avec la méthode GmailApp.setCurrentMessageAccessToken(accessToken) pour accorder à votre module complémentaire un accès temporaire à un message Gmail actuellement ouvert par 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 incluses dans le brouillon du module complémentaire. Pour activer ce champ, vous devez définir le champ "addOns.gmail.composeTrigger.draftAccess" dans le fichier manifeste sur "METADATA".
gmail.ccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires incluses dans le brouillon du module complémentaire. Pour activer ce champ, vous devez définir le champ "addOns.gmail.composeTrigger.draftAccess" dans le 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 incluses dans le brouillon du module complémentaire. Pour activer ce champ, vous devez définir le champ "addOns.gmail.composeTrigger.draftAccess" dans le fichier manifeste sur "METADATA".

Objet d'événement Docs

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

Objet d'événement Docs
docs.id string
Uniquement présente 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 stringPrésent uniquement si le niveau d'accès 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 https://www.googleapis.com/auth/drive.file du champ d'application pour le document ouvert dans l'interface utilisateur de Docs. Sinon, ce champ est défini sur false.

Objet d'événement Sheets

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

Objet d'événement Sheets
sheets.id string
Uniquement présente 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
Uniquement présente 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ès https://www.googleapis.com/auth/drive.file pour la feuille de calcul ouverte dans l'interface utilisateur de Sheets. Sinon, ce champ est défini sur false.

Objet d'événement Slides

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

Objet d'événement Slides
slides.id string
Uniquement présente 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'interface utilisateur de Slides.
slides.title string
Uniquement présente 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'interface utilisateur de Slides.
slides.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation https://www.googleapis.com/auth/drive.file du champ d'application pour la présentation ouverte dans l'interface utilisateur de Slides. Sinon, ce champ est défini sur false.