Cette page décrit la structure des objets d'événement des modules complémentaires Google Workspace.
Les objets "Événement" sont des structures JSON qui sont automatiquement construites et transmises comme paramètres pour déclencher ou rappeler des fonctions lorsqu'un utilisateur interagit avec un un module complémentaire. Les objets d'événement contiennent des informations côté client concernant l'application hôte et l'objet le contexte actuel dans la fonction de rappel côté serveur du module complémentaire.
Les modules complémentaires Google Workspace utilisent des objets d'événement aux endroits suivants:
Déclencheurs de la page d'accueil : Chaque fonction
homepageTrigger
que vous définissez reçoit automatiquement un événement lorsque la fonction de déclenchement de la page d'accueil s'exécute. Vous pouvez utiliser cet objet dans la fonction de déclencheur de votre page d'accueil pour identifier l'application hôte active, la plate-forme, les paramètres régionaux de l'utilisateur et d'autres informations.Les objets d'événement créés lors du déclenchement de la page d'accueil ne contiennent pas tous les sont inclus dans les deux autres cas ; concernant les widgets les informations contextuelles sont omises.
Déclencheurs contextuels : Chaque application hôte fournit un ensemble différent de déclencheurs contextuels qui se déclencher lorsque l'utilisateur entre dans un contexte spécifique. Exemple :
- Gmail fournit un déclencheur contextuel lorsqu'un utilisateur ouvre un message et une autre lorsqu'un utilisateur rédige 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 des fichiers Drive.
Lorsqu'un déclencheur contextuel est exécuté, l'application hôte appelle la méthode l'élément
runFunction
correspondant répertorié dans le fichier manifeste du module complémentaire, en lui transmettant une comme paramètre. Les objets d'événement créés Les déclencheurs "fire" contiennent tous les champs inclus dans l'événement de déclencheur de la page d'accueil des objets, ainsi que des champs contenant des informations contextuelles.Actions du widget : Objets "Événement" servent également à fournir des widgets, l'interactivité, en utilisant modèle d'action que les modules complémentaires Gmail utiliser. Les modules complémentaires Google Workspace utilisent les mêmes fonctions de gestionnaire de widgets, Objets
Action
et action des réponses. Toutefois, dans les modules complémentaires Google Workspace, des objets d'événement d'action inclure 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 toutes les les champs inclus dans les objets d'événement de déclencheur contextuel, ainsi que ceux contenant des informations sur le widget.
Déclencheurs de lien d'aperçu : Dans Google Docs, Sheets et Slides, vous pouvez : configurer des aperçus de liens pour des services tiers en fonction de formats d'URL spécifiques. Lorsque les utilisateurs interagissent avec un lien qui répond le modèle, le
linkPreviewTriggers
et un objet d'événement contenant le lien est transmis au de rappel. Votre module complémentaire peut utiliser cet objet d'événement pour créer un chip et une carte à puce qui affichent des informations sur le lien au sein de l'hôte application. Vous pouvez également créer des actions de widget pour permettre aux utilisateurs d'interagir avec la fiche d'aperçu et son contenu.
Structure des objets d'événement
Le tableau suivant décrit la structure de premier niveau
Objets d'événements des modules complémentaires Google Workspace L'événement
la structure d'objet comprend un élément commonEventObject
champ de premier niveau pour les informations
indépendantes de l'hôte. Chaque objet d'événement peut également
sont associés à l'un des champs de premier niveau suivants, spécifiques à l'hôte. Ces champs sont déterminés par le
application hôte active: gmailEventObject
,
calendarEventObject
ou driveEventObject
.
Pour assurer la rétrocompatibilité, les modules complémentaires Google Workspace Les objets d'événement incluent également tous les champs d'origine utilisés dans Objets d'événement d'action des modules complémentaires Gmail Ces champs sont répertoriés dans le tableau ci-dessous, sous "Champs du module complémentaire Gmail d'origine". les informations de ces champs sont reproduites dans la nouvelle structure d'objet.
Objet événement | |
---|---|
eventObject.commonEventObject |
Common fields object
Objet contenant des informations communes à tous les objets d'événement quelle que soit l'application hôte. |
eventObject.calendar |
Calendar event object
Présent uniquement si l'hôte appelant est Google Agenda. Un objet
contenant des informations
d'agenda et d'événements.
|
eventObject.drive |
Drive event object
Présent uniquement si l'hôte appelant est Google Drive. Un objet
contenant des informations Drive.
|
eventObject.gmail |
Gmail event object
Présent uniquement si l'hôte appelant est Gmail. Un objet
contenant des informations Gmail.
|
eventObject.docs |
Docs event object
Présent uniquement si l'hôte appelant est Google Docs. Un objet
contenant des informations sur les documents Google.
|
eventObject.sheets |
Sheets event object
Présent uniquement si l'hôte appelant est Google Sheets. Un objet
contenant des informations Sheets.
|
eventObject.slides |
Slides event object
Présent uniquement si l'hôte appelant est Google Slides. Un objet
contenant des informations Slides.
|
Champs du module complémentaire Gmail d'origine | |
eventObject.messageMetadata.accessToken |
string Obsolète. Un jeton d'accès Vous pouvez utiliser pour activer l'accès aux données utilisateur à l'aide des habilitations temporaires des modules complémentaires Gmail.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.messageMetadata.messageId |
string Obsolète. ID du message dans le fil de discussion ouvrir dans l'interface utilisateur de Gmail.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.clientPlatform |
string Obsolète. Indique le lieu de l'événement (Web, iOS ou Android).
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.formInput |
object Obsolète. Carte des valeurs actuelles de tous les widgets de formulaire de la fiche, à une seule valeur par widget. La les clés sont les identifiants de chaîne associés aux widgets et les valeurs sont de chaînes. L'objet événement fournit formInput en tant que
pratique lorsque vous avez besoin de lire
des données provenant de plusieurs widgets avec
les valeurs singulières attendues, telles que les entrées de texte et les commutateurs. Pour
widgets à valeurs multiples, tels que les cases à cocher, vous pouvez lire chaque valeur
formInputs à la place.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.formInputs |
object Obsolète. Une carte des valeurs actuelles de dans la fiche, sous forme de listes de chaînes. Les clés sont ID de chaîne associés au widget. Pour les widgets à valeur unique, le paramètre est présentée dans un tableau à un élément. Pour les widgets à valeurs multiples comme les groupes de cases à cocher, toutes les valeurs sont présentées sous forme de liste.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.parameters |
object Obsolète. La carte de tout autre emplacement que vous fournissez au <ph type="x-smartling-placeholder"></ph> Action utilisant
<ph type="x-smartling-placeholder"></ph>
Action.setParameters() Les clés et valeurs de mappage
de chaînes.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.userCountry |
string Obsolète et désactivé par défaut. La code à deux lettres indiquant le pays ou la région de l'utilisateur. Il peut aussi être une valeur numérique Code pays UN M49.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.userLocale |
string Obsolète et désactivé par défaut. La deux lettres ISO 639 indiquant la langue de l'utilisateur. Voir Accès de l'utilisateur (paramètres régionaux et fuseau horaire) pour en savoir plus.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.userTimezone.id |
string Obsolète et désactivé par défaut. La <ph type="x-smartling-placeholder"></ph> identifiant de fuseau horaire du fuseau horaire de l'utilisateur. Voici quelques exemples: America/New_York , Europe/Vienna et
Asia/Seoul Voir
<ph type="x-smartling-placeholder"></ph>
Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
eventObject.userTimezone.offset |
string Obsolète et désactivé par défaut. La <ph type="x-smartling-placeholder"></ph> le décalage horaire par rapport au temps universel coordonné (UTC) de et le fuseau horaire, mesuré en millisecondes. Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
Pour les modules complémentaires Google Workspace, vous trouverez ces informations dans le
|
Objet d'événement commun
L'objet d'événement commun est la partie de l'objet d'événement global qui contient des informations générales indépendantes de l'hôte au module complémentaire depuis le client de l'utilisateur. Ce Ces informations incluent, entre autres, les paramètres régionaux de l'utilisateur, l'application hôte et la plate-forme.
En plus de la page d'accueil et des déclencheurs contextuels, les modules complémentaires conçoivent
des objets d'événement aux fonctions de rappel d'action ;
lorsque l'utilisateur interagit avec les widgets. La fonction de rappel du module complémentaire peut interroger
l'objet d'événement commun pour déterminer le contenu des widgets ouverts dans le
client. Par exemple, votre module complémentaire peut localiser le texte saisi par un utilisateur dans un
Widget TextInput
dans
eventObject.commentEventObject.formInputs
.
Champs courants des objets d'événement | |
---|---|
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 qui s'affiche. Les clés de mappage sont les identifiants de chaîne est attribué à chaque widget. La structure de l'objet de valeur map est en fonction du type de widget:
|
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 : suivantes: <ph type="x-smartling-placeholder">
|
commonEventObject.parameters |
object Tout paramètre supplémentaire que vous à la
Action à l'aide de
Action.setParameters()
|
commonEventObject.userLocale |
string Désactivé par défaut. La langue de l'utilisateur et l'identifiant du pays/de la région au format ISO 639 code de langue : ISO 3166 code pays/région. Par exemple, en-US .
Pour activer ce champ, vous devez définir |
commonEventObject.timeZone |
string Désactivé par défaut. ID du fuseau horaire et le décalage. Pour activer ce champ, vous devez définir addOns.common.useLocaleFromApp à true dans le fichier manifeste du module complémentaire.
La liste des champs d'application de votre module complémentaire doit également inclure
https://www.googleapis.com/auth/script.locale
Voir <ph type="x-smartling-placeholder"></ph>
Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
|
commonEventObject.timeZone.id |
string Les <ph type="x-smartling-placeholder"></ph> identifiant de fuseau horaire du fuseau horaire de l'utilisateur. Voici quelques exemples: America/New_York , Europe/Vienna et
Asia/Seoul Pour activer ce champ, vous devez définir
addOns.common.useLocaleFromApp à true dans le fichier manifeste du module complémentaire.
La liste des champs d'application de votre module complémentaire doit également inclure
https://www.googleapis.com/auth/script.locale Voir
<ph type="x-smartling-placeholder"></ph>
Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus.
|
commonEventObject.timeZone.offset |
string Le <ph type="x-smartling-placeholder"></ph> le décalage horaire par rapport au temps universel coordonné (UTC) de et le fuseau horaire, mesuré en millisecondes. Voir <ph type="x-smartling-placeholder"></ph> Accès aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus. |
Entrées du formulaire pour le sélecteur de date et d'heure
Fonctions de rappel d'action
peut recevoir les valeurs actuelles du widget dans le champ commonEventObject.formInputs
.
Cela inclut les valeurs de date ou d'heure sélectionnées par l'utilisateur dans le sélecteur de date ou d'heure
widgets.
Cependant, la structure des informations diffère selon
le widget a été configuré pour utiliser un sélecteur de date/heure, un sélecteur de date uniquement ou un sélecteur horaire uniquement
sélecteur. Les différences structurelles sont décrites dans le tableau suivant:
Objet événement d'agenda
L'objet "Événement d'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. Il est uniquement est présent dans un objet "événement" si l'application hôte est Google Agenda.
Le tableau suivant répertorie les champs présents dans calendarEventObject
.
d'un objet événement. Les champs marqués comme Données générées par l'utilisateur sont
présents dans l'objet événement si et seulement si les données sont présentes dans l'agenda
et le module complémentaire définit son addOns.calendar.currentEventAccess
fichier manifeste
pour
READ
ou READ_WRITE
.
Objet événement d'agenda | |
---|---|
calendar.attendees[] |
list of attendee objects
Données générées par l'utilisateur. La liste des participants à l'agenda
.
|
calendar.calendarId |
string ID de l'agenda. |
calendar.capabilities |
object Données générées par l'utilisateur. Un objet décrivant les fonctionnalités du module complémentaire d'affichage ou de mise à jour de l'événement des informations. |
calendar.capabilities.canAddAttendees |
boolean Données générées par l'utilisateur. true
si le module complémentaire permet d'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
sinon. |
calendar.capabilities.canSeeConferenceData |
boolean Données générées par l'utilisateur. true
si le module complémentaire peut lire les données de la conférence de l'événement ; false
sinon. |
calendar.capabilities.canSetConferenceData |
boolean Données générées par l'utilisateur. true
si le module complémentaire peut mettre à jour les données de la conférence de l'événement ; false
sinon. |
calendar.capabilities.canAddAttachments |
boolean Données générées par l'utilisateur. true
si le module complémentaire peut ajouter des pièces jointes à l'événement ;
false dans les autres cas.
|
calendar.conferenceData |
Conference data object
Données générées par l'utilisateur. Objet représentant des données de conférence
associées à cet événement, comme les informations sur la conférence Google Meet.
|
calendar.id |
string ID de l'événement. |
calendar.organizer |
object Objet représentant l'organisateur du . |
calendar.organizer.email |
string Adresse e-mail de l'organisateur de l'événement. |
calendar.recurringEventId |
string ID d'un événement périodique. |
Participant
Les objets des participants transfèrent les informations sur les participants individuels dans Google Agenda.
événements. L'objet événement inclut ces informations si et seulement si les données
est présent dans l'événement Agenda et que le module complémentaire définit
addOns.calendar.currentEventAccess
fichier manifeste
pour
READ
ou READ_WRITE
.
Objet participant | |
---|---|
attendee.additionalGuests |
number Nombre d'invités supplémentaires par le participant avaient indiqué qu'ils apportaient. Prend la valeur zéro par défaut. |
attendee.comment |
string Commentaire dans la réponse du participant, le cas échéant. |
attendee.displayName |
string Nom affiché du participant. |
attendee.email |
string Adresse e-mail du participant. |
attendee.optional |
boolean true si la participation à cet événement
participant est marqué comme facultatif ; false dans le cas contraire.
|
attendee.organizer |
boolean true si le participant est
organisateur de cet événement.
|
attendee.resource |
boolean true , si le participant représente
ressource, comme une salle ou un équipement false
sinon.
|
attendee.responseStatus |
string État de la réponse du participant. Possible sont les suivantes: <ph type="x-smartling-placeholder">
|
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,
Google Meet ou les conférences tierces. Ces informations sont présentes dans
objet "event" si et seulement si les données sont présentes dans l'événement d'agenda et dans l'objet
le module complémentaire addOns.calendar.currentEventAccess
fichier manifeste
pour
READ
ou READ_WRITE
.
Objet de données de conférence | |
---|---|
conferenceData.conferenceId |
string ID de la conférence. Cet ID signifie pour permettre aux applications de suivre les conférences ; vous ne devriez pas présenter l'ID aux utilisateurs. |
conferenceData.conferenceSolution |
object Objet représentant la conférence. solution cloud, 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 Valeurs possibles incluent les éléments suivants: <ph type="x-smartling-placeholder">
|
conferenceData.conferenceSolution.name |
string Nom de cette conférence visible par l'utilisateur (non localisée). |
conferenceData.entryPoints[] |
list of entry point objects
Liste des points d'entrée des conférences, tels que des URL ou des numéros de téléphone. |
conferenceData.notes |
string Remarques supplémentaires (telles que les instructions l'administrateur du domaine ou les mentions légales) à propos de 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 de données de paramètre à utiliser par le module complémentaire. |
conferenceData.parameters.addOnParameters |
object Mappage de clés et de valeurs de chaîne de paramètres. Ces clés et valeurs sont définies par le développeur du module complémentaire à une conférence spécifique pour l'utilisation du module complémentaire. |
Point d'entrée
Les objets de point d’entrée contiennent des informations sur les moyens d’accès établis
lors d'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 d'agenda et
le module complémentaire définit son addOns.calendar.currentEventAccess
fichier manifeste
pour
READ
ou READ_WRITE
.
Objet point d'entrée | |
---|---|
entryPoint.accessCode |
string Code d'accès utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de { accessCode , meetingCode ,
passcode , password , pin } à
donnent accès à des conférences. Correspondent et n'affichent que les champs
utilisé par le fournisseur de services de conférence.
|
entryPoint.entryPointFeatures |
list Caractéristiques du point d'entrée. Actuellement, ces fonctionnalités ne s'appliquent qu'aux points d'entrée phone :
<ph type="x-smartling-placeholder">
|
entryPoint.entryPointType |
string Type de point d'entrée. Les valeurs possibles sont les suivantes : les éléments suivants: <ph type="x-smartling-placeholder">
|
entryPoint.label |
string Libellé visible par l'utilisateur pour l'URI du point d'entrée (non localisé). |
entryPoint.meetingCode |
string Code de réunion utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de { accessCode , meetingCode ,
passcode , password , pin } à
donnent accès à des conférences. Correspondent et n'affichent que les champs
utilisé par le fournisseur de services de conférence.
|
entryPoint.passcode |
string Code secret utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de { accessCode , meetingCode ,
passcode , password , pin } à
donnent accès à des conférences. Correspondent et n'affichent que les champs
utilisé par le fournisseur de services de conférence.
|
entryPoint.password |
string Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de { accessCode , meetingCode ,
passcode , password , pin } à
donnent accès à des conférences. Correspondent et n'affichent que les champs
utilisé par le fournisseur de services de conférence.
|
entryPoint.pin |
string Code utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. En général, les fournisseurs de services de conférence n'utilisez qu'un sous-ensemble de { accessCode , meetingCode ,
passcode , password , pin } à
donnent accès à des conférences. Correspondent et n'affichent que les champs
utilisé par le fournisseur de services de conférence.
|
entryPoint.regionCode |
string Code régional du numéro de téléphone. Requis par utilisateurs si l'URI n'inclut pas de code pays. Les valeurs sont basées sur le public Liste des codes régionaux CLDR |
entryPoint.uri |
string URI du point d'entrée. La valeur est de 1 300 caractères. La mise en forme dépend du point d'entrée type: <ph type="x-smartling-placeholder">
|
Objet événement Drive
L'objet événement Drive correspond à la partie de l'objet événement global qui contient des informations sur le Google Drive d'un utilisateur et son contenu. Il est uniquement est présent dans un objet d'événement si l'application hôte est Google Drive.
Objet événement Drive | |
---|---|
drive.activeCursorItem |
Drive item object
Élément Drive actuellement actif.
|
drive.selectedItems[] |
list of Drive item objects
Liste des éléments (fichiers ou dossiers) sélectionnés dans Drive.
|
Élément Drive
Les objets Drive contiennent des informations sur des éléments Drive spécifiques, tels que des fichiers. ou des dossiers.
Objet élément Drive | |
---|---|
item.addonHasFileScopePermission |
boolean Si true , le module complémentaire a demandé
et ont reçu https://www.googleapis.com/auth/drive.file
une autorisation de portée pour cet élément ; sinon ce champ est
false
|
item.id |
string ID de l'élément sélectionné. |
item.iconUrl |
string URL de l'icône représentant la l'élément sélectionné. |
item.mimeType |
string Type MIME de l'élément sélectionné. |
item.title |
string Titre de l'élément sélectionné. |
Objet événement Gmail
L'objet événement Gmail correspond à la partie de l'objet événement global qui contient sur les messages Gmail d'un utilisateur. Il n'est présent que dans un objet événement. si l'application hôte est Gmail.
Objet événement Gmail | |
---|---|
gmail.accessToken |
string Jeton d'accès spécifique à Gmail. Vous pouvez utiliser ce jeton avec le <ph type="x-smartling-placeholder"></ph> GmailApp.setCurrentMessageAccessToken(accessToken)
pour accorder au module complémentaire un accès temporaire aux autorisations
ouvrir un message Gmail ou autoriser le module complémentaire à rédiger de nouveaux brouillons.
|
gmail.bccRecipients[] |
list of strings Désactivé par défaut. La liste de "BCC:" adresses e-mail des destinataires actuellement incluses dans un brouillon un module complémentaire en cours de rédaction. Pour activer ce champ, vous devez définir le addOns.gmail.composeTrigger.draftAccess dans votre fichier manifeste pour
METADATA
|
gmail.ccRecipients[] |
list of strings Désactivé par défaut. La liste de "CC :" adresses e-mail des destinataires actuellement incluses dans un brouillon un module complémentaire en cours de rédaction. Pour activer ce champ, vous devez définir le addOns.gmail.composeTrigger.draftAccess dans votre fichier manifeste pour
METADATA
|
gmail.messageId |
string ID du message Gmail actuellement ouvert. |
gmail.threadId |
string ID du fil de discussion Gmail actuellement ouvert. |
gmail.toRecipients[] |
list of strings Désactivé par défaut. La liste de "À :" adresses e-mail des destinataires actuellement incluses dans un brouillon un module complémentaire en cours de rédaction. Pour activer ce champ, vous devez définir le addOns.gmail.composeTrigger.draftAccess dans votre fichier manifeste pour
METADATA
|
Objet événement Docs
L'objet événement "Docs" correspond à la partie de l'objet événement global qui contient des informations sur le document d'un utilisateur et son contenu. Il n'est présent que dans un si l'application hôte est Google Docs.
Objet événement Docs | |
---|---|
docs.id |
string Présent uniquement si le champ d'application
https://www.googleapis.com/auth/drive.file a été
autorisé par l'utilisateur.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.Le titre du document s'ouvre dans l'interface utilisateur de Docs. |
docs.addonHasFileScopePermission |
boolean Si true , le module complémentaire a demandé
et ont reçu https://www.googleapis.com/auth/drive.file
autorisation du champ d'application du document ouverte dans l'interface utilisateur de Docs sinon ceci
est false .
|
docs.matchedUrl.url |
string
Présent uniquement si les conditions suivantes sont remplies: <ph type="x-smartling-placeholder">
URL du lien qui génère un aperçu dans Google Docs. Pour utiliser ce champ, vous devez configurer LinkPreviewTriggers dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.
Exemple de charge utile lorsqu'un utilisateur affiche l'aperçu du lien "docs" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
Objet d'événement Sheets
L'objet événement Sheets correspond à la partie de l'objet événement global qui contient des informations sur le document d'un utilisateur et son contenu. Il n'est présent que dans un si l'application hôte est Google Sheets.
Objet d'événement Sheets | |
---|---|
sheets.id |
string Présent uniquement si le champ d'application
https://www.googleapis.com/auth/drive.file a été
autorisé par l'utilisateur. L'ID de la feuille de calcul s'ouvre dans l'interface utilisateur de Sheets.
|
sheets.title |
string Présent uniquement si le champ d'application
https://www.googleapis.com/auth/drive.file a été
autorisé par l'utilisateur. Titre de la feuille de calcul ouvert dans Sheets
UI.
|
sheets.addonHasFileScopePermission |
boolean Si true , le module complémentaire a demandé
et ont reçu https://www.googleapis.com/auth/drive.file
l'autorisation de la portée de la feuille de calcul, ouverte dans l'interface utilisateur de Sheets. sinon
ce champ est false .
|
sheets.matchedUrl.url |
string
Présent uniquement si les conditions suivantes sont remplies: <ph type="x-smartling-placeholder">
URL du lien qui génère un aperçu dans Google Sheets. Pour utiliser ce champ, vous devez configurer LinkPreviewTriggers dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.
Exemple de charge utile lorsqu'un utilisateur affiche l'aperçu du lien "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 que dans un si l'application hôte est Google Slides.
Objet d'événement Slides | |
---|---|
slides.id |
string Présent uniquement si le champ d'application
https://www.googleapis.com/auth/drive.file a été
autorisé par l'utilisateur. ID de la présentation ouverte dans Slides
UI.
|
slides.title |
string Présent uniquement si le champ d'application
https://www.googleapis.com/auth/drive.file a été
autorisé par l'utilisateur. Le titre de la présentation s'ouvre dans
Interface utilisateur de Slides
|
slides.addonHasFileScopePermission |
boolean Si true , le module complémentaire a demandé
et ont reçu https://www.googleapis.com/auth/drive.file
autorisation du champ d'application de 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: <ph type="x-smartling-placeholder">
URL du lien qui génère un aperçu dans Google Slides. Pour utiliser ce champ, vous devez configurer LinkPreviewTriggers dans le fichier manifeste du module complémentaire.
Pour en savoir plus, consultez Prévisualiser les liens avec des chips intelligents.
Exemple de charge utile lorsqu'un utilisateur affiche l'aperçu du lien "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |