Objets d'événement

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

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 déclencher 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 aux emplacements suivants:

  • Déclencheurs de page d'accueil. Chaque fonction homepageTrigger que vous définissez reçoit automatiquement un objet d'événement lorsque la fonction de déclenchement de la page d'accueil se déclenche. Vous pouvez utiliser cet objet dans 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 est exécuté, l'application hôte appelle le 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éclenchement de la page d'accueil, ainsi que les champs contenant les informations contextuelles.

  • Actions du widget. Les objets d'événement sont également utilisés pour assurer l'interactivité des widgets, à l'aide du même modèle d'action que celui utilisé pour 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 contiennent davantage 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énements de déclenchement contextuel, ainsi que des champs contenant des informations sur le widget.

  • Déclencheurs du lien d'aperçu (aperçu pour les développeurs) Dans Google Docs, vous pouvez configurer des aperçus de liens pour des services tiers en fonction de formats d'URL spécifiques. Lorsque les utilisateurs interagissent avec un lien correspondant au schéma, previewLinkTrigger 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 une puce intelligente 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 carte 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 modules complémentaires Google Workspace. La structure d'objet de l'événement inclut un champ commonEventObject de premier niveau 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és par l'application hôte active: gmailEventObject, calendarEventObject ou driveEventObject.

Pour assurer la rétrocompatibilité, les objets d'événements de modules complémentaires Google Workspace incluent également tous les champs d'origine utilisés dans les objets d'événements de modules complémentaires d'actions Gmail. Ces champs sont répertoriés dans le tableau ci-dessous sous "Champs de modules complémentaires Gmail d'origine". 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 sur 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'organisateur 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 Un objet contenant des informations Slides.
Champs des modules complémentaires Gmail d'origine
eventObject.messageMetadata.accessToken string
Obsolète. Un jeton d'accès Vous pouvez vous en servir pour activer l'accès aux données utilisateur à l'aide de champs d'application temporaires 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'UI 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 correspondent aux ID de chaîne associés aux widgets et les valeurs aux chaînes. L'objet événement fournit formInput pour vous aider à lire les données de plusieurs widgets avec les valeurs singulières attendues, telles que les entrées de texte et les contacteurs. Pour les widgets à valeurs multiples tels que les cases à cocher, vous pouvez lire chaque valeur à partir de formInputs.

Pour les modules complémentaires Google Workspace, recherchez plutôt ces informations dans le champ eventObject.commonEventObject.formInputs. Les widgets 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 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 à la 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 indiquant la langue de l'utilisateur. Pour en savoir plus, consultez Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur.

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

eventObject.userTimezone.id string
Obsolète et désactivée par défaut Identifiant 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 d'événement commun

L'objet événement courant correspond à la partie de l'objet événement global qui contient des informations générales indépendantes de l'hôte. 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 des déclencheurs de page d'accueil et de déclencheurs contextuels, les modules complémentaires créent et transmettent des objets d'événement aux fonctions de rappel d'action lorsque l'utilisateur interagit avec les widgets. La fonction de rappel de votre module complémentaire peut interroger l'objet événement courant 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 dans 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 avec 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 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, des groupes de cases à cocher): liste de chaînes.

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

  • A date-time picker: DateTimeInput object.

    Exemple: Pour un outil de sélection ayant 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 outil de sélection ayant 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 outil de sélection ayant l'ID myTimePicker, accédez à l'objet TimeInput à l'aide de e.commonEventObject.formInputs.myTimePicker[].timeInput.

Dans l'environnement d'exécution V8, la structure de l'objet de valeur de carte dépend également de l'origine de l'événement:

  • Pour le Web et Android, la structure est {"stringInputs":{"value":[""]}}.
  • Pour iOS, la structure est [''].
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 à 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 ISO 639, code ISO 3166 du pays/de la région. Par exemple, en-US.

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

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

Entrées du formulaire de sélection de l'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é en tant que sélecteur de date/heure, ou 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 l'heure de la date d'entrée inclut une date ; si false seule une heure est incluse.
dateTimeInput.hasTime boolean
true si l'heure de la date d'entrée inclut 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 du 1er janvier 1970).
Objet DateInput
dateInput.msSinceEpoch string
Heure sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC du 1er janvier 1970).
Objet TimeInput
timeInput.hours number
Nombre d'heures sélectionnées par l'utilisateur.
timeInput.minutes number
Nombre de minutes sélectionnées par l'utilisateur.

Objet d'événement d'agenda

L'objet événement "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. 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 é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 que le module complémentaire définit son champ 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 les utilisateurs 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 dans les autres cas
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 sur les é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 la conférence événementielle. Sinon, false.
calendar.capabilities.canAddAttachments boolean
Données générées par l'utilisateur. true si le module complémentaire peut ajouter de nouvelles pièces jointes à l'événement ; false dans le cas contraire.
calendar.conferenceData Conference data object
Données générées par les utilisateurs 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 participant transportent des informations sur les participants à des é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 addOns.calendar.currentEventAccess fichier manifeste sur READ ou READ_WRITE.

Objet participant
attendee.additionalGuests number
Nombre de personnes supplémentaires que le participant a indiqué qu'il apporte. Prend la valeur zéro par défaut.
attendee.comment string
Commentaire de la réponse du participant, 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 à ce participant est marquée comme facultative ; false dans le cas contraire.
attendee.organizer boolean
true si le participant est un organisateur pour cet événement.
attendee.resource boolean
true si le participant représente une ressource (salle ou équipement, par exemple) ; 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 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 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 é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 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 ID permet aux applications de suivre les conférences. Vous ne devez pas l'afficher pour 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 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 par l'utilisateur de cette solution de conférence (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 à présenter à l'utilisateur. Peut contenir du code HTML. La longueur maximale est de 2 048 caractères.
conferenceData.parameters object
Objet contenant une carte des données de paramètre définies à utiliser par le module complémentaire.
conferenceData.parameters.addOnParameters object
Mappage des clés et des valeurs de chaîne de paramètre. Ces clés et valeurs sont définies par le développeur de modules complémentaires pour associer des informations à une conférence spécifique afin d'utiliser le module complémentaire.

Point d'entrée

Les objets de point d'entrée contiennent des informations sur les moyens d'accéder à une conférence donnée, par téléphone ou vidéo, par exemple. 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 manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet de point d'entrée
entryPoint.accessCode string
Code d'accès utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Établir une correspondance et n'afficher que les champs utilisés par le fournisseur de conférences
entryPoint.entryPointFeatures list
Caractéristiques du point d'entrée. Actuellement, ces fonctionnalités ne s'appliquent qu'aux points d'entrée phone :
  • toll: le point d'entrée est un appel téléphonique payant.
  • toll_free: le point d'entrée est un appel sans frais.
entryPoint.entryPointType string
Type de point d'entrée. Les valeurs possibles sont les suivantes :
  • more: instructions supplémentaires pour participer à la conférence, telles que d'autres numéros de téléphone Une conférence ne peut avoir qu'un seul point d'entrée more. S'il est présent, au moins un autre type de point d'entrée est également requis.
  • phone: participez à la conférence depuis un numéro de 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 le formatage et le tri alphabétique.
  • sip: participez à la conférence via SIP. Une conférence ne peut comporter qu'un seul point d'entrée sip.
  • 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. 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 l'accès aux conférences. Établir une correspondance et n'afficher que les champs utilisés par le fournisseur de conférences
entryPoint.passcode string
Code secret permettant d'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 l'accès aux conférences. Établir une correspondance et n'afficher que les champs utilisés par le fournisseur de conférences
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Établir une correspondance et n'afficher que les champs utilisés par le fournisseur de conférences
entryPoint.pin string
Code d'accès permettant d'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 l'accès aux conférences. Établir une correspondance et n'afficher que les champs utilisés par le fournisseur de conférences
entryPoint.regionCode string
Code de région du numéro de téléphone. Obligatoire pour les utilisateurs si l'URI n'inclut pas de code pays. Les valeurs sont basées sur la liste publique CLDR des codes des régions.
entryPoint.uri string
URI du point d'entrée. La longueur maximale est de 1 300 caractères. La mise en forme dépend du type de point d'entrée :
  • more: un schéma http: ou https: est requis.
  • phone: un schéma tel: est requis. L'URI doit inclure l'intégralité de la séquence de numérotation (par exemple, "tel:+12345678900,,,12345678;1234").
  • sip: un schéma sip: ou sips: est requis. 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 est la partie de l'objet d'événement global qui contient des informations sur le Google Drive d'un utilisateur et sur 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'élément Drive est 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 du champ d'application https://www.googleapis.com/auth/drive.file 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 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 est la partie qui contient les informations sur 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 é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 par un utilisateur, ou lui permettre de rédiger de nouveaux brouillons.
gmail.bccRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail destinataires "BCC" (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 destinataires "CC" actuellement incluses dans un 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.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 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. 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'UI Docs.
docs.title string
Uniquement présente si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur.
Titre du document ouvert dans l'UI Docs.
docs.addonHasFileScopePermission boolean
Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation du champ d'application https://www.googleapis.com/auth/drive.file pour le document ouvert dans l'interface utilisateur de Docs. Sinon, ce champ est défini sur false.
docs.matchedUrl.url string
Uniquement si les conditions suivantes sont remplies:
  • L'utilisateur a autorisé https://www.googleapis.com/auth/documents.readonly.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

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

Objet d'événement Sheets

L'objet d'événement Sheets est la partie de l'objet d'événement global contenant 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 du 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 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 pour la présentation ouverte dans l'interface utilisateur de Slides. Sinon, ce champ est false.