Package google.apps.card.v1

Index

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

string

Fonction personnalisée à invoquer lorsque l'utilisateur clique sur l'élément parent ou est activé d'une autre manière.

Pour obtenir un exemple d'utilisation, consultez la section Lire les données de formulaire.
parameters[]

ActionParameter

Liste des paramètres d'action.
load_indicator

LoadIndicator

Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action.
persist_values

bool

Indique si les valeurs du formulaire persistent après l'action. La valeur par défaut est false.

Si la valeur est true, les valeurs du formulaire restent après le déclenchement de l'action. Pour permettre à l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator sur NONE. Pour les messages de la fiche dans les applications Chat, vous devez également définir la ResponseType de l'action sur UPDATE_MESSAGE et utiliser la même card_id de la fiche contenant l'action.

Si la valeur est false, les valeurs du formulaire sont effacées lorsque l'action est déclenchée. Pour empêcher l'utilisateur d'apporter des modifications pendant le traitement de l'action, définissez LoadIndicator sur SPINNER.
interaction

Interaction

Facultatif. Obligatoire à l'ouverture d'une boîte de dialogue.

Que faire en réponse à une interaction avec un utilisateur (par exemple, un utilisateur qui 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) comme d'habitude.

En spécifiant un interaction, l'application peut répondre de manière interactive particulière. Par exemple, en définissant interaction sur OPEN_DIALOG, l'application peut ouvrir une boîte de dialogue. Si ce paramètre est spécifié, aucun indicateur de chargement ne s'affiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

Disponible pour les applications Google Chat et indisponible pour les modules complémentaires Google Workspace.
required_widgets[]

string

Facultatif. Remplissez cette liste avec les noms des widgets dont cette action a besoin pour un envoi valide.

Si les widgets répertoriés ici n'ont pas de valeur lorsque cette action est appelée, l'envoi du formulaire est annulé.

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

bool

Facultatif. Si cette valeur est "true", tous les widgets sont considérés comme obligatoires par cette action.

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

ActionParameter

Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. Prenons l'exemple de trois boutons de mise en attente: répéter maintenant, répéter un jour ou répéter la semaine suivante. Vous pouvez utiliser action method = snooze() en transmettant le type et la durée de la mise en pause 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

string

Nom du paramètre pour le script d'action.
value

string

Valeur du paramètre.

Interaction

Facultatif. Obligatoire à 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) comme d'habitude.

En spécifiant un interaction, l'application peut répondre de manière interactive particulière. Par exemple, en définissant interaction sur OPEN_DIALOG, l'application peut ouvrir une boîte de dialogue.

Si ce paramètre est spécifié, aucun indicateur de chargement ne s'affiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

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

Enums
INTERACTION_UNSPECIFIED Valeur par défaut. action s'exécute normalement.
OPEN_DIALOG

Ouvre une boîte de dialogue, une interface fenêtrée sous forme de fiches qui permet aux applications Chat d'interagir avec les utilisateurs.

Uniquement compatible avec les applications Chat en réponse aux clics sur les boutons des messages sous forme de fiche. Si elle est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien ne s'affiche dans le client.

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

LoadIndicator

Spécifie l'indicateur de chargement que l'action affiche lors de l'appel de l'action.

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

Enums
SPINNER Affiche une icône 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 carte ou d'un widget, y compris le type et la couleur de bordure.

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

Champs
type

BorderType

Type de bordure.
stroke_color

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 flottant 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, l'exemple suivant définit la couleur rouge à son intensité maximale :

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

Le champ alpha n'est pas disponible pour la couleur du trait. Si elle est spécifiée, ce champ est ignoré.
corner_radius

int32

Rayon de l'angle 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 Valeur par défaut. Aucune bordure.
STROKE Contour.

Bouton

Un texte, une icône ou un bouton de texte et d'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 Image (et non un ImageComponent) et définissez une action onClick.

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

Champs
text

string

Texte affiché dans le bouton.
icon

Icon

Icône affichée à l'intérieur du bouton. Si icon et text sont tous deux définis, l'icône s'affiche avant le texte.
color

Color

Facultatif. Couleur du bouton. S'il est défini, le bouton type est défini sur FILLED, et la couleur des champs text et icon est définie sur une couleur contrastée pour une meilleure lisibilité. Par exemple, si la couleur du bouton est définie sur bleu, le texte ou les icônes du bouton sont définis sur blanc.

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

Par exemple, le code suivant 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 bouton. Si elle est spécifiée, ce champ est ignoré.
on_click

OnClick

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

bool

Si la valeur est true, le bouton s'affiche dans un état inactif et ne répond pas aux actions de l'utilisateur.
alt_text

string

Texte de substitution utilisé pour l'accessibilité.

Définissez un texte descriptif qui indique aux utilisateurs la fonction du bouton. Par exemple, si un bouton permet d'ouvrir un lien hypertexte, vous pouvez écrire : "Ouvre un nouvel onglet de navigateur et accède à la documentation Google Chat pour les développeurs à l'adresse https://developers.google.com/workspace/chat".
type

Type

Facultatif. Type de bouton. Si cette valeur n'est pas définie, le type de bouton est défini par défaut sur OUTLINED. Si le champ color est défini, le type de bouton est défini sur FILLED de force, et toute valeur définie pour ce champ est ignorée.

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

Type

Facultatif. Type d'un bouton. Si le champ color est défini, la valeur de type est définie de force sur FILLED.

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

Enums
TYPE_UNSPECIFIED Ne pas utiliser. Non spécifié.
OUTLINED Les boutons avec contours sont des boutons à intensité moyenne. Ils contiennent généralement des actions importantes, mais qui ne sont pas l'action principale dans une application Chat ou un module complémentaire.
FILLED Un bouton plein est un conteneur de couleur unie. Elle a l'impact le plus visuel et est recommandée pour l'action principale et importante dans une application ou un module complémentaire Chat.
FILLED_TONAL Un bouton tonal rempli est un compromis entre les boutons remplis et ceux avec 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 n'a pas de conteneur invisible dans son état par défaut. Il est souvent utilisé pour les actions les moins prioritaires, en particulier lors de la présentation de plusieurs options.

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[]

Button

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 interactifs d'interface utilisateur (comme des boutons) et des contenus rich media (comme des images). Utilisez des fiches pour présenter des informations détaillées, collecter des informations auprès des utilisateurs et les guider vers la prochaine étape.

Créez et prévisualisez des fiches avec Card Builder.

Ouvrir l'outil de création de cartes

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

Exemple : Message de fiche pour une application Google Chat

Exemple de fiche de contact

Pour créer l'exemple de message de carte 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Champs
header

CardHeader

En-tête de la fiche. Un en-tête contient généralement une image de début et un titre. Les en-têtes apparaissent toujours en haut des fiches.
sections[]

Section

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

DividerStyle

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

CardAction

Actions de la fiche. Les actions sont ajoutées au menu de la barre d'outils de la fiche.

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

Par exemple, le code JSON suivant construit un menu d'actions de carte avec les options Settings et Send Feedback:

"card_actions": [
  {
    "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 carte dans la navigation par carte.

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

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

CardHeader

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

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

CardAction

Une action est associée à la fiche. Par exemple, une fiche de facturation 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 indisponible pour les applications Google Chat.

Champs
action_label

string

Libellé affiché en tant qu'élément de menu d'action.
on_click

OnClick

Action onClick pour cet élément d'action.

CardFixedFooter

Pied de page persistant (adhésif) qui s'affiche en bas de la fiche.

Si vous définissez fixedFooter sans spécifier primaryButton ou secondaryButton, une erreur se produit.

Pour les applications Chat, vous pouvez utiliser des pieds de page fixes dans les boîtes de dialogue, mais pas dans les messages de carte. 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.

Champs
primary_button

Button

Bouton principal du pied de page fixe. Le bouton doit être de type texte, et les couleurs et le texte doivent être définis.
secondary_button

Button

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

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.

Champs
title

string

Obligatoire. Titre de l'en-tête de la fiche. La hauteur de l'en-tête est 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. Si spécifié, apparaît sur sa propre ligne sous title.
image_type

ImageType

Forme utilisée pour recadrer l'image.

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

string

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

string

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

DisplayStyle

Dans les modules complémentaires Google Workspace, détermine comment une fiche s'affiche.

Disponible pour les modules complémentaires Google Workspace et indisponible 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, recouvrant partiellement la fiche supérieure actuelle de la pile. Cliquez sur l'en-tête pour faire apparaître la carte dans 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.

DividerStyle

Style du séparateur d'une fiche. Actuellement, il n'est utilisé que 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. Affichez 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 équivaut à ne pas ajouter de séparateur du tout.

Section

Une section contient une collection de widgets qui sont 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

string

Texte affiché en haut d'une section. Accepte le texte au format HTML simple. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.
widgets[]

Widget

Tous les widgets de la section Doit contenir au moins un widget.
collapsible

bool

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 les widgets masqués, spécifiez uncollapsibleWidgetsCount.
uncollapsible_widgets_count

int32

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

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 peut être réduite. Si ce champ n'est pas défini, le bouton par défaut est utilisé. Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Puce électronique

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 non disponible pour les modules complémentaires Google Workspace.

Champs
icon

Icon

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

string

Texte affiché dans le chip.
on_click

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)

bool

Indique si le chip est actif et répond aux actions de l'utilisateur. La valeur par défaut est true. Obsolète. Utilisez disabled à la place.
disabled

bool

Indique si la puce est inactive et ignore les actions de l'utilisateur. La valeur par défaut est false.
alt_text

string

Texte de substitution 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 destinée aux développeurs Google Chat sur https://developers.google.com/workspace/chat".

ChipList

Liste de chips disposés horizontalement, qui peut défiler horizontalement ou se terminer à la ligne suivante.

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

Champs
layout

Layout

Mise en page de la liste de chips spécifiée.
chips[]

Chip

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 rentrent pas dans l'espace disponible.

CollapseControl

Représenter un contrôle d'expansion et de réduction Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

Champs
horizontal_alignment

HorizontalAlignment

Alignement horizontal des boutons "Développer" et "Réduire".
expand_button

Button

Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs "expand_button" et "Réduire_button" doivent tous les 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é.
collapse_button

Button

Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs "expand_button" et "Réduire_button" doivent tous les 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é.

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 apparaissent dans l'ordre dans lequel ils sont spécifiés. Pour obtenir un exemple dans les applications Google Chat, consultez Afficher les fiches et les 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 même hauteur. É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 s'affichent 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 se place sous la première :

  • Sur le Web, la deuxième colonne se plie si la largeur de l'écran est inférieure ou égale à 480 pixels.
  • Sur les appareils iOS, la deuxième colonne renvoie une valeur automatique si la largeur de l'écran est inférieure ou égale à 300 pt.
  • Sur les appareils Android, la deuxième colonne renvoie un message automatique 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. Les UI de modules complémentaires compatibles avec les colonnes incluent les suivantes :

  • 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 qui s'affiche 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[]

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

Champs
horizontal_size_style

HorizontalSizeStyle

Indique comment une colonne remplit la largeur de la fiche.
horizontal_alignment

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

HorizontalSizeStyle

Indique comment une colonne remplit la largeur de la fiche. La largeur de chaque colonne dépend à la fois de la valeur 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 occupe 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 pas plus de 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 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

Champs

Champ d'union data.

data ne peut être qu'un des éléments suivants :
text_paragraph

TextParagraph

Widget TextParagraph
image

Image

Widget Image
decorated_text

DecoratedText

Widget DecoratedText
button_list

ButtonList

Widget ButtonList
text_input

TextInput

Widget TextInput
selection_input

SelectionInput

Widget SelectionInput
date_time_picker

DateTimePicker

Widget DateTimePicker
chip_list

ChipList

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

DateTimePicker

Permet aux utilisateurs de saisir une date, une heure ou les deux. 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 sélectionner des dates et des heures. Si les utilisateurs saisissent une date ou une heure non valides, l'outil de sélection affiche une erreur qui les invite à saisir correctement les informations.

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

Champs
name

string

Nom par lequel le DateTimePicker 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.
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

DateTimePickerType

Indique si le widget permet de saisir une date, une heure ou les deux.
value_ms_epoch

int64

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 au format UTC. Par exemple, pour représenter le 1er janvier 2023 à minuit 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 UTC. Par exemple, pour indiquer 12h, utilisez 43200000 (ou 12 * 60 * 60 * 1000).
timezone_offset_date

int32

Nombre représentant le décalage de fuseau horaire par rapport à l'heure UTC, en minutes. S'il est défini, value_ms_epoch s'affiche dans le fuseau horaire spécifié. Si cette règle n'est pas configurée, la valeur par défaut est le fuseau horaire de l'utilisateur.
on_change_action

Action

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

Validation

Facultatif. Spécifiez la validation requise pour ce sélecteur de date et d'heure.

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

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, telles qu'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 un texte décoratif.

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

Champs
icon
(deprecated)

Icon

Obsolète et remplacé par startIcon.
start_icon

Icon

Icône affichée devant le texte.
top_label

string

Texte qui s'affiche au-dessus de text. Toujours tronquer
text

string

Obligatoire. Texte principal.

Permet une 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.
wrap_text

bool

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

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

string

Texte qui s'affiche sous text. Toujours mise en forme.
on_click

OnClick

Cette action est déclenchée lorsque les utilisateurs cliquent sur topLabel ou bottomLabel.
Champ d'union control. Bouton, bouton d'activation/de désactivation, 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

Button

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

SwitchControl

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

Icon

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

Accepte les icônes intégrées et personnalisées.

SwitchControl

Il peut s'agir 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.

Uniquement disponible dans le widget decoratedText.

Champs
name

string

Nom par lequel le widget switch 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 les données de formulaire.
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 les données de formulaire.
selected

bool

Lorsque la valeur est true, le bouton bascule est sélectionné.
on_change_action

Action

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

ControlType

Affichage du bouton dans l'interface utilisateur

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

ControlType

Affichage du bouton bascule dans l'interface utilisateur

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

Enums
SWITCH Bouton bascule
CHECKBOX Obsolète et remplacé par CHECK_BOX.
CHECK_BOX Case à cocher.

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 plus 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 comporter 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 2 colonnes contient 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

string

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

GridItem

Éléments à afficher dans la grille.
border_style

BorderStyle

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

int32

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 varie en fonction de l'emplacement de la grille (boîte de dialogue ou création associée).
on_click

OnClick

Ce rappel est réutilisé par chaque élément de la grille, 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 sous forme de 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

string

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

ImageComponent

Image affichée 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

GridItemLayout

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 sont affichés 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 la 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.

Accepte 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

string

Facultatif. Description de l'icône utilisée pour l'accessibilité. Si aucune valeur n'est spécifiée, la valeur par défaut Button est fournie. Il est recommandé de définir une description utile de ce que l'icône affiche et, le cas échéant, de son fonctionnement. Exemples : A user's account portrait ou Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Si l'icône est définie dans un Button, le altText s'affiche sous forme de texte d'aide lorsque l'utilisateur pointe sur le bouton. Toutefois, si le bouton définit également text, l'altText de l'icône est ignoré.
image_type

ImageType

Style de recadrage appliqué à l'image. Dans certains cas, lorsque vous appliquez un recadrage CIRCLE, l'image est plus grande qu'une icône intégrée.
Champ d'union icons. Icône affichée dans le widget sur la carte. icons ne peut être qu'un des éléments suivants :
known_icon

string

Affichez l'une des icônes intégrées fournies par Google Workspace.

Par exemple, pour afficher une icône en forme d'avion, spécifiez AIRPLANE. Pour un bus, spécifiez BUS.

Pour obtenir la liste complète des icônes compatibles, consultez la section Icônes intégrées.
icon_url

string

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

Exemple :

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

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

MaterialIcon

Affichez l'une des icônes Material de Google.

Par exemple, pour afficher une icône de case à cocher, utilisez

"material_icon": {
  "name": "check_box"
}

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

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

string

URL HTTPS qui héberge l'image.

Exemple :

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

OnClick

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

string

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

string

URL de l'image.
alt_text

string

Libellé d'accessibilité de l'image.
crop_style

ImageCropStyle

Style de recadrage à appliquer à l'image.
border_style

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
}
Champs
type

ImageCropType

Type de recadrage.
aspect_ratio

double

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.

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, écrivez ce qui suit:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

Champs
name

string

Nom de l'icône défini dans l'icône Google Material, par exemple check_box. Tous les noms non valides sont abandonnés et remplacés par une chaîne vide, ce qui entraîne l'échec de l'affichage de l'icône.
fill

bool

Indique si l'icône est remplie. La valeur par défaut est Faux (false).

Pour prévisualiser différents paramètres d'icône, accédez à Icônes de police Google et ajustez les paramètres sous Personnaliser.
weight

int32

Épaisseur du trait de l'icône. Choisissez parmi les valeurs {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ône, accédez à Icônes de police Google et ajustez les paramètres sous Personnaliser.
grade

int32

Le poids et le niveau déterminent l'épaisseur d'un symbole. Les ajustements de l'épaisseur sont plus précis que ceux de l'épaisseur et ont un faible impact 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ône, accédez à Icônes de police Google 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, comme un bouton.

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

Champs

Champ d'union data.

data ne peut être qu'un des éléments suivants :
action

Action

Si cette valeur est spécifiée, une action est déclenchée par ce onClick.
card

Card

Si un clic est spécifié, une nouvelle carte est transférée dans la pile de cartes.

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

OverflowMenu

Si elle est spécifiée, cette onClick ouvre un menu à développer. Disponible pour les applications Google Chat et indisponible pour les modules complémentaires Google Workspace.

OnClose

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 accepter les deux valeurs, OnClose est prioritaire.

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

Enums
NOTHING Valeur par défaut. La carte ne se recharge pas. Rien ne se passe.
RELOAD

Recharge la carte une fois la fenêtre enfant fermée.

Lorsqu'elle est utilisée avec OpenAs.OVERLAY, la fenêtre enfant fait office de boîte de dialogue modale et la fiche parente est bloquée jusqu'à ce que la fenêtre enfant se ferme.

OpenAs

Lorsqu'une action OnClick ouvre un lien, le client peut l'ouvrir soit en taille réelle (s'il s'agit du cadre utilisé par le client), soit en superposition (comme un pop-up). L'implémentation dépend des fonctionnalités de la plate-forme cliente, et la valeur sélectionnée peut être ignorée si le client n'est pas compatible. FULL_SIZE est compatible avec tous les clients.

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

Enums
FULL_SIZE Le lien s'ouvre dans une fenêtre en taille réelle (s'il s'agit du cadre utilisé par le client).
OVERLAY Le lien s'ouvre en superposition, par exemple dans un pop-up.

OverflowMenu

Widget qui présente un menu pop-up avec une ou plusieurs actions que les utilisateurs peuvent appeler. Par exemple, afficher des actions secondaires dans une fiche. Vous pouvez utiliser ce widget lorsque les actions ne rentrent 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 non disponible pour les modules complémentaires Google Workspace.

Champs
items[]

OverflowMenuItem

Obligatoire. Liste des options du menu.

OverflowMenuItem

Option que les utilisateurs peuvent appeler dans un menu à développer.

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

Champs
start_icon

Icon

Icône affichée devant le texte.
text

string

Obligatoire. Texte qui identifie ou décrit l'élément pour les utilisateurs.
on_click

OnClick

Obligatoire. Action appelée lorsqu'une option de menu est sélectionnée. Ce OnClick ne peut pas contenir d'OverflowMenu. Tout OverflowMenu spécifié est supprimé et l'élément de menu est désactivé.
disabled

bool

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. 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 indéfinies ou abstraites auprès des utilisateurs, utilisez le widget TextInput.

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

Champs
name

string

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

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

string

Texte qui s'affiche au-dessus du champ de saisie de 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'assistance dans un menu déroulant, le libellé peut être "Urgence" ou "Sélectionner l'urgence".
type

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[]

SelectionItem

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

Action

Si elle est spécifiée, le formulaire est envoyé lorsque la sélection change. Si aucune valeur n'est spécifiée, vous devez ajouter un bouton distinct pour envoyer le formulaire.

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

int32

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

int32

Pour les menus à sélection multiple, nombre de caractères saisis par l'utilisateur avant que l'application ne lance la saisie semi-automatique et affiche des suggestions dans le menu.

Si aucune valeur n'est spécifiée, la valeur par défaut est 0 caractère pour les sources de données statiques et 3 caractères pour les sources de données externes.
validation

Validation

Pour les menus déroulants, validation de ce champ de saisie de sélection.

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

Champ d'union multi_select_data_source. Pour un menu à sélection multiple, la source de données qui renseigne les éléments de sélection.

Disponible pour les applications Google Chat et indisponible pour les modules complémentaires Google Workspace. multi_select_data_source ne peut être qu'un des éléments suivants :
external_data_source

Action

Source de données externe, telle qu'une base de données relationnelle.
platform_data_source

PlatformDataSource

Une source de données Google Workspace.

PlatformDataSource

Pour un widget SelectionInput qui utilise un menu à sélection multiple, une source de données 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.

Champs
Champ d'union data_source. Source de données. data_source ne peut être qu'un des éléments suivants :
common_data_source

CommonDataSource

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

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.

CommonDataSource

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 d'utilisateurs Google Workspace. L'utilisateur ne peut afficher et sélectionner que des 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.

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

Champs
text

string

Texte qui identifie ou décrit l'élément pour les utilisateurs.
value

string

Valeur associée à cet élément. Le client doit l'utiliser comme valeur d'entrée du formulaire.

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

bool

Indique si l'élément est sélectionné par défaut. Si la sélection n'accepte qu'une seule valeur (par exemple, pour des cases d'option ou un menu déroulant), définissez ce champ pour un seul élément.
start_icon_uri

string

Pour les menus à sélection multiple, URL de l'icône affichée à côté du champ text de l'élément. Compatible avec les fichiers PNG et JPEG. Il doit s'agir d'une URL HTTPS. Par exemple, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
bottom_text

string

Pour les menus à sélection multiple, il s'agit d'une description textuelle ou d'un libellé qui s'affiche sous le champ text de l'élément.

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 champ de saisie de sélection accepte un type de sélection. Il n'est pas possible, par exemple, de mélanger des cases à cocher et des boutons d'activation/de désactivation.

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 Ensemble d'interrupteurs. Les utilisateurs peuvent activer un ou plusieurs boutons.
DROPDOWN Un menu déroulant. Les utilisateurs peuvent sélectionner un élément dans le menu.
MULTI_SELECT

Menu à sélection multiple pour les données statiques ou dynamiques. Dans la barre de menu, les utilisateurs sélectionnent un ou plusieurs éléments. Les utilisateurs peuvent également saisir des valeurs pour renseigner des données dynamiques. Par exemple, les utilisateurs peuvent commencer à saisir le nom d'un espace Google Chat, et le widget suggère automatiquement l'espace.

Pour renseigner les éléments d'un menu à sélection multiple, vous pouvez utiliser l'un des types de sources de données suivants :

  • Données statiques : les éléments sont spécifiés en tant qu'objets SelectionItem dans le widget. Jusqu'à 100 éléments.
  • Données Google Workspace: les éléments sont renseignés à l'aide des données 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, consultez la section Ajouter un menu à sélection multiple.

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

Suggestions

Suggestions de valeurs que les utilisateurs peuvent saisir. Ces valeurs apparaissent 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 se filtre 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. En suggérant JavaScript, vous pouvez standardiser la façon dont les utilisateurs interagissent avec votre application.

Lorsque TextInput.type est spécifié, il 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[]

SuggestionItem

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

content ne peut être qu'un des éléments suivants :
text

string

Valeur d'une suggestion d'entrée dans un champ de saisie de texte. Il s'agit de ce que les utilisateurs saisissent eux-mêmes.

TextInput

Champ dans lequel les utilisateurs peuvent saisir du texte. Prise en charge des suggestions et des actions en cas de modification. 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 d'entrée 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 indéfinies ou abstraites auprès des utilisateurs, utilisez une zone de 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.

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 apparaît au-dessus du champ de saisie dans l'interface utilisateur.

Spécifiez du 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, saisissez surname au lieu de name.

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

string

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

Obligatoire si label n'est pas spécifié. Sinon, 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

Type

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

Action

Que faire lorsqu'un changement se produit dans le champ de saisie de texte ? Par exemple, un utilisateur ajoute des éléments au champ ou supprime du texte.

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

Suggestions

Suggestions de valeurs 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 de filtres de suggestions n'affiche que 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. En suggérant JavaScript, vous pouvez standardiser la façon dont les utilisateurs interagissent avec votre application.

Lorsque TextInput.type est spécifié, il 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.
auto_complete_action

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 elle est spécifiée, l'application effectue l'action indiquée ici, par exemple exécuter une fonction personnalisée.

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

Validation

Spécifiez la validation nécessaire pour ce champ de saisie de texte.

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

string

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, Enter a number from 0 to 100.

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

Type

Affichage d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, il peut s'agir d'un champ de saisie sur une seule ligne ou 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.

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 le texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace.

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

Champs
text

string

Texte affiché dans le widget.
max_lines

int32

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é, aucun bouton Afficher plus ne s'affiche.

La valeur par défaut est 0, auquel cas tout le contexte est affiché. Les valeurs négatives sont ignorées. Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.

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

int32

Spécifiez la limite 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.

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

InputType

Spécifiez le type des widgets de saisie.

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

InputType

Type de widget d'entrée.

Enums
INPUT_TYPE_UNSPECIFIED Type non spécifié. Ne pas utiliser.
TEXT Texte standard qui accepte tous les caractères.
INTEGER Valeur entière.
FLOAT Valeur flottante.
EMAIL Adresse e-mail
EMOJI_PICKER Un 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 pouvant représenter du texte, des images, des boutons ou d'autres types d'objets.

Champs
horizontal_alignment

HorizontalAlignment

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

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 le texte dans les applications Google Chat et Mettre en forme le 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

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"
}
decorated_text

DecoratedText

Affiche un élément textuel décoré.

Par exemple, le fichier JSON suivant crée un widget de texte décoré affichant l'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"
  }
}
button_list

ButtonList

Liste des boutons.

Par exemple, l'exemple JSON suivant crée deux boutons. Le premier est un bouton de texte bleu et le second est un bouton 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"
        }
      }
    }
  ]
}
text_input

TextInput

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

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

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

Par exemple, le code JSON suivant crée une entrée 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"
      }
    ]
  }
}
selection_input

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 permettant 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
    }
  ]
}
date_time_picker

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

Divider

Affiche une ligne de séparation horizontale entre les widgets.

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

"divider": {
}
grid

Grid

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

Une grille peut comporter un nombre illimité de colonnes et d'éléments. Le nombre de lignes est déterminé par la limite supérieure du nombre d'articles divisé par le nombre de colonnes. Une grille de 10 éléments et 2 colonnes contient 5 lignes. Une grille avec 11 éléments et 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

Columns

Affiche jusqu'à deux colonnes.

Pour inclure plus de deux colonnes ou 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"
          }
        }
      ]
    }
  ]
}
chip_list

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": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

HorizontalAlignment

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

Disponible pour les applications Google Chat et indisponible 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, s'aligne à gauche. Pour les mises en page de droite à gauche, s'aligne à 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.

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 de 4 x 3 pixels devient de 3 x 3 pixels.
CIRCLE Applique un masque circulaire à l'image. Par exemple, une image de 4 x 3 pixels devient un cercle de 3 cm de diamètre.