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 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 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 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 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éclenchent lorsque l'utilisateur entre dans un contexte spécifique. Exemple :

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

  • Actions du widget Les objets d'événement sont également utilisés pour fournir une interactivité de widget, en utilisant le même modèle d'action que les modules complémentaires Gmail. 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 d'aperçu du lien Dans Google Docs, Sheets et Slides, vous pouvez configurer des aperçus de liens pour des services tiers en fonction de formats d'URL spécifiques. Lorsque les utilisateurs interagissent avec un lien qui correspond au modèle, linkPreviewTriggers se déclenche et un objet d'événement contenant le lien est transmis à la fonction de rappel du déclencheur. Votre module complémentaire peut utiliser cet objet d'événement pour créer un chip 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.

  • Déclencheurs de l'application Google Chat (version Preview développeur) Dans Google Chat, votre module complémentaire apparaît aux utilisateurs comme une application Chat. Ils peuvent interagir avec lui en l'ajoutant à des espaces, en envoyant des messages, en utilisant des commandes à barre oblique, etc. Pour créer des fonctionnalités interactives, vous devez configurer et utiliser différents déclencheurs d'application Chat. Chaque déclencheur envoie une charge utile d'objet d'événement différente qui vous aide à traiter ou à répondre à chaque type d'interaction.

Structure de l'objet "É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 avoir l'un des champs de premier niveau spécifiques à 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é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 d'événement
eventObject.commonEventObject Common fields object
Objet contenant des informations communes à tous les objets d'événement, quelle que soit l'application hôte.
eventObject.calendar Calendar event object
Présent uniquement si l'hôte appelant est Google Agenda. Objet contenant des informations sur l'agenda et les événements.
eventObject.chat Chat event object
Présent uniquement si l'hôte appelant est Google Chat. Objet contenant des informations sur Chat.
eventObject.drive Drive event object
Présent uniquement si l'hôte appelant est Google Drive. Objet contenant des informations Drive.
eventObject.gmail Gmail event object
Présent uniquement si l'hôte appelant est Gmail. Objet contenant des informations Gmail.
eventObject.docs Docs event object
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. Objet contenant des informations Sheets.
eventObject.slides Slides event object
Présent uniquement si l'hôte appelant est Google Slides. Objet contenant des informations sur Slides.
Champs d'origine du module complémentaire Gmail
eventObject.messageMetadata.accessToken string
Obsolète. Un jeton d'accès Vous pouvez l'utiliser pour activer l'accès aux données utilisateur à l'aide d'étendues de module complémentaire Gmail temporaires.

Pour les modules complémentaires Google Workspace, ces informations se trouvent 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, ces informations se trouvent 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, ces informations se trouvent 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 pour vous faciliter la tâche lorsque vous devez lire des données à partir de plusieurs widgets avec des valeurs singulières attendues, telles que des entrées de texte et des boutons d'activation/de désactivation. 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, vous trouverez ces informations dans le champ eventObject.commonEventObject.formInputs. Les widgets à valeurs uniques sont représentés sous forme de tableaux avec un seul élément.

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

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

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

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

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

Pour les modules complémentaires Google Workspace, ces informations se trouvent 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. Par exemple, 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, ces informations se trouvent dans le champ eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Obsolète et désactivé par défaut Décalage par rapport au temps universel coordonné (UTC) du fuseau horaire de l'utilisateur, mesuré en millisecondes. 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, ces informations se trouvent dans le champ eventObject.commonEventObject.timeZone.offset.

Objet d'événement commun

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

En plus des déclencheurs de page d'accueil et contextuels, les modules complémentaires construisent et transmettent des objets d'événement aux fonctions de rappel d'action lorsque l'utilisateur interagit avec des widgets. La fonction de rappel de votre module complémentaire peut interroger l'objet d'événement commun pour déterminer le contenu des widgets ouverts dans le client de l'utilisateur. Par exemple, votre module complémentaire peut localiser le texte qu'un utilisateur a saisi dans un widget TextInput 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 de la 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, groupes de cases à cocher): liste de chaînes.

    Exemple: Pour un widget à valeurs multiples 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 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: TimeInput object.

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

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

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

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

Saisies du formulaire de sélecteur de date et 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. 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
Heure sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet DateInput
dateInput.msSinceEpoch string
Heure sélectionnée par l'utilisateur, en millisecondes depuis l'epoch (00:00:00 UTC le 1er janvier 1970).
Objet TimeInput
timeInput.hours number
Numéro de l'heure sélectionnée par l'utilisateur.
timeInput.minutes number
Nombre de minutes sélectionné par l'utilisateur.

Objet d'é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 le champ calendarEventObject d'un objet d'é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 manifest 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 pour afficher ou mettre à jour des 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 le cas contraire.
calendar.capabilities.canSeeAttendees boolean
Données générées par l'utilisateur true si le module complémentaire peut lire la liste des participants à l'événement ; false dans le cas contraire.
calendar.capabilities.canSeeConferenceData boolean
Données générées par l'utilisateur true si le module complémentaire peut lire les données de la conférence de l'événement ; false dans le cas contraire.
calendar.capabilities.canSetConferenceData boolean
Données générées par l'utilisateur true si le module complémentaire peut mettre à jour les données de la conférence de l'événement ; false 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 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 "participant" contiennent des informations sur les participants individuels aux événements Google Agenda. 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 manifest addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet "participant"
attendee.additionalGuests number
Nombre d'invités supplémentaires que l'utilisateur a indiqué qu'il emmènerait. Prend la valeur zéro par défaut.
attendee.comment string
Commentaire de réponse de l'utilisateur, le cas échéant.
attendee.displayName string
Nom à afficher du participant.
attendee.email string
Adresse e-mail de l'participant.
attendee.optional boolean
true si la participation de cet invité est marquée comme facultative ; false dans le cas contraire.
attendee.organizer boolean
true si le participant est l'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'invitation à l'événement.
  • declined: le participant a refusé l'invitation à l'événement.
  • needsAction: l'invité 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 manifest addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet de données de conférence
conferenceData.conferenceId string
ID de la conférence. Cet ID permet aux applications de suivre les conférences. Vous ne devez pas l'afficher aux utilisateurs.
conferenceData.conferenceSolution object
Objet représentant la solution de conférence, 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 Hangouts pour les consommateurs (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 de la conférence, 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 légaux) sur la conférence à afficher pour l'utilisateur. Peut contenir du code HTML. La longueur maximale est de 2 048 caractères.
conferenceData.parameters object
Objet contenant un mappage des données de paramè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 pour associer des informations à 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 manifest addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Objet de point d'entrée
entryPoint.accessCode string
Code d'accès utilisé pour accéder à la conférence. 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. Faites correspondre et n'affichez que les champs utilisés par le fournisseur 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 sans frais.
entryPoint.entryPointType string
Type de point d'entrée. Les valeurs possibles sont les suivantes :
  • more: instructions supplémentaires pour rejoindre la conférence, telles que 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: rejoindre 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 de téléphone, après avoir mis en forme et trié les données par ordre alphabétique.
  • sip: rejoindre la conférence via SIP. Une conférence ne peut comporter qu'un seul point d'entrée sip.
  • video: Rejoignez la conférence via HTTP. Une conférence ne peut avoir qu'un seul point d'entrée video.
entryPoint.label string
Libellé visible par l'utilisateur pour l'URI du point d'entrée (non localisé).
entryPoint.meetingCode string
Code de réunion utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.passcode string
Code secret utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.password string
Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférences n'utilisent généralement qu'un sous-ensemble de {accessCode, meetingCode, passcode, password, pin} pour fournir l'accès aux conférences. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.pin string
Code 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. Faites correspondre et n'affichez que les champs utilisés par le fournisseur de conférence.
entryPoint.regionCode string
Code de région du numéro de téléphone. Nécessaire pour les utilisateurs si l'URI n'inclut pas de code pays. Les valeurs sont basées sur la liste publique 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 type de point d'entrée :
  • more: un schéma http: ou https: est requis.
  • 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: un schéma sip: ou sips: est requis. Par 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 Google Drive et son contenu. Il n'est présent 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 d'élément 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 une autorisation de 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 d'événement Gmail

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

Objet d'événement Gmail
gmail.accessToken string
Jeton d'accès spécifique à Gmail. 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 champ addOns.gmail.composeTrigger.draftAccess de votre fichier manifeste sur METADATA.
gmail.messageId string
ID du message Gmail actuellement ouvert.
gmail.threadId string
ID de discussion Gmail actuellement ouverte.
gmail.toRecipients[] list of strings
Désactivé par défaut. Liste des adresses e-mail des destinataires de l'objet "À" 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.

Objet d'événement Docs

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

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

URL du lien qui génère un aperçu dans Google Docs. Pour utiliser ce champ, vous devez configurer le LinkPreviewTriggers dans le fichier manifeste de votre 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 dans un objet d'événement que si l'application hôte est Google Sheets.

Objet d'événement Sheets
sheets.id string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. ID de la feuille de calcul ouverte dans l'interface utilisateur de Sheets.
sheets.title string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. Titre de la feuille de calcul ouverte dans l'interface utilisateur de Sheets.
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:
  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Sheets. Pour utiliser ce champ, vous devez configurer le LinkPreviewTriggers dans le fichier manifeste de votre 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 l'interface utilisateur de Slides.
slides.title string
Présent uniquement si le champ d'application https://www.googleapis.com/auth/drive.file a été autorisé par l'utilisateur. Titre de la présentation ouverte dans l'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. Sinon, ce champ est false.
slides.matchedUrl.url string
Présent uniquement si les conditions suivantes sont remplies:
  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Slides. Pour utiliser ce champ, vous devez configurer le LinkPreviewTriggers dans le fichier manifeste de votre 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:

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