- EventObject
- CommonEventObject
- HostApp
- Plate-forme
- TimeZone
- Entrées
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organisateur
- Participant
- ConferenceData
- ConferenceSolution
- Clé
- EntryPoint
- Paramètres
- AddOnParameters
- Fonctionnalités
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Puce
- Icône
- StyledText
- Style
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
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 ( |
| Champs | |
|---|---|
commonEventObject |
Objet contenant des informations communes à tous les objets d'événement, quelle que soit l'application hôte. |
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 |
Présent uniquement si l'hôte appelant est Google Agenda. Objet contenant des informations sur l'agenda et les événements. |
drive |
Présent uniquement si l'hôte appelant est Google Drive. Objet contenant des informations sur Drive. |
gmail |
Présent uniquement si l'hôte appelant est Gmail. Objet contenant des informations Gmail. |
sheets |
Présent uniquement si l'hôte appelant est Google Sheets. Objet contenant des informations sur Sheets. |
slides |
Uniquement présent si l'hôte appelant est Google Slides. Objet contenant des informations sur Slides. |
docs |
Présent uniquement si l'hôte appelant est Google Docs. Objet contenant des informations sur Docs. |
chat |
Présent uniquement si l'hôte appelant est Google Chat. Objet contenant des informations sur Chat. |
workflow |
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 ( |
| Champs | |
|---|---|
userLocale |
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, Pour activer ce champ, vous devez définir |
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 :
|
platform |
Énumération de la plate-forme qui indique la plate-forme d'origine de l'événement ( |
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 Uniquement compatible avec les types d'événements |
formInputs |
Mappage contenant les valeurs actuelles des widgets de la fiche affichée. Les clés de mappage sont les valeurs de chaîne 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
Exemple : pour un widget de saisie de texte dont le
Exemple : pour un widget à valeurs multiples dont l'
Exemple : Pour un sélecteur dont l'ID (
Exemple : Pour un sélecteur dont l'ID (
Exemple : Pour un sélecteur avec un Objet contenant une liste de paires |
parameters |
Tous les paramètres supplémentaires que vous fournissez à une action à l'aide de 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é Objet contenant une liste de paires |
invokedFunction |
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 |
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 |
Code de la base de données de fuseaux horaires IANA TZ, par exemple "America/Toronto". |
offset |
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 ( |
| Champs | |
|---|---|
| Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse : | |
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 |
dateTimeInput |
Valeurs d'entrée de date et d'heure d'un widget |
dateInput |
Valeurs d'entrée de date d'un widget |
timeInput |
Valeurs d'entrée d'heure d'un widget |
| 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[] |
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 |
Temps écoulé depuis l'epoch, en millisecondes. |
hasDate |
Indique si l'entrée |
hasTime |
Indique si l'entrée |
DateInput
Valeurs d'entrée de date.
| Représentation JSON |
|---|
{ "msSinceEpoch": string } |
| Champs | |
|---|---|
msSinceEpoch |
Temps écoulé depuis l'epoch, en millisecondes. |
TimeInput
Valeurs d'entrée de l'heure.
| Représentation JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Champs | |
|---|---|
hours |
Heure selon le format "24 heures". |
minutes |
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 |
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 |
Un jeton d'ID d'utilisateur final, si les champs d'application d'ID appropriés sont demandés |
systemIdToken |
Un jeton d'ID pour le compte de service des modules complémentaires G Suite pour ce déploiement |
authorizedScopes[] |
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 ( |
| Champs | |
|---|---|
id |
ID de l'événement. |
recurringEventId |
ID d'un événement périodique. |
calendarId |
ID de l'agenda. |
organizer |
Objet représentant l'organisateur de l'événement. |
attendees[] |
Données générées par l'utilisateur Liste des participants à l'événement d'agenda. |
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 |
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 |
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 |
Adresse e-mail du participant. |
displayName |
Nom à afficher du participant. |
organizer |
true si le participant est un organisateur de cet événement. |
self |
true si ce participant représente l'agenda dans lequel cet événement apparaît ; false sinon. |
resource |
true si le participant représente une ressource, telle qu'une salle ou un équipement ; false sinon. |
optional |
true si la présence de ce participant est marquée comme facultative ; false sinon. |
responseStatus |
État de la réponse du participant. Les valeurs possibles sont les suivantes :
|
comment |
Commentaire de réponse du participant, le cas échéant. |
additionalGuests |
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 ( |
| Champs | |
|---|---|
conferenceId |
ID de la conférence. Cet ID permet aux applications de suivre les conférences. Vous ne devez pas l'afficher aux utilisateurs. |
conferenceSolution |
Objet représentant la solution de conférence, telle que Hangouts ou Google Meet. |
entryPoints[] |
Liste des points d'entrée de la conférence, tels que des URL ou des numéros de téléphone. |
notes |
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 |
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 ( |
| Champs | |
|---|---|
iconUri |
URI de l'icône visible par l'utilisateur représentant cette solution de conférence. |
key |
Clé qui identifie de manière unique la solution de conférence pour cet événement. |
name |
Nom de cette solution de conférence visible par l'utilisateur (non localisé). |
Clé
| Représentation JSON |
|---|
{ "type": string } |
| Champs | |
|---|---|
type |
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 |
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 |
Type de point d'entrée. Les valeurs possibles sont les suivantes :
|
label |
Libellé visible par l'utilisateur pour l'URI du point d'entrée (non localisé). |
meetingCode |
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 |
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 |
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 |
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 |
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 :
|
regionCode |
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[] |
Fonctionnalités du point d'entrée. Actuellement, ces fonctionnalités ne s'appliquent qu'aux points d'entrée téléphoniques :
|
Paramètres
| Représentation JSON |
|---|
{
"addOnParameters": {
object ( |
| Champs | |
|---|---|
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 |
Objet contenant une liste de paires |
Capacités
| Représentation JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Champs | |
|---|---|
canSeeAttendees |
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 |
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 |
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 |
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 |
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 ( |
| Champs | |
|---|---|
selectedItems[] |
Liste des éléments (fichiers ou dossiers) sélectionnés dans Drive. |
activeCursorItem |
É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 |
ID de l'élément sélectionné. |
iconUrl |
URL de l'icône représentant l'élément sélectionné. |
mimeType |
Type MIME de l'élément sélectionné. |
title |
Titre de l'élément sélectionné. |
addonHasFileScopePermission |
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 |
ID du message Gmail actuellement ouvert. |
threadId |
ID du fil de discussion Gmail actuellement ouvert. |
accessToken |
Jeton d'accès spécifique à Gmail. Vous pouvez utiliser ce jeton avec la méthode |
toRecipients[] |
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 |
ccRecipients[] |
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 |
bccRecipients[] |
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 |
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 ( |
| Champs | |
|---|---|
id |
Présent uniquement si le champ d'application |
title |
Présent uniquement si le champ d'application |
addonHasFileScopePermission |
Si la valeur est |
matchedUrl |
Présent uniquement si les conditions suivantes sont remplies :
URL du lien qui génère un aperçu dans Google Sheets. Pour utiliser ce champ, vous devez configurer Exemple de charge utile lorsqu'un utilisateur prévisualise le lien |
MatchedUrl
Objet d'événement renvoyé avec les requêtes d'aperçu de lien.
| Représentation JSON |
|---|
{ "url": string } |
| Champs | |
|---|---|
url |
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 ( |
| Champs | |
|---|---|
id |
Présent uniquement si le champ d'application |
title |
Présent uniquement si le champ d'application |
addonHasFileScopePermission |
Si la valeur est |
matchedUrl |
Présent uniquement si les conditions suivantes sont remplies :
URL du lien qui génère un aperçu dans Google Slides. Pour utiliser ce champ, vous devez configurer Exemple de charge utile lorsqu'un utilisateur prévisualise le lien |
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 ( |
| Champs | |
|---|---|
id |
Présent uniquement si le champ d'application |
title |
Présent uniquement si le champ d'application |
addonHasFileScopePermission |
Si la valeur est |
matchedUrl |
Présent uniquement si les conditions suivantes sont remplies :
URL du lien qui génère un aperçu dans Google Docs. Pour utiliser ce champ, vous devez configurer Exemple de charge utile lorsqu'un utilisateur prévisualise le lien |
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 ( |
| Champs | |
|---|---|
type |
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 |
L'utilisateur qui interagit avec l'application Chat. |
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 |
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 : |
| 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 |
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 |
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 |
Un utilisateur supprime l'application Chat d'un espace. |
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 Si un utilisateur interagit avec une boîte de dialogue, le champ La charge utile complète inclut également |
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 |
appCommandPayload |
Un utilisateur appelle une commande d'application. |
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 ( |
| Champs | |
|---|---|
space |
Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit. |
message |
Message qui déclenche l'objet d'événement. |
configCompleteRedirectUri |
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 ( |
| Champs | |
|---|---|
space |
Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit. |
interactionAdd |
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 |
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 ( |
| Champs | |
|---|---|
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 ( |
| Champs | |
|---|---|
space |
Obligatoire. L'espace Chat dans lequel l'objet d'événement se produit. |
message |
Message qui déclenche l'objet d'événement. |
isDialogEvent |
Pour les objets d'événement |
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 ( |
| Champs | |
|---|---|
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 ( |
| Champs | |
|---|---|
appCommandMetadata |
Renseigné pour les commandes d'application, y compris les commandes à barre oblique et les commandes rapides. |
space |
Facultatif. L'espace Chat dans lequel l'objet d'événement se produit. |
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 |
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 |
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 |
Facultatif. Indique si l'utilisateur interagit ou est sur le point d'interagir avec une boîte de dialogue. |
dialogEventType |
Facultatif. Type d'objet d'événement dialog reçu. Ce champ ne s'applique que si |
AppCommandMetadata
Métadonnées d'une commande d'application Chat.
| Représentation JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Champs | |
|---|---|
appCommandId |
ID de la commande spécifiée dans la configuration de l'API Chat. |
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 ( |
| Champs | |
|---|---|
systemCommandMetadata |
Métadonnées sur la commande système qui a été appelée. |
space |
Facultatif. L'espace Chat dans lequel l'objet d'événement se produit. |
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 ( |
| 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 |
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 |
Obligatoire. Nom de ressource du message de flux sur lequel la commande d'annulation a été exécutée. Format : |
WorkflowEventObject
LINT.IfChange Objet d'événement transmis aux modules complémentaires Workflows.
| Représentation JSON |
|---|
{ "executionMetadata": { object ( |
| Champs | |
|---|---|
executionMetadata |
Métadonnées sur l'exécution du workflow. |
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 |
Appel d'une action de workflow. |
triggerCreation |
Création d'un déclencheur de workflow. |
triggerDeletion |
Suppression d'un déclencheur de workflow. |
resourceRetrieval |
Récupération d'une ressource (utilisée pour l'inflation des variables). |
elementConfiguration |
Configuration d'un élément de workflow. |
resourceFieldsDefinitionRetrieval |
Récupération des définitions de champs compatibles avec une ressource. |
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 ( |
| Champs | |
|---|---|
inputs |
Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé. Objet contenant une liste de paires |
triggerId |
ID du déclencheur à utiliser pour les réponses aux actions asynchrones. |
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 ( |
| Champs | |
|---|---|
booleanValues[] |
Valeurs booléennes. |
integerValues[] |
Valeurs entières. |
floatValues[] |
Valeurs flottantes. |
stringValues[] |
Valeurs de chaîne. |
timestampValues[] |
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 : |
resourceReferences[] |
Références de ressources (ID). |
emailAddressValues[] |
Valeurs d'adresse e-mail. |
googleUserValues[] |
Valeurs utilisateur Google au format |
textFormatValues[] |
Valeurs de format de texte de workflow. |
ResourceReference
Valeur d'ID de la ressource spécifique à l'application.
| Représentation JSON |
|---|
{
"resourceType": {
object ( |
| Champs | |
|---|---|
resourceType |
Type de la ressource vers laquelle pointe cet ID. |
resourceId |
ID de la ressource. |
ResourceType
Nom du type de ressource personnalisée.
| Représentation JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Champs | |
|---|---|
workflowBundleId |
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 |
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 ( |
| Champs | |
|---|---|
textFormatElements[] |
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 ( |
| 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 |
Texte au format texte. |
chip |
Chip cliquable au format texte. |
styledText |
Texte stylisé au format texte. |
hyperlink |
Lien hypertexte au format texte. |
listContainer |
Conteneur de liste au format texte. |
| Fin des champs mutuellement exclusifs. | |
Chip
Un chip cliquable au format texte.
| Représentation JSON |
|---|
{
"icon": {
object ( |
| Champs | |
|---|---|
icon |
Icône affichée dans le chip. |
label |
Texte affiché dans le chip. |
url |
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 |
Affichez une icône personnalisée hébergée sur une URL HTTPS. Exemple : Les types de fichiers acceptés sont |
materialIconName |
Nom de l'icône défini dans l'icône Google Material, par exemple |
| 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 ( |
| Champs | |
|---|---|
text |
Contenu principal du texte. |
styles[] |
Ensemble de styles appliqués au texte. |
fontWeight |
L'épaisseur de police du texte. |
color |
Couleur du texte. |
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. |
Lien hypertexte
Élément de lien hypertexte avec texte et lien.
| Représentation JSON |
|---|
{ "link": string, "text": string } |
| Champs | |
|---|---|
link |
URL de destination du lien hypertexte. |
text |
Texte du lien hypertexte. |
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 ( |
| Champs | |
|---|---|
listNestLevel |
Niveau d'imbrication de la liste. Commence à 0 pour le niveau supérieur et augmente de 1 pour chaque liste imbriquée. |
listType |
Type de la liste. |
listItems[] |
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 ( |
| Champs | |
|---|---|
textFormatElements[] |
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 ( |
| Champs | |
|---|---|
stepContexts[] |
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 ( |
| Champs | |
|---|---|
stepId |
Facultatif. Identifiant unique de l'étape dans le graphique du workflow. |
outputs |
Facultatif. Mappage des variables de sortie produites par cette étape, indexées par nom de variable. Objet contenant une liste de paires |
TriggerCreation
Création d'un déclencheur de workflow.
| Représentation JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Champs | |
|---|---|
triggerId |
Identifiant unique du déclencheur fourni lors de la création. |
triggerType |
Type de déclencheur. |
inputs |
Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé. Objet contenant une liste de paires |
notifyUri |
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 |
Identifiant unique du déclencheur fourni lors de la création. |
ResourceRetrieval
Récupération d'une ressource.
| Représentation JSON |
|---|
{
"resourceReference": {
object ( |
| Champs | |
|---|---|
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 ( |
| Champs | |
|---|---|
inputs |
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 |
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 |
ID du nœud de la configuration primitive en cours d'affichage. |
workflowId |
ID de workflow de la configuration primitive en cours d'affichage. |
availableVariables[] |
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 ( |
| Champs | |
|---|---|
parentElementId |
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 |
ID de référence du nœud |
path |
Signature du chemin d'accès du sélecteur de variable |
dataType |
Le type de données de la variable |
iconUrl |
URL de l'icône de la primitive qui produit cette variable. |
stepNumber |
Numéro d'étape de la primitive qui produit cette variable. |
descriptionText |
Description de la variable. |
displayText |
Texte à afficher du chip de variable. |
DataType
Type de la variable.
| Représentation JSON |
|---|
{ "valueMetadata": { object ( |
| Champs | |
|---|---|
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 |
Type de données de base. |
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 ( |
| Champs | |
|---|---|
enumValues[] |
Facultatif. Spécifie les valeurs autorisées pour une chaîne. Ne peut être défini que si |
dynamicTypes[] |
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[] |
Facultatif. Aide à décrire la signification sémantique d'une variable. |
dynamicSchema |
Facultatif. Configuration pour résoudre dynamiquement le schéma de cette variable. |
defaultValue |
Facultatif. Chaîne spécifiant la valeur par défaut de cette variable. Par exemple, pour les booléens, |
SemanticDescriptor
Métadonnées sur la signification sémantique d'une variable.
| Représentation JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Champs | |
|---|---|
resourceAttribute |
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 : - Exemples : - Le client utilisera ces informations pour indiquer à l'utilisateur quelles variables de sortie sont compatibles avec une certaine entrée. |
disallowedResourceAttributes[] |
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[] |
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 |
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 ( |
| Champs | |
|---|---|
elementId |
Spécifie l'ID de l'élément dont le schéma de ressource dynamique doit être récupéré. |
inputs |
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 |
ElementUiAutocomplete
Suggestions de saisie semi-automatique pour la fiche actuellement affichée.
| Représentation JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Champs | |
|---|---|
query |
Requête à compléter automatiquement. |
inputs |
Mappage des variables d'entrée, avec le nom de la variable d'entrée comme clé. Objet contenant une liste de paires |
invokedFunction |
Fonction appelée associée au widget. |
resourceId |
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 |
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 |
Version de l'élément de workflow appelé. |
timeZone |
Fuseau horaire du workflow en cours d'enregistrement (par exemple, "America/Los_Angeles"). |
stepNumber |
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. |