EventObject

EventObject

Événement d'interaction avec un module complémentaire Google contenant des données sur l'interaction d'un utilisateur avec un module complémentaire dans une application hôte.

L'objet d'événement est transmis au format JSON à la fonction de rappel ou au déclencheur d'un module complémentaire (pour Apps Script), ou au point de terminaison https (pour HTTP), lorsqu'un utilisateur interagit avec un module complémentaire dans une application hôte. L'objet d'événement stocke un objet d'événement d'application hôte défini par chaque application hôte, ainsi qu'un objet d'événement commun contenant des champs communs liés à l'événement.

Pour en savoir plus, consultez Objets d'événement.

Représentation JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Champs
commonEventObject

object (CommonEventObject)

Objet contenant des informations communes à tous les objets d'événement, quelle que soit l'application hôte.

authorizationEventObject

object (AuthorizationEventObject)

Défini uniquement pour les requêtes adressées aux points de terminaison HTTP

Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
calendar

object (CalendarEventObject)

Présent uniquement si l'hôte appelant est Google Agenda. Objet contenant des informations sur l'agenda et les événements.

drive

object (DriveEventObject)

Présent uniquement si l'hôte appelant est Google Drive. Objet contenant des informations sur Drive.

gmail

object (GmailEventObject)

Présent uniquement si l'hôte appelant est Gmail. Objet contenant des informations Gmail.

sheets

object (SheetsEventObject)

Présent uniquement si l'hôte appelant est Google Sheets. Objet contenant des informations sur Sheets.

slides

object (SlidesEventObject)

Uniquement présent si l'hôte appelant est Google Slides. Objet contenant des informations sur Slides.

docs

object (DocsEventObject)

Présent uniquement si l'hôte appelant est Google Docs. Objet contenant des informations sur Docs.

chat

object (ChatEventObject)

Présent uniquement si l'hôte appelant est Google Chat. Objet contenant des informations sur Chat.

workflow

object (WorkflowEventObject)

Présent uniquement si l'hôte appelant est Google Workspace Studio. Objet contenant des informations sur le workflow.

Fin des champs mutuellement exclusifs.

CommonEventObject

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 de l'utilisateur, l'application hôte et la plate-forme.

En plus des déclencheurs de page d'accueil et 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 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 de l'objet eventObject.commentEventObject.formInputs.

Pour les applications Chat, nom de la fonction appelée par l'utilisateur lorsqu'il interagit avec un widget.

Représentation JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Champs
userLocale

string

Désactivé par défaut. Identifiant de la langue et du pays/de la région de l'utilisateur au format code de langue ISO 639-code de 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 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.

hostApp

enum (HostApp)

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
  • CHAT
platform

enum (Platform)

Énumération de la plate-forme qui indique la plate-forme d'origine de l'événement (WEB, IOS ou ANDROID). Non compatible avec les applications Chat.

timeZone

object (TimeZone)

Désactivé par défaut. ID du fuseau horaire et décalage par rapport au temps universel coordonné (UTC). 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.

Uniquement compatible avec les types d'événements CARD_CLICKED et SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Mappage contenant les valeurs actuelles des widgets de la fiche affichée. Les clés de mappage sont les valeurs de chaîne name attribuées à chaque widget d'entrée (par exemple, TextInput.name, SelectionInput.name, DateTimePicker.name ou DecoratedText.SwitchControl.name).

La structure de l'objet de valeur de mappage dépend du type de widget :

Remarque : Les exemples suivants sont formatés pour l'environnement d'exécution V8 d'Apps Script. Si vous utilisez l'environnement d'exécution Rhino, vous devez ajouter [""] après la valeur. Par exemple, au lieu de e.commonEventObject.formInputs.employeeName.stringInputs.value[0], formatez l'objet d'événement en tant que e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Pour en savoir plus sur les environnements d'exécution dans Apps Script, consultez la présentation de l'environnement d'exécution V8.

  • Widgets à valeur unique (par exemple, un widget TextInput ou un widget SelectionInput de type DROPDOWN ou RADIO_BUTTON) : un objet StringInputs contenant une liste à un seul élément (ou une liste vide si aucune sélection n'est effectuée).

Exemple : pour un widget de saisie de texte dont le name est employeeName, accédez à la valeur de saisie de texte avec e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Widgets à valeurs multiples (par exemple, un widget SelectionInput de type CHECK_BOX, SWITCH ou MULTI_SELECT) : un objet StringInputs contenant la liste des chaînes value de l'élément sélectionné.

Exemple : pour un widget à valeurs multiples dont l'name est participants, accédez au tableau de valeurs avec e.commonEventObject.formInputs.participants.stringInputs.value.

  • Un widget DecoratedText.SwitchControl : un objet StringInputs. Lorsque selected est défini sur true, stringInputs.value contient le champ value du commutateur (ou "" si value n'a pas été spécifié ; si plusieurs commutateurs partagent le même name, le champ value de chaque commutateur sélectionné est inclus dans la liste). Lorsque selected est false, le value du commutateur est omis de stringInputs.value.

  • Un sélecteur de date et d'heure (DateTimePickerType.DATE_AND_TIME) : un DateTimeInput object.

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

  • Un sélecteur de date uniquement (DateTimePickerType.DATE_ONLY) : un DateInput object.

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

  • Un sélecteur d'heure uniquement (DateTimePickerType.TIME_ONLY) : un TimeInput object.

Exemple : Pour un sélecteur avec un name de myTimePicker, accédez à l'objet TimeInput à l'aide de e.commonEventObject.formInputs.myTimePicker.timeInput.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

Tous les paramètres supplémentaires que vous fournissez à une action à l'aide de actionParameters ou Action.setParameters().

Preview développeur : pour les modules complémentaires qui étendent Google Chat, afin de suggérer des éléments en fonction de ce que les utilisateurs saisissent dans les menus à sélection multiple, utilisez la valeur de la clé "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Vous pouvez utiliser cette valeur pour interroger une base de données et suggérer des éléments sélectionnables aux utilisateurs à mesure qu'ils saisissent du texte. Pour en savoir plus, consultez Collecter et traiter les informations des utilisateurs de Google Chat.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Nom de la fonction à appeler.

Ce champ n'est pas renseigné pour les modules complémentaires Google Workspace qui étendent Google Chat. Pour recevoir des données de fonction telles que des identifiants, les modules complémentaires qui étendent Chat doivent utiliser le champ parameters. Consultez Créer des interfaces interactives pour les applications Chat.

HostApp

Application Google Workspace pour un module complémentaire Google Workspace ou une application Google Chat.

Pour les modules complémentaires, l'application Workspace à partir de laquelle un module complémentaire Google Workspace est lancé. Pour les applications Chat, l'application hôte est toujours CHAT.

Enums
UNSPECIFIED_HOST_APP Google ne peut pas identifier d'application hôte.
GMAIL Le module complémentaire se lance depuis Gmail.
CALENDAR Le module complémentaire se lance depuis Google Agenda.
DRIVE Le module complémentaire se lance depuis Google Drive.
DEMO Non utilisé.
DOCS Le module complémentaire se lance depuis Google Docs.
MEET Le module complémentaire se lance depuis Google Meet.
SHEETS Le module complémentaire se lance depuis Google Sheets.
SLIDES Le module complémentaire se lance depuis Google Slides.
DRAWINGS Le module complémentaire se lance depuis Google Drawings.
CHAT Une application Google Chat.

Plate-forme

Identifie la plate-forme d'où provient cet appel.

Enums
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

L'ID du fuseau horaire et le décalage par rapport au temps universel coordonné (UTC). Uniquement compatible avec les types d'événements CARD_CLICKED et SUBMIT_DIALOG.

Représentation JSON
{
  "id": string,
  "offset": integer
}
Champs
id

string

Code de la base de données de fuseaux horaires IANA TZ, par exemple "America/Toronto".

offset

integer

Décalage du fuseau horaire de l'utilisateur, en millisecondes, par rapport au temps universel coordonné (UTC).

Entrées

Types de données que les utilisateurs peuvent saisir dans des fiches ou des boîtes de dialogue. Le type d'entrée dépend du type de valeurs acceptées par le widget.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
stringInputs

object (StringInputs)

Liste de chaînes représentant les valeurs saisies par l'utilisateur dans un widget.

Si le widget n'accepte qu'une seule valeur, comme un widget TextInput, la liste contient un objet de chaîne. Si le widget accepte plusieurs valeurs, comme un widget SelectionInput de cases à cocher, la liste contient un objet de chaîne pour chaque valeur saisie ou sélectionnée par l'utilisateur.

dateTimeInput

object (DateTimeInput)

Valeurs d'entrée de date et d'heure d'un widget DateTimePicker qui accepte à la fois une date et une heure.

dateInput

object (DateInput)

Valeurs d'entrée de date d'un widget DateTimePicker qui n'accepte que les valeurs de date.

timeInput

object (TimeInput)

Valeurs d'entrée d'heure d'un widget DateTimePicker qui n'accepte que les valeurs d'heure.

Fin des champs mutuellement exclusifs.

StringInputs

Paramètre d'entrée pour les widgets standards. Pour les widgets à valeur unique, il s'agit d'une liste à valeur unique. Pour les widgets à valeurs multiples, tels que les cases à cocher, toutes les valeurs sont présentées.

Représentation JSON
{
  "value": [
    string
  ]
}
Champs
value[]

string

Liste de chaînes saisies par l'utilisateur.

DateTimeInput

Valeurs d'entrée de date et d'heure.

Représentation JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Champs
msSinceEpoch

string (int64 format)

Temps écoulé depuis l'epoch, en millisecondes.

hasDate

boolean

Indique si l'entrée datetime inclut une date calendaire.

hasTime

boolean

Indique si l'entrée datetime inclut un code temporel.

DateInput

Valeurs d'entrée de date.

Représentation JSON
{
  "msSinceEpoch": string
}
Champs
msSinceEpoch

string (int64 format)

Temps écoulé depuis l'epoch, en millisecondes.

TimeInput

Valeurs d'entrée de l'heure.

Représentation JSON
{
  "hours": integer,
  "minutes": integer
}
Champs
hours

integer

Heure selon le format "24 heures".

minutes

integer

Nombre de minutes après l'heure pile. Les valeurs valides sont comprises entre 0 et 59.

AuthorizationEventObject

Encapsule les informations d'autorisation pour la requête du module complémentaire.

Représentation JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Champs
userOAuthToken

string

Jeton d'accès OAuth de l'utilisateur final, autorisé avec les champs d'application demandés. (Après la dissociation du consentement OAuth, l'autorisation sera accordée avec les champs d'application autorisés par l'utilisateur final.)

userIdToken

string

Un jeton d'ID d'utilisateur final, si les champs d'application d'ID appropriés sont demandés

systemIdToken

string

Un jeton d'ID pour le compte de service des modules complémentaires G Suite pour ce déploiement

authorizedScopes[]

string

Liste des champs d'application OAuth autorisés par l'utilisateur.

CalendarEventObject

L'objet d'événement Agenda est la partie de l'objet d'é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 liste les champs présents dans le champ calendar d'un objet d'événement. Les champs marqués comme Données générées par l'utilisateur ne sont présents dans l'objet d'événement que si les données sont présentes dans l'événement d'agenda et que le module complémentaire définit son champ addOns.calendar.currentEventAccess du fichier manifeste sur READ ou READ_WRITE.

Représentation JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Champs
id

string

ID de l'événement.

recurringEventId

string

ID d'un événement périodique.

calendarId

string

ID de l'agenda.

organizer

object (Organizer)

Objet représentant l'organisateur de l'événement.

attendees[]

object (Attendee)

Données générées par l'utilisateur Liste des participants à l'événement d'agenda.

conferenceData

object (ConferenceData)

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.

capabilities

object (Capabilities)

Données générées par l'utilisateur Objet décrivant les fonctionnalités du module complémentaire pour afficher ou modifier les informations sur l'événement.

Organisateur

Représentation JSON
{
  "email": string
}
Champs
email

string

Adresse e-mail de l'organisateur de l'événement.

Participant

Les objets Attendee contiennent des informations sur les participants à des événements Google Agenda. Ces informations ne sont présentes dans l'objet d'événement que si elles sont présentes dans l'événement d'agenda et que le module complémentaire définit son champ de manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Représentation JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Champs
email

string

Adresse e-mail du participant.

displayName

string

Nom à afficher du participant.

organizer

boolean

true si le participant est un organisateur de cet événement.

self

boolean

true si ce participant représente l'agenda dans lequel cet événement apparaît ; false sinon.

resource

boolean

true si le participant représente une ressource, telle qu'une salle ou un équipement ; false sinon.

optional

boolean

true si la présence de ce participant est marquée comme facultative ; false sinon.

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 accepté provisoirement l'invitation à l'événement.
comment

string

Commentaire de réponse du participant, le cas échéant.

additionalGuests

integer

Nombre d'invités supplémentaires que le participant a indiqué amener. Prend la valeur zéro par défaut.

ConferenceData

Les objets de données de conférence contiennent des informations sur les conférences associées à des événements Google Agenda. Il peut s'agir de solutions de conférence Google, comme Google Meet, ou de conférences tierces. Ces informations ne sont présentes dans l'objet d'événement que si elles sont présentes dans l'événement d'agenda et que le module complémentaire définit son champ de manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Représentation JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Champs
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.

conferenceSolution

object (ConferenceSolution)

Objet représentant la solution de conférence, telle que Hangouts ou Google Meet.

entryPoints[]

object (EntryPoint)

Liste des points d'entrée de la conférence, tels que des URL ou des numéros de téléphone.

notes

string

Remarques supplémentaires (telles que les instructions de l'administrateur de domaine ou les mentions légales) concernant la conférence à afficher pour l'utilisateur. Peut contenir du code HTML. La longueur maximale est de 2 048 caractères.

parameters

object (Parameters)

Objet contenant un mappage des données de paramètres définies à utiliser par le module complémentaire.

ConferenceSolution

Représentation JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Champs
iconUri

string

URI de l'icône visible par l'utilisateur représentant cette solution de conférence.

key

object (Key)

Clé qui identifie de manière unique la solution de conférence pour cet événement.

name

string

Nom de cette solution de conférence visible par l'utilisateur (non localisé).

Clé

Représentation JSON
{
  "type": string
}
Champs
type

string

Type de solution de conférence. Les valeurs possibles sont les suivantes :

EntryPoint

Les objets de point d'entrée contiennent des informations sur les moyens d'accès établis à une conférence donnée, par exemple par téléphone ou par vidéo. Ces informations ne sont présentes dans l'objet d'événement que si elles sont présentes dans l'événement d'agenda et que le module complémentaire définit son champ de manifeste addOns.calendar.currentEventAccess sur READ ou READ_WRITE.

Représentation JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Champs
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érence 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.

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 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 : participer à la conférence via un numéro de téléphone. Une conférence peut comporter zéro ou plusieurs points d'entrée téléphoniques. Google Agenda n'affiche que les deux premiers points d'entrée téléphoniques, après mise en forme et tri par ordre alphabétique.
  • sip : participer à la conférence via SIP. Une conférence ne peut comporter qu'un seul point d'entrée sip.
  • video : rejoindre la conférence via HTTP. Une conférence ne peut avoir qu'un seul point d'entrée vidéo.
label

string

Libellé visible par l'utilisateur pour l'URI du point d'entrée (non localisé).

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érence 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.

passcode

string

Code secret utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence 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.

password

string

Mot de passe utilisé pour accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence 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.

pin

string

Code permettant d'accéder à la conférence. La longueur maximale est de 128 caractères. Les fournisseurs de conférence 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.

uri

string

URI du point d'entrée. La longueur ne doit pas dépasser 1 300 caractères. La mise en forme dépend du type de point d'entrée :

  • more : un schéma http: ou https: est requis.
  • phone : un schéma tel: est requis. L'URI doit inclure l'intégralité de la séquence de numérotation (par exemple, "tel:+12345678900,,,12345678;1234").
  • sip : un schéma sip: ou sips: est requis. Par exemple, "sip:12345678@myprovider.com".
  • video : un schéma http: ou https: est requis.
regionCode

string

Code régional 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 de région CLDR.

entryPointFeatures[]

string

Fonctionnalités du point d'entrée. Actuellement, ces fonctionnalités ne s'appliquent qu'aux points d'entrée téléphoniques :

  • toll : le point d'entrée est un appel téléphonique payant.
  • toll_free : le point d'entrée est un appel téléphonique sans frais.

Paramètres

Représentation JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Champs
addOnParameters

object (AddOnParameters)

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 du module complémentaire pour associer des informations à une conférence spécifique afin que le module complémentaire puisse les utiliser.

AddOnParameters

Représentation JSON
{
  "parameters": {
    string: string,
    ...
  }
}
Champs
parameters

map (key: string, value: string)

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Capacités

Représentation JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Champs
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.

canAddAttendees

boolean

Données générées par l'utilisateur : true si le module complémentaire peut ajouter de nouveaux participants à la liste des participants à l'événement ; false sinon.

canSeeConferenceData

boolean

Données générées par l'utilisateur : true si le module complémentaire peut lire les données de conférence de l'événement ; false sinon.

canSetConferenceData

boolean

Données générées par l'utilisateur : true si le module complémentaire peut mettre à jour les données de conférence de l'événement ; false sinon.

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 sinon.

DriveEventObject

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 son contenu. Il n'est présent dans un objet d'événement que si l'application hôte est Google Drive.

Représentation JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Champs
selectedItems[]

object (DriveItemMetadata)

Liste des éléments (fichiers ou dossiers) sélectionnés dans Drive.

activeCursorItem

object (DriveItemMetadata)

Élément Drive actuellement actif.

DriveItemMetadata

Les objets d'élément Drive contiennent des informations sur des éléments Drive spécifiques, tels que des fichiers ou des dossiers.

Représentation JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Champs
id

string

ID de l'élément sélectionné.

iconUrl

string

URL de l'icône représentant l'élément sélectionné.

mimeType

string

Type MIME de l'élément sélectionné.

title

string

Titre de l'élément sélectionné.

addonHasFileScopePermission

boolean

Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accès https://www.googleapis.com/auth/drive.file pour cet élément. Sin false.

Si le module complémentaire utilise un champ d'application plus permissif, tel que https://www.googleapis.com/auth/drive ou https://www.googleapis.com/auth/drive.readonly, ce champ n'est pas pertinent. Utilisez toujours les champs d'application les moins permissifs possible lorsque vous concevez des modules complémentaires afin de protéger les informations des utilisateurs.

GmailEventObject

L'objet d'événement Gmail est la partie de l'objet d'é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.

Représentation JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Champs
messageId

string

ID du message Gmail actuellement ouvert.

threadId

string

ID du fil de discussion Gmail actuellement ouvert.

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.

toRecipients[]

string

Désactivé par défaut. Liste des adresses e-mail des destinataires "À" actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess sur METADATA dans votre fichier manifeste.

ccRecipients[]

string

Désactivé par défaut. Liste des adresses e-mail des destinataires en copie actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess sur METADATA dans votre fichier manifeste.

bccRecipients[]

string

Désactivé par défaut. Liste des adresses e-mail des destinataires en "Cci" actuellement incluses dans un brouillon que le module complémentaire est en train de rédiger. Pour activer ce champ, vous devez définir le champ addOns.gmail.composeTrigger.draftAccess sur METADATA dans votre fichier manifeste.

SheetsEventObject

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 le module complémentaire étend Google Sheets.

Représentation JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Champs
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'UI 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'UI Sheets.

addonHasFileScopePermission

boolean

Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au champ d'application https://www.googleapis.com/auth/drive.file pour la feuille de calcul ouverte dans l'UI Sheets. Sinon, ce champ est défini sur false.

matchedUrl

object (MatchedUrl)

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 LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les 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"
  }
}

MatchedUrl

Objet d'événement renvoyé avec les requêtes d'aperçu de lien.

Représentation JSON
{
  "url": string
}
Champs
url

string

URL correspondante.

SlidesEventObject

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 le module complémentaire étend Google Slides.

Représentation JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Champs
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'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. Titre de la présentation ouverte dans l'UI Slides.

addonHasFileScopePermission

boolean

Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au 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 défini sur false.

matchedUrl

object (MatchedUrl)

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 LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les 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"
  }
}

DocsEventObject

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 le module complémentaire étend Google Docs.

Représentation JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Champs
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'UI 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.

addonHasFileScopePermission

boolean

Si la valeur est true, le module complémentaire a demandé et reçu l'autorisation d'accéder au 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.

matchedUrl

object (MatchedUrl)

Présent uniquement si les conditions suivantes sont remplies :

  • https://www.googleapis.com/auth/workspace.linkpreview a été autorisé par l'utilisateur.
  • L'URL correspond au format d'hôte spécifié dans le déclencheur LinkPreviewTriggers.

URL du lien qui génère un aperçu dans Google Docs. Pour utiliser ce champ, vous devez configurer LinkPreviewTriggers dans le fichier manifeste de votre module complémentaire. Pour en savoir plus, consultez Prévisualiser les liens avec les 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"
  }
}

ChatEventObject

Charge utile d'un objet d'événement d'application Google Chat envoyée du serveur Google aux modules complémentaires. Les charges utiles peuvent être utilisées pour identifier le type d'événement.

Représentation JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Champs
type

enum (EventType)

Type de l'événement, renseigné uniquement pour les événements de la page d'accueil de l'application dans les applications Chat qui ne sont pas des modules complémentaires.

user

object (User)

L'utilisateur qui interagit avec l'application Chat.

space

object (Space)

Espace dans lequel l'événement s'est produit, renseigné uniquement pour les événements de la page d'accueil de l'application dans les applications Chat qui ne sont pas des modules complémentaires.

eventTime

string (Timestamp format)

Code temporel indiquant quand l'objet d'événement se produit.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Charge utile de l'objet d'événement. Les charges utiles dépendent du type d'objet d'événement. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
messagePayload

object (MessagePayload)

Un utilisateur envoie un message à l'application Chat ou la mentionne avec @dans un espace. Les appels de commandes d'application (comme les commandes à barre oblique et les commandes rapides) sont envoyés dans appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Un utilisateur ajoute l'application Chat à un espace Chat, ou un administrateur Google Workspace installe l'application Chat dans les espaces de messages privés pour les utilisateurs de son organisation.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Un utilisateur supprime l'application Chat d'un espace.

buttonClickedPayload

object (ButtonClickedPayload)

Représente les données de charge utile lorsqu'un utilisateur interagit avec un élément interactif d'une fiche ou d'une boîte de dialogue qui déclenche un rappel Action. Malgré son nom, cette charge utile est renseignée pour tous les rappels Action de fiches et de boîtes de dialogue, pas seulement pour les clics sur les boutons, mais aussi pour les déclencheurs onChangeAction, les actions onClick, les clics CardAction, et l'envoi ou l'annulation de boîtes de dialogue (SUBMIT_DIALOG et CANCEL_DIALOG).

Si un utilisateur interagit avec une boîte de dialogue, le champ isDialogEvent de ButtonClickedPayload est défini sur true et inclut un DialogEventType.

La charge utile complète inclut également commonEventObject.formInputs et commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Un utilisateur met à jour un widget dans une fiche intégrée ou une boîte de dialogue.

La charge utile complète inclut également CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Un utilisateur appelle une commande d'application.

systemCommandPayload

object (SystemCommandPayload)

Un utilisateur appelle une commande système.

Fin des champs mutuellement exclusifs.

EventType

Type de l'événement, renseigné uniquement pour les événements de la page d'accueil de l'application dans les applications Chat qui ne sont pas des modules complémentaires.

Enums
EVENT_TYPE_UNSPECIFIED Valeur par défaut de l'énumération. N'UTILISEZ PAS CE CHAMP.
APP_HOME Un utilisateur ouvre un message privé à partir d'une application Chat qui utilise l'accueil de l'application. Seuls les champs type, user et space sont inclus pour les événements de ce type. Pour en savoir plus, consultez Créer une page d'accueil pour une application Google Chat.
SUBMIT_FORM Un utilisateur envoie des informations dans une fiche d'accueil de l'application. Seuls les champs type, user et space sont inclus pour les événements de ce type. Pour en savoir plus, consultez [Créer une page d'accueil pour une application Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

Un utilisateur envoie un message à l'application Chat ou la mentionne avec @dans un espace. Les appels de commandes d'application (comme les commandes à barre oblique et les commandes rapides) utilisent plutôt AppCommandPayload.

Représentation JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Champs
space

object (Space)

Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit.

message

object (Message)

Message qui déclenche l'objet d'événement.

configCompleteRedirectUri

string

Facultatif. URL vers laquelle l'application Chat doit rediriger l'utilisateur une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer une application Chat à d'autres services et outils.

AddedToSpacePayload

Un utilisateur ajoute l'application Chat à un espace, ou un MP est créé entre l'application et un utilisateur.

Représentation JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Champs
space

object (Space)

Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit.

interactionAdd

boolean

Indique si l'application a été ajoutée à l'espace via une interaction utilisateur (par exemple, en @ mentionnant l'application Chat ou en l'appelant avec une commande à barre oblique). Si cette option est définie sur "true", un objet d'événement distinct associé à l'interaction elle-même sera envoyé à l'application Chat.

configCompleteRedirectUri

string

Facultatif. URL vers laquelle l'application Chat doit rediriger l'utilisateur une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer une application Chat à d'autres services et outils.

RemovedFromSpacePayload

Un utilisateur supprime l'application Chat d'un espace.

Représentation JSON
{
  "space": {
    object (Space)
  }
}
Champs
space

object (Space)

Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit.

ButtonClickedPayload

Un utilisateur interagit avec un élément interactif d'une fiche ou d'une boîte de dialogue d'un module complémentaire Chat qui déclenche un rappel Action. Malgré son nom, cette charge utile est renseignée pour tous les rappels Action de cartes et de boîtes de dialogue, y compris les clics sur les boutons, les déclencheurs onChangeAction, les actions onClick, les clics CardAction, ainsi que l'envoi ou l'annulation de boîtes de dialogue (SUBMIT_DIALOG et CANCEL_DIALOG).

Si un utilisateur interagit avec une boîte de dialogue, le champ isDialogEvent de ButtonClickedPayload est défini sur true et inclut un DialogEventType. Cette charge utile correspond aux types d'événements SUBMIT_FORM et CARD_CLICKED pour les applications Chat qui ne sont pas des modules complémentaires.

La charge utile complète inclut également CommonEventObject.form_inputs et CommonEventObject.parameters.

Représentation JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Champs
space

object (Space)

Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit.

message

object (Message)

Message qui déclenche l'objet d'événement.

isDialogEvent

boolean

Pour les objets d'événement ButtonClicked et Message, indique si l'utilisateur interagit ou est sur le point d'interagir avec une boîte de dialogue.

dialogEventType

enum (DialogEventType)

Type d'objet d'événement dialog reçu.

DialogEventType

Pour les objets d'événement contenant des charges utiles d'événement ButtonClicked ou AppCommand, types d'interactions avec les boîtes de dialogue.

Pour en savoir plus sur les objets d'événement des applications Google Chat, consultez Recevoir des interactions avec votre application Google Chat et y répondre.

Enums
DIALOG_EVENT_TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
REQUEST_DIALOG Un utilisateur ouvre une boîte de dialogue.
SUBMIT_DIALOG Un utilisateur clique sur un élément interactif d'une boîte de dialogue. Par exemple, un utilisateur saisit des informations dans une boîte de dialogue et clique sur un bouton pour les envoyer.
CANCEL_DIALOG Un utilisateur ferme une boîte de dialogue sans envoyer d'informations, ou la boîte de dialogue est annulée.

WidgetUpdatedPayload

Un utilisateur met à jour un widget dans une fiche ou une boîte de dialogue intégrée.

La charge utile complète inclut également CommonEventObject.parameters['autocomplete_widget_query'].

Représentation JSON
{
  "space": {
    object (Space)
  }
}
Champs
space

object (Space)

Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit.

AppCommandPayload

Un utilisateur appelle une commande d'application.

Représentation JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Champs
appCommandMetadata

object (AppCommandMetadata)

Renseigné pour les commandes d'application, y compris les commandes à barre oblique et les commandes rapides.

space

object (Space)

Facultatif. L'espace Chat dans lequel l'objet d'événement se produit.

thread

object (Thread)

Facultatif. Le fil de discussion dans lequel l'objet d'événement se produit, le cas échéant. Ce champ est renseigné si l'objet d'événement est associé à un message ou à un fil de discussion spécifique.

message

object (Message)

Facultatif. Message qui déclenche l'objet d'événement, le cas échéant. Ce champ n'est renseigné que pour les commandes à barre oblique.

configCompleteRedirectUri

string

Facultatif. URL vers laquelle l'utilisateur doit être redirigé une fois qu'il a terminé un flux d'autorisation ou de configuration en dehors de Google Chat. Pour en savoir plus, consultez Associer une application Chat à d'autres services et outils.

isDialogEvent

boolean

Facultatif. Indique si l'utilisateur interagit ou est sur le point d'interagir avec une boîte de dialogue.

dialogEventType

enum (DialogEventType)

Facultatif. Type d'objet d'événement dialog reçu. Ce champ ne s'applique que si isDialogEvent est défini sur true.

AppCommandMetadata

Métadonnées d'une commande d'application Chat.

Représentation JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Champs
appCommandId

integer

ID de la commande spécifiée dans la configuration de l'API Chat.

appCommandType

enum (AppCommandType)

Type de commande de l'application Chat.

AppCommandType

Type de commande de l'application Chat. Pour en savoir plus, consultez Types de commandes d'application Chat.

Enums
APP_COMMAND_TYPE_UNSPECIFIED Valeur par défaut. Non spécifié.
SLASH_COMMAND Une commande à barre oblique. L'utilisateur envoie la commande dans un message de chat.
QUICK_COMMAND Une commande rapide. L'utilisateur sélectionne la commande dans le menu Chat de la zone de réponse au message.
MESSAGE_ACTION Action liée au message. L'utilisateur sélectionne la commande dans le menu contextuel du message dans Chat.

SystemCommandPayload

Un utilisateur appelle une commande système.

Représentation JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Champs
systemCommandMetadata

object (SystemCommandMetadata)

Métadonnées sur la commande système qui a été appelée.

space

string

Facultatif. L'espace Chat dans lequel l'objet d'événement se produit.

thread

object (Thread)

Facultatif. Le fil de discussion dans lequel l'objet d'événement se produit, le cas échéant. Ce champ est renseigné si l'objet d'événement est associé à un message ou à un fil de discussion spécifique.

SystemCommandMetadata

Métadonnées d'une commande système déclenchée par l'utilisateur.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Champs
La commande système a été appelée. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
cancelStream

object (CancelStream)

Commande permettant d'annuler un message de flux actif.

Fin des champs mutuellement exclusifs.

CancelStream

Commande permettant d'annuler un message de flux actif.

Représentation JSON
{
  "streamMessage": string
}
Champs
streamMessage

string

Obligatoire. Nom de ressource du message de flux sur lequel la commande d'annulation a été exécutée.

Format : spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Objet d'événement transmis aux modules complémentaires Workflows.

Représentation JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Champs
executionMetadata

object (ExecutionMetadata)

Métadonnées sur l'exécution du workflow.

triggerEventSource

enum (TriggerEventSource)

Source des événements déclencheurs.

Type de charge utile de l'événement de workflow. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
actionInvocation

object (ActionInvocation)

Appel d'une action de workflow.

triggerCreation

object (TriggerCreation)

Création d'un déclencheur de workflow.

triggerDeletion

object (TriggerDeletion)

Suppression d'un déclencheur de workflow.

resourceRetrieval

object (ResourceRetrieval)

Récupération d'une ressource (utilisée pour l'inflation des variables).

elementConfiguration

object (ElementConfiguration)

Configuration d'un élément de workflow.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Récupération des définitions de champs compatibles avec une ressource.

elementUiAutocomplete

object (ElementUiAutocomplete)

Suggestions de saisie semi-automatique pour la fiche actuellement affichée.

Fin des champs mutuellement exclusifs.

ActionInvocation

Appel d'une action de workflow.

Représentation JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Champs
inputs

map (key: string, value: object (VariableData))

Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

ID du déclencheur à utiliser pour les réponses aux actions asynchrones.

flowLevelContext

object (FlowLevelContext)

Facultatif. Contexte au niveau du flux issu des étapes précédentes.

VariableData

Représente des données variables, qui peuvent contenir plusieurs valeurs de différents types.

Représentation JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Champs
booleanValues[]

boolean

Valeurs booléennes.

integerValues[]

string (int64 format)

Valeurs entières.

floatValues[]

number

Valeurs flottantes.

stringValues[]

string

Valeurs de chaîne.

timestampValues[]

string (Timestamp format)

Valeurs de code temporel.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Références de ressources (ID).

emailAddressValues[]

string

Valeurs d'adresse e-mail.

googleUserValues[]

string

Valeurs utilisateur Google au format users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Valeurs de format de texte de workflow.

ResourceReference

Valeur d'ID de la ressource spécifique à l'application.

Représentation JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Champs
resourceType

object (ResourceType)

Type de la ressource vers laquelle pointe cet ID.

resourceId

string

ID de la ressource.

ResourceType

Nom du type de ressource personnalisée.

Représentation JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Champs
workflowBundleId

string

ID du bundle de workflow auquel appartient ce type de ressource. Ce champ est facultatif. S'il est vide, il est considéré comme le même bundle que celui où il est utilisé.

workflowResourceDefinitionId

string

Identifiant unique de la ressource. Il doit être unique uniquement au sein d'un même bundle.

WorkflowTextFormat

Bloc de texte avec des options de mise en forme enrichie, y compris des styles, des liens hypertextes et des éléments interactifs.

Représentation JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Champs
textFormatElements[]

object (TextFormatElement)

Collection d'éléments de format de texte.

TextFormatElement

Élément unique d'un message WorkflowTextFormat, qui peut être un chip, du texte stylisé, un lien hypertexte ou un conteneur de liste.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Champs
Élément représentant l'un des différents éléments de format de texte possibles. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
text

string

Texte au format texte.

chip

object (Chip)

Chip cliquable au format texte.

styledText

object (StyledText)

Texte stylisé au format texte.

listContainer

object (ListContainer)

Conteneur de liste au format texte.

Fin des champs mutuellement exclusifs.

Chip

Un chip cliquable au format texte.

Représentation JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Champs
icon

object (Icon)

Icône affichée dans le chip.

label

string

Texte affiché dans le chip.

url

string

URL vers laquelle l'utilisateur est redirigé lorsqu'il clique sur le chip.

Icône

Icône dans le chip.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Champs
Icône affichée dans le chip. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
iconUrl

string

Affichez une icône personnalisée hébergée sur une URL HTTPS.

Exemple :

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Les types de fichiers acceptés sont .png et .jpg.

materialIconName

string

Nom de l'icône défini dans l'icône Google Material, par exemple check_box. Les noms non valides sont abandonnés et remplacés par une chaîne vide, ce qui empêche l'icône de s'afficher.

Fin des champs mutuellement exclusifs.

StyledText

Élément de texte avec des styles tels que le gras, l'italique et la couleur.

Représentation JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Champs
text

string

Contenu principal du texte.

styles[]

enum (Style)

Ensemble de styles appliqués au texte.

fontWeight

enum (FontWeight)

L'épaisseur de police du texte.

color

object (Color)

Couleur du texte.

wrapStyle

enum (WrapStyle)

Style de retour à la ligne du texte.

Style

Énumération pour différents styles de texte, tels que l'italique, le soulignement, etc.

Enums
STYLE_UNSPECIFIED Aucun style appliqué. N'UTILISEZ PAS CE CHAMP.
ITALIC Style italique.
UNDERLINE Style Souligné.
STRIKETHROUGH Style barré.
LINE_BREAK Saut de ligne.
UPPERCASE Style en majuscules.
CODE Codez.
CODE_BLOCK Bloc de code.

FontWeight

Énumération pour différentes épaisseurs de police.

Enums
FONT_WEIGHT_UNSPECIFIED Poids standard avec une épaisseur normale. N'UTILISEZ PAS CE CHAMP.
LIGHT Plus léger et plus fin.
MEDIUM Graisse intermédiaire entre léger et gras.
BOLD Poids plus lourd avec une épaisseur accrue.

WrapStyle

Énumération pour différents styles d'habillage.

Enums
WRAP_STYLE_UNSPECIFIED Aucun style de retour à la ligne spécifié.
NO_WRAP Aucun style de retour à la ligne.

ListContainer

Conteneur pour les éléments de liste, où chaque élément de liste peut contenir plusieurs TextFormatElement.

Représentation JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Champs
listNestLevel

string (int64 format)

Niveau d'imbrication de la liste. Commence à 0 pour le niveau supérieur et augmente de 1 pour chaque liste imbriquée.

listType

enum (ListType)

Type de la liste.

listItems[]

object (ListItem)

Collection d'éléments de liste.

ListType

Énumération pour différents types de listes.

Enums
LIST_TYPE_UNSPECIFIED Aucun type de liste spécifié. N'UTILISEZ PAS CE CHAMP.
ORDERED Liste numérotée.
UNORDERED Liste non triée.
BLOCKQUOTE Représente une liste de citations.

ListItem

Élément de liste.

Représentation JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Champs
textFormatElements[]

object (TextFormatElement)

Collection d'éléments de format de texte.

FlowLevelContext

Contexte au niveau du flux contenant les résultats des étapes précédentes.

Représentation JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Champs
stepContexts[]

object (StepContext)

Facultatif. Liste des étapes précédentes. L'ordre est important. Veillez donc à ce que l'ordre d'exécution soit respecté dans cette liste.

StepContext

Métadonnées de contexte d'étape et sorties pour le contexte au niveau du flux.

Représentation JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Champs
stepId

string

Facultatif. Identifiant unique de l'étape dans le graphique du workflow.

outputs

map (key: string, value: object (VariableData))

Facultatif. Mappage des variables de sortie produites par cette étape, indexées par nom de variable.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Création d'un déclencheur de workflow.

Représentation JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Champs
triggerId

string

Identifiant unique du déclencheur fourni lors de la création.

triggerType

enum (TriggerType)

Type de déclencheur.

inputs

map (key: string, value: object (VariableData))

Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

Point de terminaison qui sera appelé lorsque le déclencheur se déclenchera.

TriggerType

Type de déclencheur.

Enums
TRIGGER_TYPE_UNDEFINED Valeur par défaut. N'UTILISEZ PAS CE CHAMP.
REPEATING Le déclencheur se déclenchera chaque fois que les conditions d'entrée seront remplies.

TriggerDeletion

Suppression d'un déclencheur de workflow.

Représentation JSON
{
  "triggerId": string
}
Champs
triggerId

string

Identifiant unique du déclencheur fourni lors de la création.

ResourceRetrieval

Récupération d'une ressource.

Représentation JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Champs
resourceReference

object (ResourceReference)

Type et ID de la ressource à récupérer.

ElementConfiguration

Appel lors de la configuration d'un élément de workflow.

Représentation JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Champs
inputs

map (key: string, value: object (VariableData))

Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé. Cette carte peut être vide. Utilisé lors de la configuration d'un seul élément de workflow (déclencheur ou action) sur la page d'accueil du workflow.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

Destination de la fiche de configuration de l'élément. Les éléments peuvent utiliser ce champ pour renvoyer différentes mises en page de fiches de configuration en fonction de la destination.

nodeId

string

ID du nœud de la configuration primitive en cours d'affichage.

workflowId

string

ID de workflow de la configuration primitive en cours d'affichage.

availableVariables[]

object (VariableReference)

Variables disponibles classées par position de nœud.

DisplayDestination

Indique où la fiche de configuration de l'élément de retour sera affichée.

Enums
DISPLAY_DESTINATION_UNSPECIFIED Valeur par défaut. N'UTILISEZ PAS CE CHAMP.
DISPLAY_DESTINATION_SIDE_PANEL La fiche de configuration doit s'afficher dans le panneau latéral.
DISPLAY_DESTINATION_FULL_SCREEN La fiche de configuration doit s'afficher dans l'application plein écran.

VariableReference

Référence à une variable du workflow.

Représentation JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Champs
parentElementId

string

ID primitif de l'élément qui produit la variable. Nous pouvons l'étendre à WorkflowElement ou à un proto de métadonnées plus détaillé si nécessaire.

nodeId

string

ID de référence du nœud

path

string

Signature du chemin d'accès du sélecteur de variable

dataType

object (DataType)

Le type de données de la variable

iconUrl

string

URL de l'icône de la primitive qui produit cette variable.

stepNumber

integer

Numéro d'étape de la primitive qui produit cette variable.

descriptionText

string

Description de la variable.

displayText

string

Texte à afficher du chip de variable.

DataType

Type de la variable.

Représentation JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Champs
valueMetadata

object (ValueMetadata)

Métadonnées sur les valeurs potentielles d'une variable.

Type de données. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
basicType

enum (BasicType)

Type de données de base.

resourceType

object (ResourceType)

Type d'ID de ressource d'application.

Fin des champs mutuellement exclusifs.

BasicType

Types de données génériques de base.

Enums
BASIC_TYPE_UNSPECIFIED Valeur par défaut. N'UTILISEZ PAS CE CHAMP.
STRING Chaîne de caractères.
INTEGER Nombre entier.
FLOAT Nombre à virgule flottante.
TIMESTAMP Code temporel au format ISO 8601.
BOOLEAN Valeur qui peut être vraie ou fausse.
EMAIL_ADDRESS Une adresse e-mail, qui est une chaîne au format d'une adresse e-mail.
GOOGLE_USER Utilisateur des services Google, au format users/{user}.
FILE Référence du fichier.
FORMATTED_TEXT Texte avec mise en forme enrichie.

ValueMetadata

Informations sur les valeurs potentielles d'une variable.

Représentation JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Champs
enumValues[]

string

Facultatif. Spécifie les valeurs autorisées pour une chaîne. Ne peut être défini que si DataType est défini sur STRING.

dynamicTypes[]

enum (BasicType)

Facultatif. Spécifie les types autorisés qui peuvent être castés de manière dynamique pour une variable. Cette option ne peut être définie que si le DataType est une chaîne et que la variable est une sortie.

semanticDescriptors[]

object (SemanticDescriptor)

Facultatif. Aide à décrire la signification sémantique d'une variable.

dynamicSchema

object (DynamicSchema)

Facultatif. Configuration pour résoudre dynamiquement le schéma de cette variable.

defaultValue

string

Facultatif. Chaîne spécifiant la valeur par défaut de cette variable. Par exemple, pour les booléens, defaultValue peut être défini sur true ou false.

SemanticDescriptor

Métadonnées sur la signification sémantique d'une variable.

Représentation JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Champs
resourceAttribute

string

Indique que la variable correspond à un attribut spécifique d'une ressource. Cela est particulièrement utile pour les variables qui représentent l'identifiant d'une ressource (ID, URL, clé, etc.).

Le format recommandé est le suivant : - "{brand}/{appName}/{resource}:{attribute}" {brand} est facultatif et doit être omis s'il est identique à {appName}.

Exemples : - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id", etc.

Le client utilisera ces informations pour indiquer à l'utilisateur quelles variables de sortie sont compatibles avec une certaine entrée.

disallowedResourceAttributes[]

string

Facultatif. S'applique uniquement aux entrées et est ignoré pour les sorties. Attributs non autorisés qui correspondent à ce descripteur sémantique. Le client empêchera explicitement la sélection de variables pour les sorties correspondant à l'un de ces attributs de ressource non autorisés.

DynamicSchema

Configuration permettant de résoudre dynamiquement le schéma de cette variable au moment de l'exécution.

Représentation JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Champs
requiredInputIds[]

string

ID des variables d'entrée sœurs qui doivent être fournies avant que le schéma de cette variable puisse être résolu de manière dynamique.

strictEnum

boolean

Si la valeur est "true", la valeur de la variable doit correspondre à l'une des valeurs d'énumération résolues de manière dynamique. Lorsque cette option est définie sur "false", les valeurs résolues dynamiquement sont traitées comme des suggestions non strictes.

ResourceFieldsDefinitionRetrieval

Récupère la définition des champs compatibles avec une ressource.

Représentation JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Champs
elementId

string

Spécifie l'ID de l'élément dont le schéma de ressource dynamique doit être récupéré.

inputs

map (key: string, value: object (VariableData))

Il s'agit des entrées de champ du nœud qui fournit la variable. Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Suggestions de saisie semi-automatique pour la fiche actuellement affichée.

Représentation JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Champs
query

string

Requête à compléter automatiquement.

inputs

map (key: string, value: object (VariableData))

Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Fonction appelée associée au widget.

resourceId

string

ID de ressource pour lequel la saisie semi-automatique doit être effectuée. Ce champ est facultatif et peut ne pas être défini.

operationId

string

ID de l'opération qui a fourni la ressource à compléter automatiquement. Ce champ est facultatif et peut ne pas être défini.

ExecutionMetadata

Métadonnées sur l'exécution du workflow.

Représentation JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Champs
versionId

integer

Version de l'élément de workflow appelé.

timeZone

string

Fuseau horaire du workflow en cours d'enregistrement (par exemple, "America/Los_Angeles").

stepNumber

integer

Représente le numéro d'étape de la primitive appelée.

TriggerEventSource

Source de l'événement déclencheur qui a déclenché cette exécution.

Enums
TRIGGER_EVENT_SOURCE_UNSPECIFIED Valeur par défaut. N'UTILISEZ PAS CE CHAMP.
TRIGGER_EVENT_SOURCE_AUTOMATED L'exécution est déclenchée automatiquement par des événements.
TRIGGER_EVENT_SOURCE_TEST_RUN L'exécution est déclenchée par une exécution de test.