Package google.apps.card.v1

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.

ActionParameter

Liste des paramètres d'action.

LoadIndicator

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

bool

Indique si les valeurs du formulaire sont conservées 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 de modifier l'action pendant son traitement, définissez LoadIndicator sur NONE. Pour les messages des fiches dans les applications Chat, vous devez également définir la valeur ResponseType de l'action sur UPDATE_MESSAGE et utiliser la même card_id que celle 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

Facultatif. Obligatoire lors de 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 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.

string

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

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

bool

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

string

Nom du paramètre du script d'action.

string

Valeur du paramètre.

BorderType

Type de bordure.

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. Cette 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, 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é.

int32

Rayon de l'angle de la bordure.

string

Texte affiché dans le bouton.

Icon

Icône affichée dans le bouton. Si les paramètres icon et text sont tous les deux définis, l'icône apparaît avant le texte.

Color

Facultatif. Couleur du bouton. Si cette valeur est définie, le bouton type est défini sur FILLED, et la couleur des champs text et icon est définie sur une couleur contrastante 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. Cette 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, 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 bouton. Si elle est spécifiée, ce champ est ignoré.

OnClick

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

bool

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

string

Texte alternatif 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

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

Button

Tableau de boutons.

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 s'affichent toujours en haut d'une fiche.

Section

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

DividerStyle

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

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

string

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

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

CardFixedFooter

Pied de page fixe affiché en bas de cette 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 des fiches.

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

DisplayStyle

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

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

CardHeader

Lorsque vous affichez du contenu contextuel, l'en-tête de la fiche Aperçu sert de place-tampon 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.

string

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

OnClick

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

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.

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.

string

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

string

Sous-titre de l'en-tête de la fiche. Si spécifié, apparaît sur sa propre ligne sous title.

ImageType

Forme utilisée pour recadrer l'image.

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

string

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

string

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

string

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

Widget

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

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.

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.

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

Icon

Image de l'icône. Si les paramètres icon et text sont tous les deux définis, l'icône apparaît avant le texte.

string

Texte affiché dans le chip.

OnClick

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

bool

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

bool

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

string

Texte alternatif utilisé pour l'accessibilité.

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

Layout

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

Chip

Tableau de chips.

HorizontalAlignment

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

Button

Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs expand_button et collapse_button doivent être définis. Seul un ensemble de champs ne sera pas appliqué. Si ce champ n'est pas défini, le bouton par défaut est utilisé.

Button

Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs expand_button et collapse_button doivent ê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é.

Column

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

HorizontalSizeStyle

Indique comment une colonne remplit la largeur de la fiche.

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

Widget TextParagraph

Image

Widget Image

DecoratedText

Widget DecoratedText

ButtonList

Widget ButtonList

TextInput

Widget TextInput

SelectionInput

Widget SelectionInput

DateTimePicker

Widget DateTimePicker

ChipList

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

string

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

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

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.

DateTimePickerType

Indique si le widget prend en charge la saisie d'une date, d'une heure, ou de la date et l'heure.

int64

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

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

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

int32

Nombre représentant le décalage horaire par rapport à 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.

Action

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

Validation

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

Icon

Abandonné et remplacé par startIcon.

Icon

Icône affichée devant le texte.

string

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

string

Obligatoire. Texte principal.

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

bool

Paramètre de retour à la ligne. 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.

string

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

OnClick

Cette action est déclenchée lorsque les utilisateurs cliquent sur topLabel ou bottomLabel.

Button

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

SwitchControl

Widget de bouton bascule sur lequel un utilisateur peut cliquer pour modifier son état et déclencher une action.

Icon

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

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

string

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.

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.

bool

Lorsque true est sélectionné, le bouton bascule est activé.

Action

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

ControlType

Affichage du bouton dans l'interface utilisateur

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

string

Texte affiché dans l'en-tête de la grille.

GridItem

Éléments à afficher dans la grille.

BorderStyle

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

int32

Nombre de colonnes à afficher dans la grille. Si ce champ n'est pas spécifié, une valeur par défaut est utilisée. Cette valeur par défaut est différente selon l'emplacement de la grille (boîte de dialogue ou application associée).

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.

string

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

ImageComponent

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

string

Titre de l'élément de la grille.

string

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

GridItemLayout

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

string

Facultatif. Description de l'icône utilisée pour l'accessibilité. Si elle n'est pas 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. Par exemple, 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é.

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.

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.

string

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

MaterialIcon

Affichez l'une des icônes Google Material.

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.

string

URL HTTPS qui héberge l'image.

Exemple :

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

OnClick

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

string

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

string

URL de l'image.

string

Libellé d'accessibilité de l'image.

ImageCropStyle

Style de recadrage à appliquer à l'image.

BorderStyle

Style de bordure à appliquer à l'image.

ImageCropType

Type de recadrage.

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
}

string

Nom de l'icône défini dans l'icône Google Material (par exemple, check_box). Les noms non valides sont abandonnés et remplacés par une chaîne vide. L'icône ne s'affiche alors pas.

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 Google Fonts et ajustez les paramètres sous Personnaliser.

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.

int32

L'épaisseur et le niveau ont une incidence sur 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.

Action

Si cet élément est spécifié, une action est déclenchée par ce onClick.

OpenLink

Si cet élément onClick est spécifié, il déclenche une action d'ouverture de lien.

Action

Un module complémentaire déclenche cette action lorsqu'il doit ouvrir un lien. Il diffère de open_link ci-dessus en ce sens qu'il doit communiquer avec le serveur pour obtenir le lien. Par conséquent, le client Web doit effectuer un certain travail de préparation avant que la réponse à l'action d'ouverture du lien ne soit renvoyée.

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

Card

Si spécifié, une nouvelle fiche est ajoutée à la pile de cartes après le clic.

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

OverflowMenu

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

string

URL à ouvrir.

OpenAs

Comment ouvrir un lien

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

OnClose

Indique si le client oublie un lien après l'avoir ouvert ou s'il l'observe jusqu'à ce que la fenêtre se ferme.

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

OverflowMenuItem

Obligatoire. Liste des options du menu.

Icon

Icône affichée devant le texte.

string

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

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

bool

Indique si l'option de menu est désactivée. Valeur par défaut : "false".

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 des données de formulaire.

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 de service dans un menu déroulant, le libellé peut être "Urgence" ou "Sélectionner l'urgence".

SelectionType

Type d'éléments présenté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.

SelectionItem

Tableau d'éléments sélectionnables. Par exemple, un tableau de boutons d'option ou de cases à cocher. Jusqu'à 100 éléments sont acceptés.

Action

Si une valeur est spécifiée, le formulaire est envoyé lorsque la sélection change. Si ce n'est pas le cas, vous devez spécifier un bouton distinct qui envoie le formulaire.

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

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 trois éléments.

int32

Pour les menus à sélection multiple, nombre de caractères de texte saisis par l'utilisateur avant que le menu ne renvoie des suggestions d'éléments de sélection.

Si elle n'est pas définie, le menu à sélection multiple utilise les valeurs par défaut suivantes :

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

Validation

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

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

Action

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

PlatformDataSource

Source de données Google Workspace.

CommonDataSource

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

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.

string

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

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.

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.

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. Doit être une URL HTTPS. Par exemple, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

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.

SuggestionItem

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

string

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

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.

string

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

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

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

string

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

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

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

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

Action

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

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

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 se filtre pour n'afficher 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.

Action

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

Si cette valeur n'est pas 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

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

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.

string

Texte affiché dans le widget.

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.

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

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

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

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

Image

Affiche une image.

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

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

DecoratedText

Affiche un élément de texte 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"
  }
}

ButtonList

Liste de boutons.

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

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

TextInput

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

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

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

Dans cet autre exemple, le code JSON suivant crée une entrée de texte pour un langage de programmation à l'aide de suggestions statiques:

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

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 bascules 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
    }
  ]
}

DateTimePicker

Affiche un widget qui permet 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

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

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

"divider": {
}

Grid

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

Une grille peut contenir un nombre illimité de colonnes et d'éléments. Le nombre de lignes est déterminé par la limite supérieure du nombre d'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

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

ChipList

Liste des 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.