Index
Action
(message)Action.ActionParameter
(message)Action.Interaction
(enum)Action.LoadIndicator
(enum)BorderStyle
(message)BorderStyle.BorderType
(enum)Button
(message)Button.Type
(enum)ButtonList
(message)Card
(message)Card.CardAction
(message)Card.CardFixedFooter
(message)Card.CardHeader
(message)Card.DisplayStyle
(enum)Card.DividerStyle
(enum)Card.NestedWidget
(message)Card.Section
(message)Carousel
(message)Carousel.CarouselCard
(message)Chip
(message)ChipList
(message)ChipList.Layout
(enum)CollapseControl
(message)Columns
(message)Columns.Column
(message)Columns.Column.HorizontalSizeStyle
(enum)Columns.Column.VerticalAlignment
(enum)Columns.Column.Widgets
(message)DateTimePicker
(message)DateTimePicker.DateTimePickerType
(enum)DecoratedText
(message)DecoratedText.SwitchControl
(message)DecoratedText.SwitchControl.ControlType
(enum)Divider
(message)Grid
(message)Grid.GridItem
(message)Grid.GridItem.GridItemLayout
(enum)Icon
(message)Image
(message)ImageComponent
(message)ImageCropStyle
(message)ImageCropStyle.ImageCropType
(enum)MaterialIcon
(message)OnClick
(message)OpenLink
(message)OpenLink.OnClose
(enum)OpenLink.OpenAs
(enum)OverflowMenu
(message)OverflowMenu.OverflowMenuItem
(message)SelectionInput
(message)SelectionInput.PlatformDataSource
(message)SelectionInput.PlatformDataSource.CommonDataSource
(enum)SelectionInput.SelectionItem
(message)SelectionInput.SelectionType
(enum)Suggestions
(message)Suggestions.SuggestionItem
(message)TextInput
(message)TextInput.Type
(enum)TextParagraph
(message)TextParagraph.TextSyntax
(enum)Validation
(message)Validation.InputType
(enum)Widget
(message)Widget.HorizontalAlignment
(enum)Widget.ImageType
(enum)Widget.VerticalAlignment
(enum)
Action
Action qui décrit le comportement lorsque le formulaire est envoyé. Par exemple, vous pouvez appeler un script Apps Script pour gérer le formulaire. Si l'action est déclenchée, les valeurs du formulaire sont envoyées au serveur.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
function |
Fonction personnalisée à appeler lorsque l'élément conteneur est cliqué ou activé d'une autre manière. Pour obtenir des exemples d'utilisation, consultez Lire les données de formulaire. |
parameters[] |
Liste des paramètres d'action. |
load_indicator |
Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action. |
persist_values |
Indique si les valeurs du formulaire sont conservées après l'action. La valeur par défaut est Si la valeur est Si la valeur est |
interaction |
Facultatif. Obligatoire lors de l'ouverture d'une boîte de dialogue. Action à effectuer en réponse à une interaction avec un utilisateur, par exemple lorsqu'il clique sur un bouton dans un message de fiche. Si elle n'est pas spécifiée, l'application répond en exécutant un En spécifiant un
|
required_widgets[] |
Facultatif. Remplissez cette liste avec les noms des widgets dont cette action a besoin pour une soumission valide. Si les widgets listés ici n'ont pas de valeur lorsque cette action est appelée, l'envoi du formulaire est annulé.
|
all_widgets_are_required |
Facultatif. Si la valeur est "true", tous les widgets sont considérés comme requis par cette action.
|
ActionParameter
Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. Par exemple, pensez à trois boutons de report : "Reporter maintenant", "Reporter d'un jour" ou "Reporter d'une semaine". Vous pouvez utiliser action method = snooze()
en transmettant le type et la durée de la mise en veille dans la liste des paramètres de chaîne.
Pour en savoir plus, consultez CommonEventObject
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
key |
Nom du paramètre du script d'action. |
value |
Valeur du paramètre. |
Interaction
Facultatif. Obligatoire lors de l'ouverture d'une boîte de dialogue.
Action à effectuer en réponse à une interaction avec un utilisateur, par exemple lorsqu'il clique sur un bouton dans un message de fiche.
Si elle n'est pas spécifiée, l'application répond en exécutant un action
(comme ouvrir un lien ou exécuter une fonction) normalement.
En spécifiant un interaction
, l'application peut répondre de manière interactive spéciale. Par exemple, en définissant interaction
sur OPEN_DIALOG
, l'application peut ouvrir une boîte de dialogue.
Si spécifié, aucun indicateur de chargement n'est affiché. Si elle est spécifiée pour un module complémentaire, la carte entière est supprimée et rien n'est affiché dans le client.
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Enums | |
---|---|
INTERACTION_UNSPECIFIED |
Valeur par défaut. Le action s'exécute normalement. |
OPEN_DIALOG |
Ouvre une boîte de dialogue, une interface fenêtrée basée sur des fiches que les applications Chat utilisent pour interagir avec les utilisateurs. Uniquement pris en charge par les applications Chat en réponse aux clics sur les boutons des messages sous forme de fiches. Si elle est spécifiée pour un module complémentaire, la carte entière est supprimée et rien n'est affiché dans le client.
|
LoadIndicator
Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
SPINNER |
Affiche un indicateur de chargement pour indiquer que le contenu est en cours de chargement. |
NONE |
Rien ne s'affiche. |
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.
Champs | |
---|---|
type |
Type de bordure. |
stroke_color |
Couleurs à utiliser lorsque le type est Pour définir la couleur du trait, spécifiez une valeur pour les champs Par exemple, la ligne suivante définit la couleur sur rouge à son intensité maximale :
Le champ |
corner_radius |
Rayon d'angle de la bordure. |
BorderType
Représente les types de bordure 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. Contour. |
Bouton
Bouton avec du texte, une icône, ou du texte et une icône sur lequel les utilisateurs peuvent cliquer. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un bouton.
Pour transformer une image en bouton cliquable, spécifiez un
(et non un Image
) et définissez une action ImageComponent
onClick
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
text |
Texte affiché dans le bouton. |
icon |
Icône affichée dans le bouton. Si les deux paramètres |
color |
Facultatif. Couleur du bouton. Si cette option est définie, le bouton Pour définir la couleur du bouton, spécifiez une valeur pour les champs Par exemple, la ligne suivante définit la couleur sur rouge à son intensité maximale :
Le champ |
on_click |
Obligatoire. Action à effectuer lorsqu'un utilisateur clique sur le bouton, par exemple ouvrir un lien hypertexte ou exécuter une fonction personnalisée. |
disabled |
Si la valeur est |
alt_text |
Texte alternatif utilisé pour l'accessibilité. Définissez un texte descriptif qui indique aux utilisateurs ce que fait le bouton. Par exemple, si un bouton ouvre un lien hypertexte, vous pouvez écrire : "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". |
type |
Facultatif. Type de bouton. Si cette valeur n'est pas définie, le type de bouton est défini par défaut sur |
Type
Facultatif. Le type d'un bouton. Si le champ color
est défini, type
est défini sur FILLED
.
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Ne pas utiliser. Non spécifié. |
OUTLINED |
Les boutons avec contours sont des boutons à emphase moyenne. Ils contiennent généralement des actions importantes, mais qui ne sont pas l'action principale d'une application ou d'un module complémentaire Chat. |
FILLED |
Un bouton rempli comporte un conteneur de couleur unie. Il a le plus d'impact visuel et est recommandé pour l'action importante et principale d'une application ou d'un module complémentaire Chat. |
FILLED_TONAL |
Un bouton tonal rempli est une alternative intermédiaire entre les boutons remplis et ceux avec un contour. Ils sont utiles dans les contextes où un bouton de priorité inférieure nécessite un peu plus d'emphase qu'un bouton de contour. |
BORDERLESS |
Un bouton ne doit pas avoir de conteneur invisible dans son état par défaut. Il est souvent utilisé pour les actions de priorité la plus basse, en particulier lorsque plusieurs options sont présentées. |
ButtonList
Liste de boutons disposés horizontalement. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter un bouton.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
buttons[] |
Tableau de boutons. |
Fiche
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 multimédias enrichis tels que des images. Utilisez des cartes pour présenter des informations détaillées, collecter des informations auprès des utilisateurs et les guider vers l'étape suivante.
Concevez et prévisualisez des cartes avec le générateur de cartes.
Ouvrir le générateur de cartesPour savoir comment créer des cartes, consultez la documentation suivante :
- Pour les applications Google Chat, consultez Concevoir les composants d'une fiche ou d'une boîte de dialogue.
- Pour les modules complémentaires Google Workspace, consultez Interfaces basées sur des fiches.
Remarque : Vous pouvez ajouter jusqu'à 100 widgets par fiche. Tous les widgets au-delà de cette limite sont ignorés. Cette limite s'applique à la fois aux messages de carte et aux boîtes de dialogue dans les applications Google Chat, ainsi qu'aux cartes dans les modules complémentaires Google Workspace.
Exemple : Message de fiche pour une application Google Chat
Pour créer l'exemple de message de carte dans Google Chat, utilisez le 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"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Champs | |
---|---|
header |
En-tête de la carte. Un en-tête contient généralement une image et un titre. Les en-têtes s'affichent toujours en haut d'une fiche. |
sections[] |
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. Pour obtenir un exemple dans les applications Google Chat, consultez Définir une section d'une fiche. |
section_divider_style |
Style du séparateur entre l'en-tête, les sections et le pied de page. |
card_actions[] |
Actions de la fiche. Les actions sont ajoutées au menu de la barre d'outils de la fiche.
Par exemple, le JSON suivant crée un menu d'actions de carte avec les options
|
name |
Nom de la carte. Utilisé comme identifiant de carte dans la navigation par carte.
|
fixed_footer |
Pied de page fixe affiché en bas de cette fiche. Si vous définissez
|
display_style |
Dans les modules complémentaires Google Workspace, définit les propriétés d'affichage de
|
peek_card_header |
Lors de l'affichage de contenu contextuel, l'en-tête de la fiche d'aperçu sert d'espace réservé pour que l'utilisateur puisse naviguer entre les fiches de la page d'accueil et les fiches contextuelles.
|
CardAction
Une action de fiche est l'action associée à la fiche. Par exemple, une fiche de facture peut inclure des actions telles que supprimer la facture, envoyer la facture par e-mail ou ouvrir la facture dans un navigateur.
Disponible pour les modules complémentaires Google Workspace, mais pas pour les applications Google Chat.
Champs | |
---|---|
action_label |
Libellé qui s'affiche en tant qu'élément du menu d'actions. |
on_click |
Action |
CardHeader
Représente un en-tête de carte. 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.
Champs | |
---|---|
title |
Obligatoire. Titre de l'en-tête de la carte. 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 |
Sous-titre de l'en-tête de la fiche. Si elle est spécifiée, elle s'affiche sur sa propre ligne sous |
image_type |
Forme utilisée pour recadrer l'image.
|
image_url |
URL HTTPS de l'image dans l'en-tête de la carte. |
image_alt_text |
Texte alternatif de cette image utilisé pour l'accessibilité. |
DisplayStyle
Dans les modules complémentaires Google Workspace, détermine comment une fiche est affichée.
Disponible pour les modules complémentaires Google Workspace, mais pas pour les applications Google Chat.
Enums | |
---|---|
DISPLAY_STYLE_UNSPECIFIED |
Ne pas utiliser. Non spécifié. |
PEEK |
L'en-tête de la fiche apparaît en bas de la barre latérale, recouvrant partiellement la fiche supérieure actuelle de la pile. Si vous cliquez sur l'en-tête, la fiche s'affiche dans la pile de fiches. Si la carte n'a pas d'en-tête, un en-tête généré est utilisé à la place. |
REPLACE |
Valeur par défaut. La fiche s'affiche en remplaçant la vue de la fiche supérieure de la pile. |
DividerStyle
Style du séparateur d'une carte. Actuellement utilisé uniquement pour les séparateurs entre les sections de cartes.
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. Afficher un séparateur plein. |
NO_DIVIDER |
Si elle 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 à l'absence de séparateur. |
NestedWidget
CarouselCard
. Champs | |
---|---|
Champ d'union
|
|
text_paragraph |
Widget de paragraphe de texte. |
button_list |
Widget de liste de boutons. |
image |
Un widget d'image. |
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.
Champs | |
---|---|
header |
Texte qui s'affiche en haut d'une section. Compatible avec le texte mis en forme en 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[] |
Tous les widgets de la section. Doit contenir au moins un widget. |
collapsible |
Indique si cette section peut être réduite. Les sections réductibles masquent certains 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 à nouveau masquer les widgets en cliquant sur Afficher moins. Pour déterminer quels widgets sont masqués, spécifiez |
uncollapsible_widgets_count |
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 |
collapse_control |
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é. |
Carrousel
Par exemple, voici une représentation JSON d'un carrousel contenant trois widgets de paragraphe de texte.
{
"carouselCards": [
{
"widgets": [
{
"textParagraph": {
"text": "First text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Second text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Third text paragraph in carousel",
}
}
]
}
]
}
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Champs | |
---|---|
carousel_cards[] |
Liste des cartes incluses dans le carrousel. |
CarouselCard
Champs | |
---|---|
widgets[] |
Liste des widgets affichés dans la fiche du carrousel. Les widgets s'affichent dans l'ordre dans lequel ils sont spécifiés. |
footer_widgets[] |
Liste des widgets affichés en bas de la fiche carrousel. Les widgets s'affichent dans l'ordre dans lequel ils sont spécifiés. |
Puce
Un 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.
Champs | |
---|---|
icon |
Image de l'icône. Si les deux paramètres |
label |
Texte affiché dans le chip. |
on_click |
Facultatif. Action à effectuer lorsqu'un utilisateur clique sur le chip, comme l'ouverture d'un lien hypertexte ou l'exécution d'une fonction personnalisée. |
enabled |
Indique si le chip est actif et répond aux actions de l'utilisateur. La valeur par défaut est |
disabled |
Indique si le chip est inactif et ignore les actions de l'utilisateur. La valeur par défaut est |
alt_text |
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". |
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.
Champs | |
---|---|
layout |
Mise en page de la liste de chips spécifiée. |
chips[] |
Tableau de chips. |
Mise en page
Mise en page de la 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 si l'espace horizontal est insuffisant. |
HORIZONTAL_SCROLLABLE |
Les chips défilent horizontalement s'ils ne tiennent pas dans l'espace disponible. |
CollapseControl
Représente un contrôle de développement et de réduction.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
horizontal_alignment |
Alignement horizontal du bouton de développement et de réduction. |
expand_button |
Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs expand_button et collapse_button doivent être définis. Si vous ne définissez qu'un seul champ, il ne sera pas pris en compte. Si ce champ n'est pas défini, le bouton par défaut est utilisé. |
collapse_button |
Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs expand_button et collapse_button doivent être définis. Si vous ne définissez qu'un seul champ, il ne sera pas pris en compte. Si ce champ n'est pas défini, le bouton par défaut est utilisé. |
Colonnes
Le widget Columns
affiche jusqu'à deux colonnes dans une fiche ou une boîte de dialogue. Vous pouvez ajouter des widgets à chaque colonne. Ils 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. Étant donné que 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 passe sous la première :
- Sur le Web, la deuxième colonne s'affiche sur plusieurs lignes si la largeur de l'écran est inférieure ou égale à 480 pixels.
- Sur les appareils iOS, la deuxième colonne s'affiche sur plusieurs lignes si la largeur de l'écran est inférieure ou égale à 300 points.
- Sur les appareils Android, la deuxième colonne s'affiche sur plusieurs lignes si la largeur de l'écran est inférieure ou égale à 320 dp.
Pour inclure plus de deux colonnes ou utiliser des lignes, utilisez le widget
.Grid
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace. Voici les UI de modules complémentaires qui sont compatibles avec les colonnes :
- Boîte de dialogue affichée lorsque les utilisateurs ouvrent le module complémentaire à partir d'un brouillon d'e-mail.
- Boîte de dialogue affichée lorsque les utilisateurs ouvrent le module complémentaire à partir du menu Ajouter une pièce jointe dans un événement Google Agenda.
Champs | |
---|---|
column_items[] |
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
Champs | |
---|---|
horizontal_size_style |
Indique comment une colonne remplit la largeur de la carte. |
horizontal_alignment |
Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne. |
vertical_alignment |
Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne. |
widgets[] |
Tableau de widgets inclus dans une colonne. Les widgets s'affichent dans l'ordre dans lequel ils sont spécifiés. |
HorizontalSizeStyle
Indique comment une colonne remplit la largeur de la carte. La largeur de chaque colonne dépend à la fois de HorizontalSizeStyle
et de la largeur des widgets de la colonne.
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 occupe l'espace disponible, jusqu'à 70 % de la largeur de la fiche. Si les deux colonnes sont définies sur FILL_AVAILABLE_SPACE , chacune occupe 50 % de l'espace. |
FILL_MINIMUM_SPACE |
La colonne occupe le moins d'espace possible, sans dépasser 30 % de la largeur de la fiche. |
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 |
Aligner 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
Champs | |
---|---|
Champ d'union
|
|
text_paragraph |
Widget |
image |
Widget |
decorated_text |
Widget |
button_list |
Widget |
text_input |
Widget |
selection_input |
Widget |
date_time_picker |
Widget |
chip_list |
Widget |
DateTimePicker
Permet aux utilisateurs de saisir une date, une heure ou les deux. 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 choisir 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 incorrectes, le sélecteur affiche une erreur qui les invite à saisir les informations correctement.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
name |
Nom par lequel le Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire. |
label |
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 |
type |
Indique si le widget permet de saisir une date, une heure ou les deux. |
value_ms_epoch |
Valeur par défaut affichée dans le widget, en millisecondes depuis l'époque Unix. Spécifiez la valeur en fonction du type de sélecteur (
|
timezone_offset_date |
Nombre représentant le décalage horaire par rapport à UTC, en minutes. Si cette option est définie, |
on_change_action |
Déclenché lorsque l'utilisateur clique sur Enregistrer ou Effacer dans l'interface |
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. |
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.
Champs | |
---|---|
icon |
Obsolète, utilisez |
start_icon |
Icône affichée devant le texte. |
start_icon_vertical_alignment |
Facultatif. Alignement vertical de l'icône de début. Si ce paramètre n'est pas défini, l'icône sera centrée verticalement.
|
top_label |
Texte qui s'affiche au-dessus de |
top_label_text |
|
text |
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. |
content_text |
|
wrap_text |
Paramètre de retour à la ligne. Si la valeur est S'applique uniquement à |
bottom_label |
Texte qui s'affiche sous |
bottom_label_text |
|
on_click |
Cette action est déclenchée lorsque les utilisateurs cliquent sur |
Champ d'union control . Bouton, bouton bascule, case à cocher ou image qui s'affiche à droite du texte dans le widget decoratedText . La control ne peut être qu'un des éléments suivants : |
|
button |
Bouton sur lequel un utilisateur peut cliquer pour déclencher une action. |
switch_control |
Widget de bouton bascule sur lequel un utilisateur peut cliquer pour modifier son état et déclencher une action. |
end_icon |
Icône affichée après le texte. Compatible avec les icônes intégrées et personnalisées. |
SwitchControl
Il s'agit d'un bouton bascule ou d'une case à cocher dans un widget decoratedText
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Compatible uniquement avec le widget decoratedText
.
Champs | |
---|---|
name |
Nom par lequel le widget de bouton bascule est identifié 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. |
value |
Valeur saisie par un utilisateur, renvoyée dans le cadre d'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. |
selected |
Lorsque |
on_change_action |
Action à effectuer lorsque l'état du commutateur est modifié, par exemple la fonction à exécuter. |
control_type |
Comment le bouton bascule s'affiche dans l'interface utilisateur.
|
ControlType
Comment le bouton bascule s'affiche dans l'interface utilisateur.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
SWITCH |
Un bouton bascule. |
CHECKBOX |
Obsolète, utilisez CHECK_BOX . |
CHECK_BOX |
Case à cocher. |
Séparateur
Ce type ne comporte aucun champ.
Affiche une ligne horizontale pour séparer les widgets. 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 plus que du texte ou des images, utilisez
. Pour obtenir un exemple dans les applications Google Chat, consultez Afficher une grille avec une collection d'éléments.Columns
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 2 colonnes comporte 5 lignes. Une grille comportant 11 éléments et 2 colonnes comporte 6 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"
}
}
}
Champs | |
---|---|
title |
Texte affiché dans l'en-tête de la grille. |
items[] |
Éléments à afficher dans la grille. |
border_style |
Style de bordure à appliquer à chaque élément de la grille. |
column_count |
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'endroit où la grille est affichée (dans une boîte de dialogue ou un emplacement associé). |
on_click |
Ce rappel est réutilisé par chaque élément de grille individuel, mais avec l'identifiant et l'index de l'élément dans la liste des éléments ajoutés aux paramètres du rappel. |
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.
Champs | |
---|---|
id |
Identifiant spécifié par l'utilisateur pour cet élément de grille. Cet identifiant est renvoyé dans les paramètres de rappel |
image |
Image affichée dans l'élément de grille. |
title |
Titre de l'élément de grille. |
subtitle |
Sous-titre de l'élément de grille. |
layout |
Mise en page à utiliser pour l'élément de grille. |
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 s'affichent sous l'image de l'élément de grille. |
TEXT_ABOVE |
Le titre et le sous-titre s'affichent au-dessus de l'image de l'élément de grille. |
Icône
Icône affichée dans un widget sur une fiche. Pour obtenir un exemple dans les applications Google Chat, consultez Ajouter une icône.
Compatible avec les icônes intégrées et personnalisées.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
alt_text |
Facultatif. Description de l'icône utilisée pour l'accessibilité. Si elle n'est pas spécifiée, la valeur par défaut Si l'icône est définie dans un |
image_type |
Style de recadrage appliqué à l'image. Dans certains cas, l'application d'un recadrage |
Champ d'union icons . Icône affichée dans le widget de la fiche. icons ne peut être qu'un des éléments suivants : |
|
known_icon |
Affichez l'une des icônes intégrées fournies par Google Workspace. Par exemple, pour afficher une icône d'avion, spécifiez Pour obtenir la liste complète des icônes compatibles, consultez la page Icônes intégrées. |
icon_url |
Affichez une icône personnalisée hébergée sur une URL HTTPS. Exemple :
Les types de fichiers acceptés sont |
material_icon |
Affichez l'une des icônes Material Design de Google. Par exemple, pour afficher une icône de case à cocher, utilisez
|
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.
Champs | |
---|---|
image_url |
URL HTTPS qui héberge l'image. Exemple :
|
on_click |
Lorsqu'un utilisateur clique sur l'image, cette action est déclenchée. |
alt_text |
Texte alternatif de cette image utilisé pour l'accessibilité. |
ImageComponent
Représente une image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
image_uri |
URL de l'image. |
alt_text |
Libellé d'accessibilité de l'image. |
crop_style |
Style de recadrage à appliquer à l'image. |
border_style |
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
}
Champs | |
---|---|
type |
Type de recadrage. |
aspect_ratio |
Format à utiliser si le type de recadrage est Par exemple, voici comment appliquer un format 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. |
MaterialIcon
Une icône Google Material, qui inclut plus de 2 500 options.
Par exemple, pour afficher une icône de case à cocher avec un poids et une note personnalisés, saisissez ce qui suit :
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Champs | |
---|---|
name |
Nom de l'icône défini dans Google Material Icons, par exemple |
fill |
Indique si l'icône s'affiche en tant qu'icône pleine. La valeur par défaut est Faux (false). Pour prévisualiser différents paramètres d'icônes, accédez à Google Font Icons et ajustez les paramètres sous Personnaliser. |
weight |
Épaisseur du trait de l'icône. Choisissez parmi {100, 200, 300, 400, 500, 600, 700}. Si elle est absente, la valeur par défaut est 400. Si une autre valeur est spécifiée, la valeur par défaut est utilisée. Pour prévisualiser différents paramètres d'icônes, accédez à Google Font Icons et ajustez les paramètres sous Personnaliser. |
grade |
L'épaisseur et le niveau ont une incidence sur l'épaisseur d'un symbole. Les ajustements du niveau sont plus précis que ceux du poids et ont un impact mineur sur la taille du symbole. Choisissez parmi {-25, 0, 200}. Si elle est absente, la valeur par défaut est 0. Si une autre valeur est spécifiée, la valeur par défaut est utilisée. Pour prévisualiser différents paramètres d'icônes, accédez à Google Font Icons et ajustez les paramètres sous Personnaliser. |
OnClick
Représente la manière de répondre lorsque les utilisateurs cliquent sur un élément interactif d'une fiche, tel qu'un bouton.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
Champ d'union
|
|
action |
Si une action est spécifiée, elle est déclenchée par ce |
open_link |
Si cette |
open_dynamic_link_action |
Un module complémentaire déclenche cette action lorsqu'il doit ouvrir un lien. Cela diffère de
|
card |
Une nouvelle carte est ajoutée à la pile de cartes après un clic, si spécifié.
|
overflow_menu |
Si elle est spécifiée, cette |
OpenLink
Représente un événement onClick
qui ouvre un lien hypertexte.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
url |
URL à ouvrir. |
open_as |
Ouvrir un lien
|
on_close |
Que le client oublie un lien après l'avoir ouvert ou qu'il l'observe jusqu'à ce que la fenêtre se ferme.
|
OnClose
Ce que fait le client lorsqu'un lien ouvert par une action OnClick
est fermé.
L'implémentation dépend des capacités de la plate-forme cliente. Par exemple, un navigateur Web peut ouvrir un lien dans une fenêtre pop-up avec un gestionnaire OnClose
.
Si les gestionnaires OnOpen
et OnClose
sont définis et que la plate-forme cliente ne peut pas prendre en charge les deux valeurs, OnClose
est prioritaire.
Disponible pour les modules complémentaires Google Workspace, mais pas pour les applications Google Chat.
Enums | |
---|---|
NOTHING |
Valeur par défaut. La carte ne se recharge pas et rien ne se passe. |
RELOAD |
Recharge la carte après la fermeture de la fenêtre enfant. Si elle est utilisée conjointement avec |
OpenAs
Lorsqu'une action OnClick
ouvre un lien, le client peut l'ouvrir en tant que fenêtre en plein écran (s'il s'agit du frame utilisé par le client) ou en tant qu'overlay (tel qu'un pop-up). L'implémentation dépend des capacités de la plate-forme cliente. La valeur sélectionnée peut être ignorée si le client ne la prend pas en charge. FULL_SIZE
est compatible avec tous les clients.
Disponible pour les modules complémentaires Google Workspace, mais pas pour les applications Google Chat.
Enums | |
---|---|
FULL_SIZE |
Le lien s'ouvre dans une fenêtre en plein écran (si tel est le cadre utilisé par le client). |
OVERLAY |
Le lien s'ouvre sous forme de superposition, comme un pop-up. |
OverflowMenu
Widget qui présente un menu pop-up avec une ou plusieurs actions que les utilisateurs peuvent appeler. Par exemple, en affichant des actions non principales dans une fiche. Vous pouvez utiliser ce widget lorsque les actions ne tiennent pas dans l'espace disponible. Pour l'utiliser, spécifiez ce widget dans l'action OnClick
des widgets compatibles. Par exemple, dans un Button
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
items[] |
Obligatoire. Liste des options de menu. |
OverflowMenuItem
Option que les utilisateurs peuvent appeler dans un menu à développer.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
start_icon |
Icône affichée devant le texte. |
text |
Obligatoire. Texte qui identifie ou décrit l'article aux utilisateurs. |
on_click |
Obligatoire. Action appelée lorsqu'une option de menu est sélectionnée. Ce |
disabled |
Indique si l'option de menu est désactivée. Valeur par défaut : "false". |
SelectionInput
Widget qui crée un ou plusieurs éléments d'interface utilisateur que les utilisateurs peuvent sélectionner. Compatible avec la validation de l'envoi de formulaires pour les menus dropdown
et multiselect
uniquement. 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 pouvant ê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 de 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 abstraites ou non définies auprès des utilisateurs, utilisez le widget TextInput
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
name |
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 |
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'une demande d'intervention dans un menu déroulant, le libellé peut être "Urgence" ou "Sélectionner l'urgence". |
type |
Type d'éléments affichés aux utilisateurs dans un widget |
items[] |
Tableau d'éléments sélectionnables. Par exemple, un tableau de cases d'option ou de cases à cocher. Jusqu'à 100 éléments sont acceptés. |
on_change_action |
Si cette option est spécifiée, le formulaire est envoyé lorsque la sélection change. Si vous ne le faites pas, vous devez spécifier un bouton distinct pour envoyer le formulaire. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire. |
multi_select_max_selected_items |
Nombre maximal d'éléments qu'un utilisateur peut sélectionner dans les menus à sélection multiple. La valeur minimale est de 1 article. Si aucune valeur n'est spécifiée, la valeur par défaut est de trois éléments. |
multi_select_min_query_length |
Pour les menus à sélection multiple, il s'agit du nombre de caractères que l'utilisateur saisit avant que le menu ne renvoie des éléments de sélection suggérés. Si elle n'est pas définie, le menu à sélection multiple utilise les valeurs par défaut suivantes :
|
Champ d'union
|
|
external_data_source |
Une source de données externe, telle qu'une base de données relationnelle. |
platform_data_source |
Source de données provenant de Google Workspace. |
PlatformDataSource
Pour un widget
qui utilise un menu à sélection multiple, une source de données provenant de Google Workspace. Permet de remplir les éléments d'un menu à sélection multiple.SelectionInput
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Champs | |
---|---|
Champ d'union data_source . Source de données. data_source ne peut être qu'un des éléments suivants : |
|
common_data_source |
Source de données partagée par toutes les applications Google Workspace, comme les utilisateurs d'une organisation Google Workspace. |
host_app_data_source |
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. |
CommonDataSource
Source de données partagée par toutes les applications Google Workspace.
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Enums | |
---|---|
UNKNOWN |
Valeur par défaut. Ne pas utiliser. |
USER |
Utilisateurs Google Workspace. L'utilisateur ne peut afficher et sélectionner que les utilisateurs de son organisation Google Workspace. |
SelectionItem
Élément que les utilisateurs peuvent sélectionner dans une entrée de sélection, comme une case à cocher ou un bouton bascule. Jusqu'à 100 éléments sont acceptés.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
text |
Texte qui identifie ou décrit l'article aux utilisateurs. |
value |
Valeur associée à cet élément. Le client doit l'utiliser comme valeur d'entrée de formulaire. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir des données de formulaire. |
selected |
Indique si l'élément est sélectionné par défaut. Si la saisie de sélection n'accepte qu'une seule valeur (comme pour les boutons radio ou un menu déroulant), ne définissez ce champ que pour un seul élément. |
bottom_text |
Pour les menus à sélection multiple, il s'agit d'une description textuelle ou d'un libellé affiché sous le champ |
Champ d'union start_icon . Pour les menus à sélection multiple, il s'agit de l'URL de l'icône affichée à côté du champ text de l'élément. Compatible avec les fichiers PNG et JPEG. Doit être une URL HTTPS . Par exemple, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png . start_icon ne peut être qu'un des éléments suivants : |
|
start_icon_uri |
|
SelectionType
Format des éléments que les utilisateurs peuvent sélectionner. Différentes options sont compatibles avec différents types d'interactions. Par exemple, les utilisateurs peuvent cocher plusieurs cases, mais ne peuvent sélectionner qu'un seul élément dans un menu déroulant.
Chaque entrée de sélection est compatible avec 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 |
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 commutateurs. |
DROPDOWN |
Menu déroulant. Les utilisateurs peuvent sélectionner un élément dans le menu. |
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 remplir les éléments à l'aide d'un tableau statique d'objets Pour les applications Google Chat, vous pouvez également remplir des éléments à l'aide d'une source de données dynamique et suggérer automatiquement des éléments lorsque 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 remplir dynamiquement les éléments d'un menu à sélection multiple, utilisez l'un des types de sources de données suivants :
Pour obtenir des exemples d'implémentation de menus à sélection multiple pour les applications Chat, consultez Ajouter un menu à sélection multiple.
|
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. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir javascript
et d'autres java script
. Les suggestions JavaScript
peuvent 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.
Champs | |
---|---|
items[] |
Liste de suggestions utilisées pour les recommandations de saisie semi-automatique dans les champs de saisie de texte. |
SuggestionItem
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.
Champs | |
---|---|
Champ d'union
|
|
text |
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. |
TextInput
Champ dans lequel les utilisateurs peuvent saisir du texte. Compatible avec 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 de 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 abstraites ou non définies auprès des utilisateurs, utilisez une entrée 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.
Champs | |
---|---|
name |
Nom par lequel l'entrée de texte est identifiée 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 |
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 d'une personne, mais que vous avez spécifiquement besoin de son nom de famille, écrivez Obligatoire si |
hint_text |
Texte qui s'affiche sous le champ de saisie de texte et qui est destiné à aider les utilisateurs en les invitant à saisir une certaine valeur. Ce texte est toujours visible. Obligatoire si |
value |
Valeur saisie par un utilisateur, renvoyée dans le cadre d'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. |
type |
Apparence d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, si le champ est sur une ou plusieurs lignes. |
on_change_action |
Que faire lorsqu'une modification se produit dans le champ de saisie de texte. Par exemple, un utilisateur ajoute du texte dans le champ ou en supprime. Par exemple, vous pouvez exécuter une fonction personnalisée ou ouvrir une boîte de dialogue dans Google Chat. |
initial_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 Les valeurs suggérées aident les utilisateurs à saisir des valeurs que votre application peut interpréter. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir Lorsqu'il est spécifié,
|
auto_complete_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 Si elle est spécifiée, l'application effectue l'action indiquée ici, comme l'exécution d'une fonction personnalisée.
|
validation |
Spécifiez la validation du format d'entrée nécessaire pour ce champ de texte.
|
placeholder_text |
Texte qui s'affiche dans le champ de saisie de texte lorsqu'il est vide. Utilisez ce texte pour inviter les utilisateurs à saisir une valeur. Par exemple,
|
Type
Apparence d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, s'il s'agit d'un champ de saisie d'une ou de 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 |
La hauteur du champ de saisie de texte est fixe et correspond à plusieurs lignes. |
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.
Champs | |
---|---|
text |
Texte affiché dans le widget. |
max_lines |
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. |
text_syntax |
Syntaxe du texte. Si ce paramètre n'est pas défini, le texte est affiché au format HTML.
|
TextSyntax
Syntaxe à utiliser pour mettre en forme le texte.
Disponible pour les applications Google Chat, mais pas pour les modules complémentaires Google Workspace.
Enums | |
---|---|
TEXT_SYNTAX_UNSPECIFIED |
Si aucune valeur n'est spécifiée, le texte est affiché au format HTML. |
HTML |
Le texte est affiché au format HTML. Il s'agit de la valeur par défaut. |
MARKDOWN |
Le texte est rendu au format Markdown. |
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.
Champs | |
---|---|
character_limit |
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 est ignorée pour les autres widgets.
|
input_type |
Spécifiez le type des widgets d'entrée.
|
InputType
Type du widget d'entrée.
Enums | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Type non spécifié. Ne pas utiliser. |
TEXT |
Texte normal qui accepte tous les caractères. |
INTEGER |
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. |
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.
Champs | |
---|---|
horizontal_alignment |
Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne. |
Champ d'union data . Un widget ne peut contenir qu'un seul des éléments suivants. Vous pouvez utiliser plusieurs champs de widget pour afficher plus d'éléments. data ne peut être qu'un des éléments suivants : |
|
text_paragraph |
Affiche un paragraphe de texte. Compatible avec le texte mis en forme en 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 :
|
image |
Affiche une image. Par exemple, le code JSON suivant crée une image avec un texte alternatif :
|
decorated_text |
Affiche un élément de texte décoré. Par exemple, le JSON suivant crée un widget de texte enrichi affichant une adresse e-mail :
|
button_list |
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 :
|
text_input |
Affiche une zone de texte dans laquelle les utilisateurs peuvent saisir du texte. Par exemple, le code JSON suivant crée une entrée de texte pour une adresse e-mail :
Voici un autre exemple : le code JSON suivant crée une entrée de texte pour un langage de programmation avec des suggestions statiques :
|
selection_input |
Affiche un contrôle 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 permettant aux utilisateurs de choisir une taille :
|
date_time_picker |
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 :
|
divider |
Affiche une ligne horizontale de séparation entre les widgets. Par exemple, le code JSON suivant crée un séparateur :
|
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 les limites supérieures du nombre d'éléments divisé par le nombre de colonnes. Une grille de 10 éléments et 2 colonnes comporte 5 lignes. Une grille comportant 11 éléments et 2 colonnes comporte 6 lignes.
Par exemple, le code JSON suivant crée une grille à deux colonnes avec un seul élément :
|
columns |
Affiche jusqu'à deux colonnes. Pour inclure plus de deux colonnes ou utiliser des lignes, utilisez le widget Par exemple, le code JSON suivant crée deux colonnes contenant chacune des paragraphes de texte :
|
carousel |
Un carrousel contient une collection de widgets imbriqués. Par exemple, voici la représentation JSON d'un carrousel contenant deux paragraphes de texte.
|
chip_list |
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 :
|
HorizontalAlignment
Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.
Disponible pour les applications Google Chat, mais pas 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ébut de la colonne. Pour les mises en page de gauche à droite, l'alignement se fait à gauche. Pour les mises en page de droite à gauche, l'alignement se fait à droite. |
CENTER |
Aligne les widgets au centre de la colonne. |
END |
Aligner 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. |
ImageType
Forme utilisée pour recadrer l'image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
SQUARE |
Valeur par défaut. Applique un masque carré à l'image. Par exemple, une image 4x3 devient une image 3x3. |
CIRCLE |
Applique un masque circulaire à l'image. Par exemple, une image au format 4:3 devient un cercle de diamètre 3. |
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 sur la position du milieu. |
BOTTOM |
Alignement en bas. |