Card

Interface sous forme de fiche affichée dans un message Google Chat ou un module complémentaire Google Workspace.

Les fiches sont compatibles avec une mise en page définie, des éléments d'interface utilisateur interactifs tels que des boutons et des contenus rich media tels que des images. Utilisez des fiches pour présenter des informations détaillées, recueillir des informations auprès des utilisateurs et les guider vers l'étape suivante.

Concevez et prévisualisez des fiches avec le générateur de fiches.

Ouvrir le générateur de fiches

Pour savoir comment créer des fiches, consultez la documentation suivante :

Remarque : Vous pouvez ajouter jusqu'à 100 widgets par fiche. Si les widgets d'une section font dépasser le nombre total de 100, l'intégralité de cette section et toutes les sections suivantes sont ignorées. Cette limite s'applique aux messages de fiches et aux boîtes de dialogue dans les applications Google Chat, ainsi qu'aux fiches dans les modules complémentaires Google Workspace.

Exemple : Message de fiche pour une application Google Chat

Exemple de fiche de contact

Pour créer l'exemple de message de fiche dans Google Chat, utilisez le code JSON suivant :

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Représentation JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  },
  "expressionData": [
    {
      object (ExpressionData)
    }
  ]
}
Champs
header

object (CardHeader)

En-tête de la carte. Un en-tête contient généralement une image principale et un titre. Les en-têtes s'affichent toujours en haut d'une fiche.

sections[]

object (Section)

Contient une collection de widgets. Chaque section possède son propre en-tête facultatif. Les sections sont séparées visuellement par une ligne de séparation. Pour obtenir un exemple dans les applications Google Chat, consultez Définir une section d'une fiche.

sectionDividerStyle

enum (DividerStyle)

Style du séparateur entre l'en-tête, les sections et le pied de page.

cardActions[]

object (CardAction)

Actions de la fiche. Les actions sont ajoutées au menu de la barre d'outils de la fiche. Accepte jusqu'à 10 éléments CardAction.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

Par exemple, le code JSON suivant crée un menu d'actions de fiche avec les options Settings et Send Feedback :

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Nom de la carte. Utilisé comme identifiant de fiche dans la navigation par fiches.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

displayStyle

enum (DisplayStyle)

Dans les modules complémentaires Google Workspace, définit les propriétés d'affichage de peekCardHeader.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

peekCardHeader

object (CardHeader)

Lors de l'affichage de contenu contextuel, l'en-tête de la carte d'aperçu sert d'espace réservé pour que l'utilisateur puisse naviguer entre les cartes de la page d'accueil et les cartes contextuelles.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

expressionData[]

object (ExpressionData)

Données d'expression de la fiche.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

CardHeader

Représente un en-tête de fiche. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un en-tête.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
Champs
title

string

Obligatoire. Titre de l'en-tête de la fiche. L'en-tête a une hauteur fixe : si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.

subtitle

string

Sous-titre de l'en-tête de la fiche. S'il est spécifié, il s'affiche sur sa propre ligne sous le title.

imageType

enum (ImageType)

Forme utilisée pour recadrer l'image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

imageUrl

string

URL HTTPS de l'image dans l'en-tête de la fiche.

imageAltText

string

Texte alternatif de cette image utilisé pour l'accessibilité.

Section

Une section contient un ensemble de widgets affichés verticalement dans l'ordre dans lequel ils sont spécifiés.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "id": string,
  "collapseControl": {
    object (CollapseControl)
  }
}
Champs
header

string

Texte qui s'affiche en haut d'une section. Compatible avec le texte au format HTML simple. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

widgets[]

object (Widget)

Tous les widgets de la section. Doit contenir au moins un widget. Une carte peut contenir jusqu'à 100 widgets, toutes sections confondues.

collapsible

boolean

Indique si cette section peut être réduite.

Les sections réductibles masquent certains widgets ou tous les widgets, mais les utilisateurs peuvent développer la section pour afficher les widgets masqués en cliquant sur Afficher plus. Les utilisateurs peuvent masquer à nouveau les widgets en cliquant sur Afficher moins.

Pour déterminer quels widgets sont masqués, spécifiez uncollapsibleWidgetsCount.

uncollapsibleWidgetsCount

integer

Nombre de widgets non réductibles qui restent visibles même lorsqu'une section est réduite.

Par exemple, lorsqu'une section contient cinq widgets et que uncollapsibleWidgetsCount est défini sur 2, les deux premiers widgets sont toujours affichés et les trois derniers sont réduits par défaut. uncollapsibleWidgetsCount n'est pris en compte que lorsque collapsible est défini sur true.

id

string

Identifiant unique attribué à la section, utilisé pour identifier la section à modifier. L'ID ne doit pas dépasser 64 caractères et doit être au format [a-zA-Z0-9-]+.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

collapseControl

object (CollapseControl)

Facultatif. Définissez le bouton de développement et de réduction de la section. Ce bouton ne s'affiche que si la section est réductible. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

Widget

Chaque fiche est composée de widgets.

Un widget est un objet composite qui peut représenter du texte, des images, des boutons et d'autres types d'objets.

Représentation JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "id": string,
  "visibility": enum (Visibility),
  "eventActions": [
    {
      object (EventAction)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
}
Champs
horizontalAlignment

enum (HorizontalAlignment)

Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.

id

string

Identifiant unique attribué au widget, utilisé pour identifier le widget à modifier. L'ID ne doit pas dépasser 64 caractères et doit être au format [a-zA-Z0-9-]+.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

visibility

enum (Visibility)

Indique si le widget est visible ou masqué. La valeur par défaut est VISIBLE.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

eventActions[]

object (EventAction)

Spécifie les actions d'événement pouvant être effectuées sur le widget.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Un widget ne peut comporter qu'un seul des éléments suivants. Vous pouvez utiliser plusieurs champs de widget pour afficher plus d'éléments. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
textParagraph

object (TextParagraph)

Affiche un paragraphe de texte. Compatible avec le texte au format HTML simple. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

Par exemple, le code JSON suivant crée un texte en gras :

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

object (Image)

Affiche une image.

Par exemple, le code JSON suivant crée une image avec un texte alternatif :

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

object (DecoratedText)

Affiche un élément de texte décoré.

Par exemple, le code JSON suivant crée un widget de texte décoré affichant une adresse e-mail :

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

object (ButtonList)

Liste de boutons.

Par exemple, le code JSON suivant crée deux boutons. Le premier est un bouton de texte bleu et le second est un bouton d'image qui ouvre un lien :

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

object (TextInput)

Affiche une zone de texte dans laquelle les utilisateurs peuvent saisir du texte.

Par exemple, le code JSON suivant crée une saisie de texte pour une adresse e-mail :

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Autre exemple : le code JSON suivant crée une saisie de texte pour un langage de programmation avec des suggestions statiques :

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

object (SelectionInput)

Affiche une commande de sélection qui permet aux utilisateurs de sélectionner des éléments. Les commandes de sélection peuvent être des cases à cocher, des cases d'option, des boutons bascule ou des menus déroulants.

Par exemple, le code JSON suivant crée un menu déroulant qui permet aux utilisateurs de choisir une taille :

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

object (DateTimePicker)

Affiche un widget permettant aux utilisateurs de saisir une date, une heure, ou une date et une heure.

Par exemple, le code JSON suivant crée un sélecteur de date et d'heure pour planifier un rendez-vous :

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}
divider

object (Divider)

Affiche un séparateur horizontal entre les widgets.

Par exemple, le code JSON suivant crée un séparateur :

"divider": {
}
grid

object (Grid)

Affiche une grille avec une collection d'éléments.

Une grille peut contenir un nombre illimité de colonnes et d'éléments. Le nombre de lignes est déterminé par la limite supérieure du nombre d'éléments divisé par le nombre de colonnes. Une grille de 10 éléments et de deux colonnes comporte cinq lignes. Une grille de 11 éléments et de deux colonnes comporte six lignes.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Par exemple, le code JSON suivant crée une grille à deux colonnes avec un seul élément :

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

object (Columns)

Affiche jusqu'à deux colonnes.

Pour inclure plus de deux colonnes ou pour utiliser des lignes, utilisez le widget Grid.

Par exemple, le code JSON suivant crée deux colonnes contenant chacune des paragraphes de texte :

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

object (Carousel)

Contient une collection d'éléments CarouselCard, chacun contenant des widgets imbriqués. Par exemple, voici une représentation JSON d'un carrousel contenant deux fiches, chacune avec un paragraphe de texte :

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in the carousel."
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in the carousel."
          }
        }
      ]
    }
  ]
}
chipList

object (ChipList)

Liste de chips.

Par exemple, le code JSON suivant crée deux chips. Le premier est un chip de texte et le second est un chip d'icône qui ouvre un lien :

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
Fin des champs mutuellement exclusifs.

TextParagraph

Paragraphe de texte compatible avec la mise en forme. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un paragraphe de texte mis en forme. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
Champs
text

string

Texte affiché dans le widget.

maxLines

integer

Nombre maximal de lignes de texte affichées dans le widget. Si le texte dépasse le nombre maximal de lignes spécifié, le contenu excédentaire est masqué derrière un bouton Afficher plus. Si le texte est égal ou inférieur au nombre maximal de lignes spécifié, le bouton Afficher plus ne s'affiche pas.

La valeur par défaut est 0, auquel cas tout le contexte est affiché. Les valeurs négatives sont ignorées.

textSyntax

enum (TextSyntax)

La syntaxe du texte. Si ce paramètre n'est pas défini, le texte est affiché au format HTML.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

TextSyntax

Syntaxe à utiliser pour mettre en forme le texte.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Enums
TEXT_SYNTAX_UNSPECIFIED Le texte est affiché au format HTML s'il n'est pas spécifié.
HTML Le texte est affiché au format HTML. Il s'agit de la valeur par défaut.
MARKDOWN Le texte est affiché au format Markdown.

Image

Image spécifiée par une URL et pouvant comporter une action onClick. Pour obtenir un exemple, consultez Ajouter une image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}
Champs
imageUrl

string

URL HTTPS qui héberge l'image.

Exemple :

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

object (OnClick)

Lorsqu'un utilisateur clique sur l'image, le clic déclenche cette action.

altText

string

Texte alternatif de cette image utilisé pour l'accessibilité.

DecoratedText

Widget qui affiche du texte avec des décorations facultatives, comme un libellé au-dessus ou en dessous du texte, une icône devant le texte, un widget de sélection ou un bouton après le texte. Pour obtenir un exemple dans les applications Google Chat, consultez Afficher du texte avec du texte décoratif.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
}
Champs
icon
(deprecated)

object (Icon)

Obsolète : remplacé par startIcon.

startIcon

object (Icon)

Icône affichée devant le texte.

startIconVerticalAlignment

enum (VerticalAlignment)

Facultatif. Alignement vertical de l'icône de début. Si elle n'est pas définie, l'icône sera centrée verticalement.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

topLabel

string

Texte qui s'affiche au-dessus de text. Tronque toujours.

topLabelText

object (TextParagraph)

TextParagraph équivalent de topLabel. Tronque toujours. Permet une mise en forme plus complexe que topLabel.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

text

string

Obligatoire. Texte principal.

Compatible avec la mise en forme simple. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

contentText

object (TextParagraph)

TextParagraph équivalent de text. Permet une mise en forme plus complexe que text.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

wrapText

boolean

Paramètre de retour à la ligne automatique. Si la valeur est true, le texte est renvoyé à la ligne et s'affiche sur plusieurs lignes. Sinon, le texte est tronqué.

S'applique uniquement à text, et non à topLabel et bottomLabel.

bottomLabel

string

Texte qui s'affiche sous text. Toujours renvoyé à la ligne.

bottomLabelText

object (TextParagraph)

TextParagraph équivalent de bottomLabel. Toujours renvoyé à la ligne. Permet une mise en forme plus complexe que bottomLabel.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

onClick

object (OnClick)

Cette action est déclenchée lorsque les utilisateurs cliquent n'importe où sur le widget DecoratedText (y compris sur text, topLabel, bottomLabel et les icônes), sauf lorsqu'ils cliquent sur une commande interactive distincte (button ou switchControl).

Bouton, commutateur, case à cocher ou image qui s'affiche à droite du texte dans le widget decoratedText. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
button

object (Button)

Bouton sur lequel un utilisateur peut cliquer pour déclencher une action.

switchControl

object (SwitchControl)

Widget de commutateur sur lequel l'utilisateur peut cliquer pour modifier son état et déclencher une action.

endIcon

object (Icon)

Icône affichée après le texte.

Compatible avec les icônes intégrées et personnalisées.

Fin des champs mutuellement exclusifs.

VerticalAlignment

Représente l'attribut d'alignement vertical.

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED Type non spécifié. Ne pas utiliser.
TOP Alignement en haut.
MIDDLE Alignement au milieu.
BOTTOM Alignement sur la position inférieure.

SwitchControl

Un bouton de type bascule ou une case à cocher dans un widget decoratedText.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Uniquement compatible avec le widget decoratedText.

Représentation JSON
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
Champs
name

string

Nom par lequel le widget de bouton bascule est identifié dans un événement de saisie de formulaire (en tant que clé dans CommonEventObject.form_inputs).

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

value

string

Valeur renvoyée dans CommonEventObject.form_inputs[name].string_inputs lorsque le bouton bascule est sélectionné (selected est true). Si selected est true et que value n'est pas défini, une chaîne vide ("") est renvoyée dans stringInputs.value. Lorsque selected est défini sur false, cette valeur est omise de stringInputs.value.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

selected

boolean

Lorsque true, le bouton bascule est sélectionné et son value est inclus dans CommonEventObject.form_inputs[name].string_inputs.value.

onChangeAction

object (Action)

Action à effectuer lorsque l'état du commutateur est modifié, par exemple la fonction à exécuter.

controlType

enum (ControlType)

Comment le commutateur apparaît dans l'interface utilisateur.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

ControlType

Comment le bouton s'affiche dans l'interface utilisateur.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
SWITCH Un bouton d'activation/de désactivation.
CHECKBOX Obsolète : remplacé par CHECK_BOX.
CHECK_BOX Case à cocher.

TextInput

Champ dans lequel les utilisateurs peuvent saisir du texte. Prend en charge les suggestions et les actions de modification. Compatible avec la validation de l'envoi de formulaires. Lorsque Action.all_widgets_are_required est défini sur true ou que ce widget est spécifié dans Action.required_widgets, l'action d'envoi est bloquée, sauf si une valeur est saisie. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un champ dans lequel un utilisateur peut saisir du texte.

Les applications Chat reçoivent et peuvent traiter la valeur du texte saisi lors des événements de saisie de formulaire. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

Lorsque vous devez collecter des données non définies ou abstraites auprès des utilisateurs, utilisez une saisie de texte. Pour collecter des données définies ou énumérées auprès des utilisateurs, utilisez le widget SelectionInput.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string,

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Champs
name

string

Nom par lequel la saisie de texte est identifiée dans un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

label

string

Texte qui s'affiche au-dessus du champ de saisie de texte dans l'interface utilisateur.

Spécifiez un texte qui aide l'utilisateur à saisir les informations dont votre application a besoin. Par exemple, si vous demandez le nom de quelqu'un, mais que vous avez spécifiquement besoin de son nom de famille, écrivez surname au lieu de name.

Obligatoire si hintText n'est pas spécifié. Sinon, il est facultatif.

hintText

string

Texte qui s'affiche sous le champ de saisie de texte pour aider les utilisateurs en les invitant à saisir une certaine valeur. Ce texte est toujours visible.

Obligatoire si label n'est pas spécifié. Sinon, il est facultatif.

value

string

Valeur saisie par un utilisateur, renvoyée dans le cadre d'un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

type

enum (Type)

Apparence d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, si le champ est sur une ou plusieurs lignes.

onChangeAction

object (Action)

Que faire lorsqu'une modification se produit dans le champ de saisie de texte. Par exemple, un utilisateur ajoute du texte au champ ou en supprime.

Par exemple, vous pouvez exécuter une fonction personnalisée ou ouvrir une boîte de dialogue dans Google Chat.

initialSuggestions

object (Suggestions)

Valeurs suggérées que les utilisateurs peuvent saisir. Ces valeurs s'affichent lorsque les utilisateurs cliquent dans le champ de saisie de texte. À mesure que les utilisateurs saisissent du texte, les valeurs suggérées sont filtrées de manière dynamique pour correspondre à ce qu'ils ont saisi.

Par exemple, un champ de saisie de texte pour un langage de programmation peut suggérer Java, JavaScript, Python et C++. Lorsque les utilisateurs commencent à saisir Jav, la liste des suggestions est filtrée pour n'afficher que Java et JavaScript.

Les valeurs suggérées aident les utilisateurs à saisir des valeurs que votre application peut interpréter. Pour faire référence à JavaScript, certains utilisateurs peuvent saisir javascript et d'autres java script. Suggérer JavaScript peut standardiser la façon dont les utilisateurs interagissent avec votre application.

Lorsqu'il est spécifié, TextInput.type est toujours SINGLE_LINE, même s'il est défini sur MULTIPLE_LINE.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

autoCompleteAction

object (Action)

Facultatif. Spécifiez l'action à effectuer lorsque le champ de saisie de texte fournit des suggestions aux utilisateurs qui interagissent avec lui.

Si aucune valeur n'est spécifiée, les suggestions sont définies par initialSuggestions et traitées par le client.

Si spécifié, l'application effectue l'action indiquée ici, par exemple l'exécution d'une fonction personnalisée.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

validation

object (Validation)

Spécifiez la validation du format d'entrée nécessaire pour ce champ de texte.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

placeholderText

string

Texte qui s'affiche dans le champ de saisie de texte lorsque le champ est vide. Utilisez ce texte pour inviter les utilisateurs à saisir une valeur. Par exemple : Enter a number from 0 to 100.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

object (HostAppDataSourceMarkup)

Source de données propre à une application hôte Google Workspace, comme les e-mails Gmail, les événements Google Agenda ou les messages Google Chat.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Fin des champs mutuellement exclusifs.

Type

Apparence d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, s'il s'agit d'un champ de saisie sur une seule ligne ou d'une saisie sur plusieurs lignes. Si initialSuggestions est spécifié, type est toujours SINGLE_LINE, même s'il est défini sur MULTIPLE_LINE.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
SINGLE_LINE Le champ de saisie de texte a une hauteur fixe d'une ligne.
MULTIPLE_LINE Le champ de saisie de texte a une hauteur fixe de plusieurs lignes.

RenderActions

Ensemble d'instructions de rendu qui indique à une fiche d'effectuer une action, ou qui indique à l'application hôte du module complémentaire ou à l'application Chat d'effectuer une action spécifique à l'application.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Champs
action

Action

Action

Champs
navigations[]

Navigation

Transfère, affiche ou met à jour une fiche.

Modules complémentaires dans Google Chat

Ajouter une nouvelle carte à la pile (navigation vers l'avant). Pour les applications Chat, disponible uniquement pour la page d'accueil de l'application.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

navigations: {
  pushCard: CARD
}

Remplacez la carte du dessus par une nouvelle carte. Pour les applications Chat, disponible uniquement pour la page d'accueil de l'application.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

navigations: {
  updateCard: CARD
}

Suggestions

Valeurs suggérées que les utilisateurs peuvent saisir. Ces valeurs s'affichent lorsque les utilisateurs cliquent dans le champ de saisie de texte. À mesure que les utilisateurs saisissent du texte, les valeurs suggérées sont filtrées de manière dynamique pour correspondre à ce qu'ils ont saisi.

Par exemple, un champ de saisie de texte pour un langage de programmation peut suggérer Java, JavaScript, Python et C++. Lorsque les utilisateurs commencent à saisir Jav, la liste des suggestions est filtrée pour afficher Java et JavaScript.

Les valeurs suggérées aident les utilisateurs à saisir des valeurs que votre application peut interpréter. Pour faire référence à JavaScript, certains utilisateurs peuvent saisir javascript et d'autres java script. Suggérer JavaScript peut standardiser la façon dont les utilisateurs interagissent avec votre application.

Lorsqu'il est spécifié, TextInput.type est toujours SINGLE_LINE, même s'il est défini sur MULTIPLE_LINE.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Champs
items[]

object (SuggestionItem)

Liste de suggestions utilisées pour les recommandations de saisie semi-automatique dans les champs de saisie de texte.

SuggestionItem

Une valeur suggérée que les utilisateurs peuvent saisir dans un champ de saisie de texte.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{

  "text": string
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
text

string

Valeur d'une entrée suggérée dans un champ de saisie de texte. Cela équivaut à ce que les utilisateurs saisissent eux-mêmes.

Fin des champs mutuellement exclusifs.

Validation

Représente les données nécessaires pour valider le widget auquel il est associé.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
Champs
characterLimit

integer

Spécifiez le nombre maximal de caractères pour les widgets de saisie de texte. Notez que cette option n'est utilisée que pour la saisie de texte et qu'elle est ignorée pour les autres widgets.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

inputType

enum (InputType)

Spécifiez le type des widgets d'entrée.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

InputType

Type du widget de saisie.

Enums
INPUT_TYPE_UNSPECIFIED Type non spécifié. Ne pas utiliser.
TEXT Texte standard qui accepte tous les caractères.
INTEGER Une valeur entière.
FLOAT Valeur flottante.
EMAIL Adresse e-mail
EMOJI_PICKER Emoji sélectionné dans le sélecteur d'emoji fourni par le système.

HostAppDataSourceMarkup

Source de données d'une application Google Workspace. La source de données renseigne les éléments disponibles pour un widget.

Représentation JSON
{

  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  },
  "workflowDataSource": {
    object (WorkflowDataSourceMarkup)
  }
}
Champs
Application Google Workspace qui renseigne les éléments disponibles pour un widget. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
chatDataSource

object (ChatClientDataSourceMarkup)

Une source de données de Google Chat.

workflowDataSource

object (WorkflowDataSourceMarkup)

Source de données provenant de Google Workflows.

Fin des champs mutuellement exclusifs.

ChatClientDataSourceMarkup

Pour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données de Google Chat. La source de données remplit les éléments de sélection du menu à sélection multiple. Par exemple, un utilisateur peut sélectionner les espaces Google Chat dont il est membre.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Représentation JSON
{

  "spaceDataSource": {
    object (SpaceDataSource)
  }
}
Champs
Source de données Google Chat Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
spaceDataSource

object (SpaceDataSource)

Espaces Google Chat dont l'utilisateur est membre.

Fin des champs mutuellement exclusifs.

SpaceDataSource

Source de données qui renseigne les espaces Google Chat en tant qu'éléments de sélection pour un menu à sélection multiple. Seuls les espaces dont l'utilisateur est membre sont renseignés.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Représentation JSON
{
  "defaultToCurrentSpace": boolean
}
Champs
defaultToCurrentSpace

boolean

Si la valeur est définie sur true, le menu de sélection multiple sélectionne par défaut l'espace Google Chat actuel en tant qu'élément.

WorkflowDataSourceMarkup

* Uniquement compatible avec Google Workspace Workflow, mais pas avec les applications Google Chat ni les modules complémentaires Google Workspace.

Dans un widget TextInput ou SelectionInput de type MULTI_SELECT, ou dans un widget DateTimePicker, fournissez une source de données Google.

Représentation JSON
{
  "includeVariables": boolean,
  "type": enum (Type)
}
Champs
includeVariables

boolean

Indique si les variables de l'étape précédente doivent être incluses dans la source de données.

type

enum (Type)

Type de source de données.

Type

Énumération représentant le type de la source de données du workflow.

Enums
UNKNOWN Valeur par défaut. À ne pas utiliser.
USER Utilisateurs de Google Workspace L'utilisateur ne peut afficher et sélectionner que les utilisateurs de son organisation Google Workspace.
SPACE Espaces Google Chat dont l'utilisateur est membre.
USER_WITH_FREE_FORM Les utilisateurs peuvent choisir d'afficher et de sélectionner des membres existants de leur organisation Google Workspace, ou saisir manuellement une adresse e-mail ou un domaine valide.

SelectionInput

Widget qui crée un ou plusieurs éléments d'interface utilisateur que les utilisateurs peuvent sélectionner. La validation de l'envoi de formulaires n'est possible que pour les menus dropdown et multiselect. Lorsque Action.all_widgets_are_required est défini sur true ou que ce widget est spécifié dans Action.required_widgets, l'action d'envoi est bloquée, sauf si une valeur est sélectionnée. Par exemple, un menu déroulant ou des cases à cocher. Vous pouvez utiliser ce widget pour collecter des données qui peuvent être prédites ou énumérées. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter des éléments d'interface utilisateur sélectionnables.

Les applications Chat peuvent traiter la valeur des éléments que les utilisateurs sélectionnent ou saisissent. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

Pour collecter des données non définies ou abstraites auprès des utilisateurs, utilisez le widget TextInput.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMinQueryLength": integer,
  "dataSourceConfigs": [
    {
      object (DataSourceConfig)
    }
  ],
  "multiSelectMaxSelectedItems": integer,
  "hintText": string,

  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
}
Champs
name

string

Obligatoire. Nom qui identifie l'entrée de sélection dans un événement d'entrée de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

label

string

Texte qui s'affiche au-dessus du champ de saisie de la sélection dans l'interface utilisateur.

Spécifiez un texte qui aide l'utilisateur à saisir les informations dont votre application a besoin. Par exemple, si les utilisateurs sélectionnent l'urgence d'un ticket de travail dans un menu déroulant, le libellé peut être "Urgence" ou "Sélectionner l'urgence".

type

enum (SelectionType)

Type d'éléments affichés aux utilisateurs dans un widget SelectionInput. Les types de sélection sont compatibles avec différents types d'interactions. Par exemple, les utilisateurs peuvent cocher une ou plusieurs cases, mais ils ne peuvent sélectionner qu'une seule valeur dans un menu déroulant.

items[]

object (SelectionItem)

Tableau d'éléments sélectionnables. Par exemple, un tableau de cases d'option ou de cases à cocher. Accepte jusqu'à 100 éléments.

onChangeAction

object (Action)

Si cette option est spécifiée, le formulaire est envoyé lorsque la sélection change. Si vous ne le spécifiez pas, vous devez indiquer un bouton distinct qui envoie le formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

multiSelectMinQueryLength

integer

Pour les menus à sélection multiple, nombre de caractères de texte qu'un utilisateur saisit avant que le menu ne renvoie des éléments de sélection suggérés.

Si ce paramètre n'est pas défini, le menu de sélection multiple utilise les valeurs par défaut suivantes :

  • Si le menu utilise un tableau statique d'éléments SelectionInput, la valeur par défaut est de 0 caractère et les éléments du tableau sont immédiatement renseignés.
  • Si le menu utilise une source de données dynamique (multi_select_data_source), la valeur par défaut est de trois caractères avant d'interroger la source de données pour renvoyer les éléments suggérés.
dataSourceConfigs[]

object (DataSourceConfig)

Facultatif. Configurations de la source de données pour la commande de sélection. Ce champ permet de contrôler plus précisément la source de données.

Si spécifié, les champs multiSelectMaxSelectedItems, multiSelectMinQueryLength, externalDataSource et platformDataSource sont ignorés.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

Disponible pour Dropdown widget dans les applications Google Chat. Pour le widget Dropdown dans les applications Google Chat, un seul DataSourceConfig est accepté. Si plusieurs DataSourceConfig sont définis, seul le premier est utilisé.

multiSelectMaxSelectedItems

integer

Pour les menus à sélection multiple, nombre maximal d'éléments qu'un utilisateur peut sélectionner. La valeur minimale est de 1 élément. Si aucune valeur n'est spécifiée, la valeur par défaut est de trois éléments.

hintText

string

Facultatif. Texte qui s'affiche sous le champ de saisie de sélection pour aider les utilisateurs en les invitant à saisir une certaine valeur. Ce texte est toujours visible.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Pour un menu à sélection multiple, une source de données qui remplit dynamiquement les éléments de sélection.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :

externalDataSource

object (Action)

Une source de données externe, telle qu'une base de données relationnelle.

platformDataSource

object (PlatformDataSource)

Une source de données de Google Workspace.

Fin des champs mutuellement exclusifs.

SelectionType

Format des éléments que les utilisateurs peuvent sélectionner. Les différentes options permettent différents types d'interactions. Par exemple, les utilisateurs peuvent sélectionner plusieurs cases à cocher, mais ne peuvent sélectionner qu'un seul élément dans un menu déroulant.

Chaque entrée de sélection n'accepte qu'un seul type de sélection. Par exemple, il n'est pas possible de mélanger des cases à cocher et des boutons bascule.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
CHECK_BOX Ensemble de cases à cocher. Les utilisateurs peuvent cocher une ou plusieurs cases.
RADIO_BUTTON Un ensemble de cases d'option. Les utilisateurs peuvent sélectionner une case d'option.
SWITCH Un ensemble de commutateurs. Les utilisateurs peuvent activer un ou plusieurs boutons.
DROPDOWN

Un menu déroulant. Les utilisateurs peuvent sélectionner un élément dans le menu.

Pour les applications Google Chat, vous pouvez renseigner des éléments à l'aide d'une source de données dynamique et suggérer automatiquement des éléments à mesure que les utilisateurs saisissent du texte dans le menu. Par exemple, les utilisateurs peuvent commencer à saisir le nom d'un espace Google Chat, et le widget suggère automatiquement l'espace. Pour renseigner de manière dynamique les éléments d'un menu déroulant, utilisez l'un des types de sources de données suivants :

  • Données Google Workspace : les éléments sont renseignés à l'aide de données provenant de Google Workspace, telles que les utilisateurs Google Workspace ou les espaces Google Chat.
  • Données externes : les éléments sont renseignés à partir d'une source de données externe à Google Workspace.

Pour découvrir comment implémenter des menus déroulants pour les applications Chat, consultez Ajouter un menu déroulant et Remplir dynamiquement des menus déroulants.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

MULTI_SELECT

Menu avec une zone de texte. Les utilisateurs peuvent saisir et sélectionner un ou plusieurs éléments. Pour les modules complémentaires Google Workspace, vous devez renseigner les éléments à l'aide d'un tableau statique d'objets SelectionItem.

Pour les applications Google Chat, vous pouvez également renseigner des éléments à l'aide d'une source de données dynamique et suggérer automatiquement des éléments à mesure que les utilisateurs saisissent du texte dans le menu. Par exemple, les utilisateurs peuvent commencer à saisir le nom d'un espace Google Chat, et le widget suggère automatiquement l'espace. Pour renseigner dynamiquement les éléments d'un menu à sélection multiple, utilisez l'un des types de sources de données suivants :

  • Données Google Workspace : les éléments sont renseignés à l'aide de données provenant de Google Workspace, telles que les utilisateurs Google Workspace ou les espaces Google Chat.
  • Données externes : les éléments sont renseignés à partir d'une source de données externe à Google Workspace.

Pour découvrir comment implémenter des menus à sélection multiple pour les applications Chat, consultez Ajouter un menu à sélection multiple.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

PlatformDataSource

Pour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données de Google Workspace. Permet de renseigner les éléments d'un menu à sélection multiple.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Représentation JSON
{

  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Champs
la source de données ; Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
commonDataSource

enum (CommonDataSource)

Source de données partagée par toutes les applications Google Workspace, comme les utilisateurs d'une organisation Google Workspace.

hostAppDataSource

object (HostAppDataSourceMarkup)

Source de données propre à une application hôte Google Workspace, comme les espaces dans Google Chat.

Ce champ est compatible avec les bibliothèques clientes des API Google, mais n'est pas disponible dans les bibliothèques clientes Cloud. Pour en savoir plus, consultez Installer les bibliothèques clientes.

Fin des champs mutuellement exclusifs.

CommonDataSource

Une source de données partagée par toutes les applications Google Workspace.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Enums
UNKNOWN Valeur par défaut. À ne pas utiliser.
USER Utilisateurs de Google Workspace L'utilisateur ne peut afficher et sélectionner que les utilisateurs de son organisation Google Workspace.

DataSourceConfig

Objet de configuration qui permet de configurer les sources de données d'un widget.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

Représentation JSON
{

  "remoteDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  "minCharactersTrigger": integer
}
Champs
la source de données ; Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
remoteDataSource

object (Action)

Les données proviennent d'un fournisseur de données distant.

platformDataSource

object (PlatformDataSource)

Les données proviennent d'une application Google Workspace.

Fin des champs mutuellement exclusifs.
minCharactersTrigger

integer

Nombre minimal de caractères que l'utilisateur doit saisir avant que ce fournisseur de données ne soit déclenché (c'est-à-dire avant qu'il ne commence à renvoyer des résultats).

DateTimePicker

Permet aux utilisateurs de saisir une date, une heure, ou une date et une heure. Compatible avec la validation de l'envoi de formulaires. Lorsque Action.all_widgets_are_required est défini sur true ou que ce widget est spécifié dans Action.required_widgets, l'action d'envoi est bloquée, sauf si une valeur est sélectionnée. Pour obtenir un exemple dans les applications Google Chat, consultez Permettre à un utilisateur de sélectionner une date et une heure.

Les utilisateurs peuvent saisir du texte ou utiliser le sélecteur pour choisir des dates et des heures. Si les utilisateurs saisissent une date ou une heure non valide, le sélecteur affiche une erreur qui les invite à saisir correctement les informations.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Champs
name

string

Nom par lequel le DateTimePicker est identifié dans un événement de saisie de formulaire.

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire.

label

string

Texte qui invite les utilisateurs à saisir une date, une heure ou une date et une heure. Par exemple, si les utilisateurs planifient un rendez-vous, utilisez un libellé tel que Appointment date ou Appointment date and time.

type

enum (DateTimePickerType)

Indique si le widget accepte la saisie d'une date, d'une heure ou d'une date et d'une heure.

valueMsEpoch

string (int64 format)

Valeur par défaut affichée dans le widget, en millisecondes depuis l'epoch Unix.

Spécifiez la valeur en fonction du type de sélecteur (DateTimePickerType) :

  • DATE_AND_TIME : date et heure du calendrier au format UTC. Par exemple, pour représenter le 1er janvier 2023 à 12h00 UTC, utilisez 1672574400000.
  • DATE_ONLY : date du calendrier à 00:00:00 UTC. Par exemple, pour représenter le 1er janvier 2023, utilisez 1672531200000.
  • TIME_ONLY : heure au format UTC. Par exemple, pour représenter 12h00, utilisez 43200000 (ou 12 * 60 * 60 * 1000).
timezoneOffsetDate

integer

Nombre représentant le décalage du fuseau horaire par rapport à l'heure UTC, en minutes. Si ce champ est défini, le valueMsEpoch est affiché dans le fuseau horaire spécifié. Si cette valeur n'est pas définie, elle est définie par défaut sur le paramètre de fuseau horaire de l'utilisateur.

Remarque : Ce champ est exprimé en minutes, tandis que les charges utiles des événements d'interaction utilisateur fournissent généralement les décalages de fuseau horaire en millisecondes (divisez par 60000 pour convertir).

onChangeAction

object (Action)

Déclenché lorsque l'utilisateur clique sur Enregistrer ou Effacer dans l'interface DateTimePicker.

Source de données spécifiée pour représenter une date et une heure. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
hostAppDataSource

object (HostAppDataSourceMarkup)

Source de données propre à une application hôte Google Workspace, comme les e-mails Gmail, les événements Google Agenda ou les messages Google Chat.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Fin des champs mutuellement exclusifs.

DateTimePickerType

Format de la date et de l'heure dans le widget DateTimePicker. Détermine si les utilisateurs peuvent saisir une date, une heure, ou les deux.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
DATE_AND_TIME Les utilisateurs saisissent une date et une heure.
DATE_ONLY Les utilisateurs saisissent une date.
TIME_ONLY Les utilisateurs saisissent une heure.

Séparateur

Ce type ne comporte aucun champ.

Affiche un séparateur entre les widgets sous la forme d'une ligne horizontale. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un séparateur horizontal entre les widgets.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Par exemple, le code JSON suivant crée un séparateur :

"divider": {}

Grille

Affiche une grille avec une collection d'éléments. Les éléments ne peuvent inclure que du texte ou des images. Pour les colonnes responsives ou pour inclure autre chose que du texte ou des images, utilisez Columns. Pour obtenir un exemple dans les applications Google Chat, consultez Afficher une grille avec une collection d'éléments.

Une grille peut contenir un nombre illimité de colonnes et d'éléments. Le nombre de lignes est déterminé par le nombre d'éléments divisé par le nombre de colonnes. Une grille de 10 éléments et de deux colonnes comporte cinq lignes. Une grille de 11 éléments et de deux colonnes comporte six lignes.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Par exemple, le code JSON suivant crée une grille à deux colonnes avec un seul élément :

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
Représentation JSON
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
Champs
title

string

Texte qui s'affiche dans l'en-tête de la grille.

items[]

object (GridItem)

Éléments à afficher dans la grille.

borderStyle

object (BorderStyle)

Style de bordure à appliquer à chaque élément de la grille.

columnCount

integer

Nombre de colonnes à afficher dans la grille. Une valeur par défaut est utilisée si ce champ n'est pas spécifié. Cette valeur par défaut est différente selon l'emplacement où la grille est affichée (boîte de dialogue ou compagnon).

onClick

object (OnClick)

Ce rappel est réutilisé par chaque élément de la grille, mais l'identifiant de l'élément est ajouté aux paramètres du rappel (sous la clé "grid_item_identifier").

GridItem

Représente un élément dans une mise en page en grille. Les éléments peuvent contenir du texte, une image ou les deux.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
Champs
id

string

Identifiant spécifié par l'utilisateur pour cet élément de grille. Cet identifiant est renvoyé dans les paramètres de rappel onClick de la grille parente.

image

object (ImageComponent)

Image qui s'affiche dans l'élément de la grille.

title

string

Titre de l'élément de grille.

subtitle

string

Sous-titre de l'élément de grille.

layout

enum (GridItemLayout)

Mise en page à utiliser pour l'élément de grille.

ImageComponent

Représente une image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
Champs
imageUri

string

URL de l'image.

altText

string

Libellé d'accessibilité de l'image.

cropStyle

object (ImageCropStyle)

Style de recadrage à appliquer à l'image.

borderStyle

object (BorderStyle)

Style de bordure à appliquer à l'image.

ImageCropStyle

Représente le style de recadrage appliqué à une image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Par exemple, voici comment appliquer un format 16:9 :

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Représentation JSON
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
Champs
type

enum (ImageCropType)

Type de culture.

aspectRatio

number

Format à utiliser si le type de recadrage est RECTANGLE_CUSTOM.

Par exemple, voici comment appliquer un format 16:9 :

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

Représente le style de recadrage appliqué à une image.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED À ne pas utiliser. Non spécifié.
SQUARE Valeur par défaut. Applique un recadrage carré.
CIRCLE Applique un recadrage circulaire.
RECTANGLE_CUSTOM Applique un recadrage rectangulaire avec un format personnalisé. Définissez le format personnalisé avec aspectRatio.
RECTANGLE_4_3 Applique un recadrage rectangulaire au format 4:3.

BorderStyle

Options de style pour la bordure d'une fiche ou d'un widget, y compris le type et la couleur de la bordure.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
Champs
type

enum (BorderType)

Type de bordure.

strokeColor

object (Color)

Couleurs à utiliser lorsque le type est BORDER_TYPE_STROKE.

Pour définir la couleur du trait, spécifiez une valeur pour les champs red, green et blue. La valeur doit être un nombre à virgule flottante compris entre 0 et 1, basé sur la valeur de couleur RVB, où 0 (0/255) représente l'absence de couleur et 1 (255/255) représente l'intensité maximale de la couleur.

Par exemple, la commande suivante définit la couleur sur rouge à son intensité maximale :

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Le champ alpha n'est pas disponible pour la couleur du trait. S'il est spécifié, ce champ est ignoré.

cornerRadius

integer

Rayon de l'arrondi de la bordure.

BorderType

Représente les types de bordures appliqués aux widgets.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
BORDER_TYPE_UNSPECIFIED À ne pas utiliser. Non spécifié.
NO_BORDER Aucune bordure.
STROKE Valeur par défaut. Outline.

GridItemLayout

Représente les différentes options de mise en page disponibles pour un élément de grille.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED À ne pas utiliser. Non spécifié.
TEXT_BELOW Le titre et le sous-titre sont affichés sous l'image de l'élément de la grille.
TEXT_ABOVE Le titre et le sous-titre s'affichent au-dessus de l'image de l'élément de la grille.

Colonnes

Le widget Columns affiche jusqu'à deux colonnes dans une fiche ou une boîte de dialogue. Vous pouvez ajouter des widgets à chaque colonne. Les widgets s'affichent dans l'ordre dans lequel ils sont spécifiés. Pour obtenir un exemple dans les applications Google Chat, consultez Afficher des fiches et des boîtes de dialogue dans des colonnes.

La hauteur de chaque colonne est déterminée par la colonne la plus haute. Par exemple, si la première colonne est plus haute que la deuxième, les deux colonnes ont la hauteur de la première. Comme chaque colonne peut contenir un nombre différent de widgets, vous ne pouvez pas définir de lignes ni aligner les widgets entre les colonnes.

Les colonnes sont affichées côte à côte. Vous pouvez personnaliser la largeur de chaque colonne à l'aide du champ HorizontalSizeStyle. Si la largeur de l'écran de l'utilisateur est trop étroite, la deuxième colonne s'affiche sous la première :

  • Sur le Web, la deuxième colonne est renvoyée à la ligne si la largeur de l'écran est inférieure ou égale à 480 pixels.
  • Sur les appareils iOS, la deuxième colonne est renvoyée à la ligne si la largeur de l'écran est inférieure ou égale à 300 pt.
  • Sur les appareils Android, la deuxième colonne est renvoyée à la ligne si la largeur de l'écran est inférieure ou égale à 320 dp.

Pour inclure plus de deux colonnes ou pour utiliser des lignes, utilisez le widget Grid.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace. Les interfaces utilisateur de modules complémentaires compatibles avec les colonnes incluent :

  • Boîte de dialogue qui s'affiche lorsque les utilisateurs ouvrent le module complémentaire à partir d'un brouillon d'e-mail.
  • Boîte de dialogue qui s'affiche lorsque les utilisateurs ouvrent le module complémentaire depuis le menu Ajouter une pièce jointe d'un événement Google Agenda.
Représentation JSON
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
Champs
columnItems[]

object (Column)

Tableau de colonnes. Vous pouvez inclure jusqu'à deux colonnes dans une fiche ou une boîte de dialogue.

Colonne

Une colonne.

Modules complémentaires Google Workspace et applications Chat

Représentation JSON
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
Champs
horizontalSizeStyle

enum (HorizontalSizeStyle)

Spécifie comment une colonne remplit la largeur de la fiche.

horizontalAlignment

enum (HorizontalAlignment)

Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.

verticalAlignment

enum (VerticalAlignment)

Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne.

widgets[]

object (Widgets)

Tableau de widgets inclus dans une colonne. Les widgets s'affichent dans l'ordre dans lequel ils sont spécifiés.

HorizontalSizeStyle

Spécifie comment une colonne remplit la largeur de la fiche. La largeur de chaque colonne dépend à la fois de HorizontalSizeStyle et de la largeur des widgets qu'elle contient.

Modules complémentaires Google Workspace et applications Chat

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED À ne pas utiliser. Non spécifié.
FILL_AVAILABLE_SPACE Valeur par défaut. La colonne remplit l'espace disponible, jusqu'à 70 % de la largeur de la fiche. Si les deux colonnes sont définies sur FILL_AVAILABLE_SPACE, chacune d'elles occupe 50 % de l'espace.
FILL_MINIMUM_SPACE La colonne occupe le moins d'espace possible et ne dépasse pas 30 % de la largeur de la fiche.

HorizontalAlignment

Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.

 Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED À ne pas utiliser. Non spécifié.
START Valeur par défaut. Aligne les widgets sur la position de départ de la colonne. Pour les mises en page de gauche à droite, aligne sur la gauche. Pour les mises en page de droite à gauche, l'alignement se fait à droite.
CENTER Aligne les widgets au centre de la colonne.
END Aligne les widgets sur la position de fin de la colonne. Pour les mises en page de gauche à droite, aligne les widgets à droite. Pour les mises en page de droite à gauche, aligne les widgets à gauche.

VerticalAlignment

Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne.

Modules complémentaires Google Workspace et applications Chat

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED À ne pas utiliser. Non spécifié.
CENTER Valeur par défaut. Aligne les widgets au centre d'une colonne.
TOP Aligne les widgets en haut d'une colonne.
BOTTOM Aligne les widgets en bas d'une colonne.

Widgets

Widgets compatibles que vous pouvez inclure dans une colonne.

Modules complémentaires Google Workspace et applications Chat

Représentation JSON
{

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
textParagraph

object (TextParagraph)

Widget TextParagraph

image

object (Image)

Widget Image

decoratedText

object (DecoratedText)

Widget DecoratedText

buttonList

object (ButtonList)

Widget ButtonList

textInput

object (TextInput)

Widget TextInput

selectionInput

object (SelectionInput)

Widget SelectionInput

dateTimePicker

object (DateTimePicker)

Widget DateTimePicker

chipList

object (ChipList)

Widget ChipList

Fin des champs mutuellement exclusifs.

ChipList

Liste de chips disposés horizontalement, qui peuvent défiler horizontalement ou passer à la ligne suivante.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
Champs
layout

enum (Layout)

Disposition en liste des chips spécifiée.

chips[]

object (Chip)

Tableau de chips.

Disposition

La disposition en liste de chips.

Enums
LAYOUT_UNSPECIFIED À ne pas utiliser. Non spécifié.
WRAPPED Valeur par défaut. La liste de chips passe à la ligne suivante s'il n'y a pas assez d'espace horizontal.
HORIZONTAL_SCROLLABLE Les chips défilent horizontalement s'ils ne tiennent pas dans l'espace disponible.

Chip

Chip de texte, d'icône, ou de texte et d'icône sur lequel les utilisateurs peuvent cliquer.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
Champs
icon

object (Icon)

Image de l'icône. Si icon et label sont tous deux définis, l'icône s'affiche avant le libellé.

label

string

Texte affiché dans le chip.

onClick

object (OnClick)

Facultatif. Action à effectuer lorsqu'un utilisateur clique sur le chip, par exemple ouvrir un lien hypertexte ou exécuter une fonction personnalisée.

enabled
(deprecated)

boolean

Obsolète : utilisez disabled à la place.

Indique si le chip est actif et répond aux actions de l'utilisateur.

disabled

boolean

Indique si le chip est inactif et ignore les actions de l'utilisateur. La valeur par défaut est false.

altText

string

Texte alternatif utilisé pour l'accessibilité.

Définissez un texte descriptif qui indique aux utilisateurs ce que fait le chip. Par exemple, si un chip ouvre un lien hypertexte, écrivez : "Ouvre un nouvel onglet de navigateur et accède à la documentation pour les développeurs Google Chat à l'adresse https://developers.google.com/workspace/chat".

CarouselCard

Fiche pouvant être affichée en tant qu'élément de carrousel.  Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Représentation JSON
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
Champs
widgets[]

object (NestedWidget)

Liste des widgets affichés dans la fiche de carrousel. Les widgets sont affichés dans l'ordre dans lequel ils sont spécifiés.

footerWidgets[]

object (NestedWidget)

Liste des widgets affichés au bas de la fiche de carrousel. Les widgets sont affichés dans l'ordre dans lequel ils sont spécifiés.

NestedWidget

Liste des widgets pouvant être affichés dans une mise en page conteneur, telle qu'un CarouselCard.  Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Représentation JSON
{

  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
textParagraph

object (TextParagraph)

Widget de paragraphe de texte.

buttonList

object (ButtonList)

Widget de liste de boutons.

image

object (Image)

Widget d'image.

Fin des champs mutuellement exclusifs.

Visibilité

Indique si un élément d'interface utilisateur est visible ou masqué.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Enums
VISIBILITY_UNSPECIFIED Visibilité non spécifiée. Ne pas utiliser.
VISIBLE L'élément d'interface utilisateur est visible.
HIDDEN L'élément d'interface utilisateur est masqué.

EventAction

Représente une action pouvant être effectuée sur un élément d'interface utilisateur.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{
  "actionRuleId": string,
  "postEventTriggers": [
    {
      object (Trigger)
    }
  ],

  "commonWidgetAction": {
    object (CommonWidgetAction)
  }
}
Champs
actionRuleId

string

Identifiant unique de l'ActionRule.

postEventTriggers[]

object (Trigger)

Liste des déclencheurs qui seront déclenchés après l'exécution de l'EventAction.

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

object (CommonWidgetAction)

Action de widget courante.

Fin des champs mutuellement exclusifs.

Déclencheur

Représente un déclencheur.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

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

string

Identifiant unique de l'ActionRule.

CommonWidgetAction

Représente une action qui n'est pas spécifique à un widget.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{

  "updateVisibilityAction": {
    object (UpdateVisibilityAction)
  }
}
Champs
Action à effectuer. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
updateVisibilityAction

object (UpdateVisibilityAction)

Action permettant de modifier la visibilité d'un widget.

Fin des champs mutuellement exclusifs.

UpdateVisibilityAction

Représente une action qui met à jour la visibilité d'un widget.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{
  "visibility": enum (Visibility)
}
Champs
visibility

enum (Visibility)

La nouvelle visibilité.

CollapseControl

Représente une commande de développement et de réduction.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
Champs
horizontalAlignment

enum (HorizontalAlignment)

Alignement horizontal du bouton de développement et de réduction.

expandButton

object (Button)

Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs expandButton et collapseButton doivent tous deux être définis. Un seul ensemble de champs ne sera pas pris en compte. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

collapseButton

object (Button)

Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs expandButton et collapseButton doivent tous deux être définis. Un seul ensemble de champs ne sera pas pris en compte. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

DividerStyle

Style de séparateur d'une carte. Actuellement utilisé uniquement pour les séparateurs entre les sections de la fiche.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Enums
DIVIDER_STYLE_UNSPECIFIED À ne pas utiliser. Non spécifié.
SOLID_DIVIDER Option par défaut. Affiche un séparateur plein.
NO_DIVIDER Si cette option est définie, aucun séparateur n'est affiché. Ce style supprime complètement le séparateur de la mise en page. Le résultat est équivalent à ne pas ajouter de séparateur du tout.

CardAction

Une action de fiche est l'action associée à la fiche. Par exemple, une fiche de facture peut inclure des actions telles que la suppression de la facture, l'envoi de la facture par e-mail ou l'ouverture de la facture dans un navigateur.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

Représentation JSON
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Champs
actionLabel

string

Libellé qui s'affiche en tant qu'élément du menu d'actions.

onClick

object (OnClick)

L'action onClick pour cette action.

CardFixedFooter

Un pied de page persistant (fixe) qui s'affiche en bas de la fiche.

La définition de fixedFooter sans spécifier de primaryButton ou de secondaryButton entraîne une erreur.

Pour les applications Chat, vous pouvez utiliser des pieds de page fixes dans les boîtes de dialogue, mais pas dans les messages de fiche. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un pied de page persistant.

Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.

Représentation JSON
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
Champs
primaryButton

object (Button)

Bouton principal du pied de page fixe. Le bouton doit être un bouton de texte avec un texte et une couleur définis.

secondaryButton

object (Button)

Bouton secondaire du pied de page fixe. Le bouton doit être un bouton de texte avec un texte et une couleur définis. Si secondaryButton est défini, vous devez également définir primaryButton.

DisplayStyle

Dans les modules complémentaires Google Workspace, détermine comment une fiche est affichée.

 Disponible pour les modules complémentaires Google Workspace et non disponible pour les applications Google Chat.

Enums
DISPLAY_STYLE_UNSPECIFIED À ne pas utiliser. Non spécifié.
PEEK L'en-tête de la fiche s'affiche en bas de la barre latérale, couvrant partiellement la fiche actuellement en haut de la pile. Cliquez sur l'en-tête pour ajouter la fiche à la pile. Si la fiche n'a pas d'en-tête, un en-tête généré est utilisé à la place.
REPLACE Valeur par défaut. La carte s'affiche en remplaçant la vue de la carte supérieure dans la pile de cartes.

ExpressionData

Représente les données utilisées pour évaluer une expression.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{
  "id": string,
  "expression": string,
  "conditions": [
    {
      object (Condition)
    }
  ],
  "eventActions": [
    {
      object (EventAction)
    }
  ]
}
Champs
id

string

Identifiant unique de l'ExpressionData.

expression

string

Expression non compilée.

conditions[]

object (Condition)

Liste des conditions déterminées par le résultat de l'évaluation de l'expression.

eventActions[]

object (EventAction)

Liste des actions pour lesquelles ExpressionData peut être utilisé.

Condition

Représente une condition pouvant être utilisée pour déclencher une action.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{
  "actionRuleId": string,

  "expressionDataCondition": {
    object (ExpressionDataCondition)
  }
}
Champs
actionRuleId

string

Identifiant unique de l'ActionRule.

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

object (ExpressionDataCondition)

Condition déterminée par les données de l'expression.

Fin des champs mutuellement exclusifs.

ExpressionDataCondition

Représente une condition évaluée à l'aide de CEL.

Disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio. Non disponible pour les applications Google Chat.

Représentation JSON
{
  "conditionType": enum (ConditionType)
}
Champs
conditionType

enum (ConditionType)

Type de la condition.

ConditionType

Type de la condition.

Enums
CONDITION_TYPE_UNSPECIFIED Type de condition non spécifié.
EXPRESSION_EVALUATION_SUCCESS L'évaluation de l'expression a réussi.
EXPRESSION_EVALUATION_FAILURE Échec de l'évaluation de l'expression.