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, recueillir des informations auprès des utilisateurs et les guider vers l'étape suivante.
Créez et prévisualisez des fiches avec Card Builder.
Ouvrir Card Builder
Pour savoir comment créer des fiches, consultez la documentation suivante:
- Pour les applications Google Chat, consultez Concevez les composants d'une carte ou d'une boîte de dialogue.
- Pour les modules complémentaires Google Workspace, consultez Interfaces basées sur des cartes.
Exemple: Message de fiche pour une application Google Chat
Pour créer l'exemple de message de fiche dans Google Chat, utilisez le fichier JSON suivant:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Représentation JSON |
---|
{ "header": { object ( |
Champs | |
---|---|
header
|
En-tête de la carte. 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[]
|
Contient un ensemble 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 voir un exemple dans les applications Google Chat, consultez Définir une section d'une fiche |
sectionDividerStyle
|
Style de séparation entre les sections. |
cardActions[]
|
Les actions de la fiche. Les actions sont ajoutées au menu de la barre d'outils de la fiche.
Par exemple, le code JSON suivant construit un menu d'actions de carte avec
|
name
|
Nom de la carte. Utilisé comme identifiant de carte dans la navigation par carte.
|
fixedFooter
|
Pied de page fixe affiché au bas de cette fiche.
Paramètre
|
displayStyle
|
Dans les modules complémentaires Google Workspace, cette option permet de définir les propriétés d'affichage
|
peekCardHeader
|
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.
|
CardHeader
Représente un en-tête de carte. Pour voir un exemple dans les applications Google Chat, consultez Ajoutez un en-tête.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"title": string,
"subtitle": string,
"imageType": enum (
|
Champs | |
---|---|
title
|
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. |
subtitle
|
Sous-titre de l'en-tête de la carte. S'il est spécifié, il apparaît sur sa propre ligne sous la
|
imageType
|
Forme utilisée pour recadrer l'image.
|
imageUrl
|
URL HTTPS de l'image dans l'en-tête de la fiche. |
imageAltText
|
Texte alternatif de cette image utilisé pour l'accessibilité. |
ImageType
Forme utilisée pour recadrer l'image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
SQUARE
|
Valeur par défaut. Applique un masque carré à l'image. Par exemple, une image 4x3 devient 3x3. |
CIRCLE
|
Applique un masque circulaire à l'image. Par exemple, une image 4x3 devient un cercle d'un diamètre de 3. |
Section
Une section contient un ensemble de widgets affichés verticalement, dans l'ordre dans lequel ils sont spécifiés.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "header": string, "widgets": [ { object ( |
Champs | |
---|---|
header
|
Texte affiché en haut d'une section. Accepte les textes 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 le texte dans les modules complémentaires Google Workspace |
widgets[]
|
Tous les widgets de la section Doit contenir au moins un widget. |
collapsible
|
Indique si cette section peut être réduite. Les sections réductibles masquent certains ou tous les widgets, mais les utilisateurs peuvent la développer pour afficher les widgets masqués en cliquant sur Plus : Les utilisateurs peuvent à nouveau masquer les widgets en cliquant sur Afficher moins.
Pour déterminer quels widgets sont masqués, indiquez
|
uncollapsibleWidgetsCount
|
Nombre de widgets réductibles qui restent visibles même lorsqu'une section est réduite.
Par exemple, lorsqu'une section contient cinq widgets et que le
|
collapseControl
|
Facultatif. Définissez les boutons d'expansion 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é.
|
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.
Représentation JSON |
---|
{ "horizontalAlignment": enum ( |
Champs | |
---|---|
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 que l'un des éléments suivants. Vous pouvez utiliser plusieurs champs de widget pour afficher plus d'éléments.
data
ne peut être que l'un des éléments suivants:
|
|
textParagraph
|
Affiche un paragraphe de texte. Accepte les textes 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 le texte dans les modules complémentaires Google Workspace Par exemple, le code JSON suivant crée un texte en gras:
|
image
|
Affiche une image. Par exemple, le code JSON suivant crée une image avec un texte alternatif:
|
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:
|
buttonList
|
Liste de 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:
|
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:
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:
|
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 qui permet aux utilisateurs de choisir une taille:
|
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:
|
divider
|
Affiche une ligne de séparation horizontale entre les widgets. Par exemple, le code JSON suivant crée un séparateur:
|
grid
|
Affiche une grille avec une collection d'éléments. Une grille peut 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'éléments divisé par le nombre de colonnes. Une grille de 10 éléments et 2 colonnes contient 5 lignes. Une grille de 11 éléments et 2 colonnes contient 6 lignes.
Par exemple, le code JSON suivant crée une grille à deux colonnes avec un seul élément:
|
columns
|
Affiche jusqu'à deux colonnes.
Pour inclure plus de deux colonnes ou utiliser des lignes, utilisez les
Par exemple, le code JSON suivant crée deux colonnes contenant chacune des paragraphes de texte:
|
chipList
|
Liste de chips. Par exemple, le code JSON suivant crée deux puces. Le premier est un chip de texte et le second est un chip d'icône qui permet d'ouvrir un lien:
|
TextParagraph
Paragraphe de texte compatible avec la mise en forme. Pour voir un exemple dans les applications Google Chat, consultez Ajouter un paragraphe de texte mis en forme Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "text": string, "maxLines": integer } |
Champs | |
---|---|
text
|
Texte affiché dans le widget. |
maxLines
|
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 en trop est dissimulé derrière un afficher plus . Si le texte est inférieur ou égal au nombre maximal de lignes spécifié, une afficher plus ne s'affiche pas.
La valeur par défaut est 0, auquel cas tout le contexte est affiché. Les valeurs négatives sont ignorées.
|
Image
Une image spécifiée par une URL et pouvant avoir une
onClick
action. Pour voir un exemple, consultez
Ajoutez une image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Champs | |
---|---|
imageUrl
|
URL HTTPS qui héberge l'image. Exemple :
|
onClick
|
Lorsqu'un utilisateur clique sur l'image, le clic déclenche cette action. |
altText
|
Texte alternatif de cette image utilisé pour l'accessibilité. |
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.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
action
|
Si cet élément est spécifié, une action est déclenchée
|
openLink
|
Si cet argument est spécifié,
|
openDynamicLinkAction
|
Un module complémentaire déclenche cette action lorsqu'elle doit ouvrir un lien. Cela diffère du
|
card
|
Si un clic est spécifié, une nouvelle carte est transférée dans la pile de cartes.
|
overflowMenu
|
Si cet argument est spécifié,
|
Action
Une action qui décrit le comportement lors de l'envoi du formulaire. 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.
Représentation JSON |
---|
{ "function": string, "parameters": [ { object ( |
Champs | |
---|---|
function
|
Fonction personnalisée à invoquer lorsque l'utilisateur clique sur l'élément parent ou est activé d'une autre manière. Pour un exemple d'utilisation, consultez Lire les données de formulaire |
parameters[]
|
Liste des paramètres d'action. |
loadIndicator
|
Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action. |
persistValues
|
Indique si les valeurs du formulaire sont conservées après l'action. La valeur par défaut est
Si
Si
|
interaction
|
Facultatif. Obligatoire pour ouvrir un dialog. 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 aucune valeur n'est spécifiée, l'application répond en exécutant une
En spécifiant un
|
requiredWidgets[]
|
(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é.
|
allWidgetsAreRequired
|
(Facultatif) Si c'est le cas, tous les widgets sont considérés comme requis par cette action.
|
ActionParameter
Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. 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 pourriez 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.
Représentation JSON |
---|
{ "key": string, "value": string } |
Champs | |
---|---|
key
|
Nom du paramètre pour le script d'action. |
value
|
Valeur du paramètre. |
LoadIndicator
Spécifie l'indicateur de chargement que l'action affiche lors de l'appel à l'action.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
SPINNER
|
Affiche une icône de chargement pour indiquer que le contenu est en cours de chargement. |
NONE
|
Rien ne s'affiche. |
Interaction
Facultatif. Obligatoire pour ouvrir un dialog.
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 aucune valeur n'est spécifiée, l'application répond en exécutant une
action
(par exemple, en ouvrant un lien ou en exécutant une fonction).
En spécifiant un
interaction
, l'application peut répondre de manière interactive spéciale. Par exemple, en définissant
interaction
à
OPEN_DIALOG
, l'application peut ouvrir
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 non disponible pour les modules complémentaires Google Workspace.
Enums | |
---|---|
INTERACTION_UNSPECIFIED
|
Valeur par défaut. La
action
s'exécute normalement.
|
OPEN_DIALOG
|
Ouvre un dialog : interface fenêtrée sous forme de fiches qui permet aux applications Chat d'interagir avec les utilisateurs. Compatible uniquement avec les applications Chat lorsque l'utilisateur clique sur un bouton dans les messages de la 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.
|
OpenLink
Représente un
onClick
qui ouvre un lien hypertexte.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "url": string, "openAs": enum ( |
Champs | |
---|---|
url
|
URL à ouvrir. |
openAs
|
Ouvrir un lien
|
onClose
|
Indique si le client a oublié un lien après l'avoir ouvert ou l'observe jusqu'à la fermeture de la fenêtre.
|
OpenAs
Lorsqu'un
OnClick
ouvre un lien, le client peut alors l'ouvrir soit en taille réelle (s'il s'agit du cadre utilisé par le client), soit en superposition (comme une fenêtre 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 pris en charge par tous les clients.
Disponible avec les modules complémentaires Google Workspace et non disponible dans 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, dans un pop-up par exemple. |
OnClose
Que fait le client lorsqu'un lien ouvert par un
OnClick
est fermée.
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 une
OnClose
.
Si les
OnOpen
et
OnClose
sont définis, et la plate-forme cliente ne peut pas prendre en charge les deux valeurs,
OnClose
est prioritaire.
Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.
Enums | |
---|---|
NOTHING
|
Valeur par défaut. La carte ne se recharge pas. rien ne se passe. |
RELOAD
|
La fiche est actualisée une fois la fenêtre enfant fermée.
S'il est utilisé avec
|
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 l'espace disponible est insuffisant pour les actions. Spécifiez ce widget dans le champ
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.
Représentation JSON |
---|
{
"items": [
{
object (
|
Champs | |
---|---|
items[]
|
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 non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "startIcon": { object ( |
Champs | |
---|---|
startIcon
|
Icône affichée devant le texte. |
text
|
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
|
disabled
|
Indique si l'option de menu est désactivée. Valeur par défaut : "false". |
Icône
Icône affichée dans un widget sur une carte. Pour voir un exemple dans les applications Google Chat, consultez Ajoutez une icône.
Compatible intégré et personnalisé .
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "altText": string, "imageType": enum ( |
Champs | |
---|---|
altText
|
Facultatif. Description de l'icône utilisée pour l'accessibilité. Si aucune valeur n'est spécifiée, la valeur par défaut
Si l'icône est définie dans un
|
imageType
|
Style de recadrage appliqué à l'image. Dans certains cas, l'application d'une
|
Champ d'union
icons Icône affichée dans le widget sur la carte.
icons
ne peut être que l'un des éléments suivants:
|
|
knownIcon
|
Affichez l'une des icônes intégrées fournies par Google Workspace.
Par exemple, pour afficher une icône d'avion, spécifiez
Pour obtenir la liste complète des icônes prises en charge, consultez icônes intégrées. |
iconUrl
|
Affichez une icône personnalisée hébergée sur une URL HTTPS. Exemple :
Types de fichiers compatibles :
|
materialIcon
|
Affichez l'un des Icônes Google Material. Par exemple, pour afficher icône de case à cocher, utilisez
|
MaterialIcon
A Icône Google Material, qui inclut plus de 2 500 options.
Par exemple, pour afficher 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.
Représentation JSON |
---|
{ "name": string, "fill": boolean, "weight": integer, "grade": integer } |
Champs | |
---|---|
name
|
Nom de l'icône défini dans le
Icône Google Material, par exemple,
|
fill
|
Indique si l'icône est remplie ou non. 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 : |
weight
|
Épaisseur du trait de l'icône. Choisissez parmi {100, 200, 300, 400, 500, 600, 700}. Si ce champ n'est pas renseigné, 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 Google Fonts et ajustez les paramètres sous Personnaliser : |
grade
|
Le poids et le niveau déterminent l'épaisseur d'un symbole. Les ajustements de note sont plus précis que les ajustements de pondération et ont un faible impact sur la taille du symbole. Choisissez parmi {-25, 0, 200}. Si ce champ n'est pas renseigné, 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 Google Fonts et ajustez les paramètres sous Personnaliser : |
DecoratedText
Widget affichant 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 voir un exemple dans les applications Google Chat, consultez Afficher le texte avec un texte décoratif :
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "icon": { object ( |
Champs | |
---|---|
icon
|
Obsolète au profit de
|
startIcon
|
Icône affichée devant le texte. |
topLabel
|
Le texte qui s'affiche au-dessus
|
text
|
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 le texte dans les modules complémentaires Google Workspace |
wrapText
|
Paramètre de retour à la ligne automatique. Si
S'applique uniquement aux éléments suivants :
|
bottomLabel
|
Le texte qui s'affiche en dessous
|
onClick
|
Cette action est déclenchée lorsque les utilisateurs cliquent
|
Champ d'union
control Un bouton, un commutateur, une case à cocher ou une image qui apparaît à droite du texte dans la
decoratedText
.
control
ne peut être que l'un des éléments suivants:
|
|
button
|
Un bouton sur lequel un utilisateur peut cliquer pour déclencher une action. |
switchControl
|
Widget de contacteur sur lequel l'utilisateur peut cliquer pour modifier son état et déclencher une action. |
endIcon
|
Icône affichée après le texte. Compatible intégré et personnalisé . |
Bouton
Un texte, une icône ou un bouton de texte et d'icône sur lequel les utilisateurs peuvent cliquer. Pour voir un exemple dans les applications Google Chat, consultez Ajouter un bouton
Pour transformer une image en bouton cliquable, spécifiez une
(il ne s'agit pas d'une
Image
), puis définissez une
ImageComponent
onClick
action.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "text": string, "icon": { object ( |
Champs | |
---|---|
text
|
Texte affiché à l'intérieur du bouton. |
icon
|
Image de l'icône Si les
|
color
|
S'il est défini, le bouton est rempli d'une couleur d'arrière-plan unie et la couleur de la police change pour maintenir le contraste avec la couleur d'arrière-plan. Par exemple, si vous définissez un arrière-plan bleu, le texte sera probablement blanc. Si cette règle n'est pas configurée, l'arrière-plan de l'image est blanc et la couleur de la police est bleue.
Pour le rouge, le vert et le bleu, la valeur de chaque champ est une
Défini (facultatif)
Pour
Par exemple, la couleur suivante représente un demi-rouge transparent:
|
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
|
Si
|
altText
|
Texte alternatif utilisé pour l'accessibilité. Définissez un texte descriptif pour indiquer aux utilisateurs à quoi sert le bouton. Par exemple, si un bouton ouvre un lien hypertexte, vous pouvez écrire : "Ouvre un nouvel onglet de navigateur et permet d'accéder à la documentation Google Chat destinée aux développeurs sur https://developers.google.com/workspace/chat". |
type
|
Détermine le type d'un bouton.
|
Couleur
Représente une couleur dans l'espace colorimétrique RVBA. Cette représentation est conçue pour simplifier la conversion vers et depuis des représentations de couleurs dans différentes langues plutôt que pour être compacte. Par exemple, les champs de cette représentation peuvent être fournis de manière triviale au constructeur de
java.awt.Color
en Java. il peut également être fourni
de manière triviale au
+colorWithRed:green:blue:alpha
dans iOS. Vous pouvez facilement le formater dans un CSS
rgba()
en JavaScript.
Cette page de référence ne contient pas d'informations sur l'espace colorimétrique absolu à utiliser pour interpréter la valeur RVB (sRVB, Adobe RVB, DCI-P3 et BT.2020, par exemple). Par défaut, les applications doivent supposer que l'espace colorimétrique sRVB est utilisé.
Lorsque l'égalité des couleurs doit être décidée, les implémentations, sauf indication contraire, traitent deux couleurs comme égales si toutes leurs valeurs rouge, vert, bleu et alpha diffèrent au maximum de chacune
1e-5
Exemple (Java) :
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Exemple (iOS/Obj-C) :
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Exemple (JavaScript) :
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Représentation JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Champs | |
---|---|
red
|
Quantité de rouge dans la couleur en tant que valeur dans l'intervalle [0, 1]. |
green
|
Quantité de vert dans la couleur en tant que valeur dans l'intervalle [0, 1]. |
blue
|
Quantité de bleu dans la couleur en tant que valeur dans l'intervalle [0, 1]. |
alpha
|
Fraction de cette couleur à appliquer au pixel. En d'autres termes, la couleur finale du pixel est définie par l'équation :
Cela signifie qu'une valeur de 1,0 correspond à une couleur solide, tandis qu'une valeur de 0,0 correspond à une couleur complètement transparente. Un message wrapper est utilisé à la place d'une simple valeur scalaire flottante afin qu'il soit possible de distinguer une valeur par défaut de la valeur non définie. S'il est omis, cet objet couleur est affiché sous la forme d'une couleur unie (comme si la valeur alpha avait été explicitement définie sur 1,0). |
Type
Disponible pour les applications Google Chat et non disponible 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 correspondent pas à l'action principale dans une application ou un module complémentaire Chat. |
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 plein est un autre milieu entre les boutons remplis et les boutons encadrés. 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. |
SwitchControl
Il peut s'agir d'un bouton bascule ou d'une case à cocher à l'intérieur d'un
decoratedText
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Uniquement disponible dans les
decoratedText
.
Représentation JSON |
---|
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object ( |
Champs | |
---|---|
name
|
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 du formulaire |
value
|
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 du formulaire |
selected
|
Quand ?
|
onChangeAction
|
Action à effectuer lorsque l'état du bouton bascule est modifié, par exemple la fonction à exécuter. |
controlType
|
Affichage du bouton bascule dans l'interface utilisateur
|
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 au profit de
CHECK_BOX
|
CHECK_BOX
|
Une case à cocher. |
ButtonList
Liste de boutons disposés horizontalement. Pour voir un exemple dans les applications Google Chat, consultez Ajouter un bouton
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"buttons": [
{
object (
|
Champs | |
---|---|
buttons[]
|
Tableau de boutons. |
TextInput
Champ dans lequel les utilisateurs peuvent saisir du texte. Prise en charge des suggestions et des actions en cas de modification. Pour voir un exemple dans les applications Google Chat, consultez Ajoutez un champ dans lequel l'utilisateur peut saisir du texte.
Les applications de chat reçoivent et peuvent traiter la valeur du texte saisi lors des événements de saisie de formulaire. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire
Lorsque vous devez collecter des données non définies ou abstraites auprès des utilisateurs, utilisez une saisie de texte. Pour collecter des données définies ou énumérées auprès des utilisateurs, utilisez le
SelectionInput
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum ( |
Champs | |
---|---|
name
|
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 les données du formulaire |
label
|
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
besoin de son nom de famille, écrivez
Obligatoire si
|
hintText
|
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
|
value
|
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 du formulaire |
type
|
Affichage d'un champ de saisie de texte dans l'interface utilisateur. Par exemple, indiquez si le champ comporte une ou plusieurs lignes. |
onChangeAction
|
Que faire en cas de modification du champ de saisie de texte ? Par exemple, un utilisateur ajoute des éléments au champ ou supprime du texte. Les exemples d'actions à effectuer incluent l'exécution d'une fonction personnalisée ou l'ouverture d'un boîte de dialogue dans Google Chat. |
initialSuggestions
|
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 du texte
Les valeurs suggérées aident les utilisateurs à saisir des valeurs pertinentes pour votre application. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir
Si spécifié,
|
autoCompleteAction
|
Facultatif. Spécifiez l'action à effectuer lorsque le champ de saisie de texte fournit des suggestions aux utilisateurs qui interagissent avec lui.
Si aucune valeur n'est spécifiée, les suggestions sont définies par
Si elle est spécifiée, l'application effectue l'action spécifiée ici, comme exécuter une fonction personnalisée.
|
validation
|
Spécifiez la validation nécessaire pour ce champ de saisie de texte.
|
placeholderText
|
Texte qui s'affiche dans le champ de saisie lorsque celui-ci est vide. Utilisez ce texte pour inviter les utilisateurs à saisir une valeur. Exemple :
|
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ée,
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
|
La hauteur du champ de saisie de texte est fixe, à savoir une ligne. |
MULTIPLE_LINE
|
Le champ de saisie de texte a une hauteur fixe de plusieurs lignes. |
RenderActions
Un ensemble d'instructions d'affichage indiquant à une fiche d'effectuer une action indique à l'application hôte du module complémentaire ou à l'application Chat d'effectuer une action spécifique à l'application.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Champs | |
---|---|
action |
Action
Champs | |
---|---|
navigations[] |
Transférez ou mettez à jour les cartes affichées. |
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 du texte
Jav
, la liste des filtres de suggestions à afficher
Java
et
JavaScript
Les valeurs suggérées aident les utilisateurs à saisir des valeurs pertinentes pour votre application. Lorsqu'ils font référence à JavaScript, certains utilisateurs peuvent saisir
javascript
et autres
java script
Suggestion
JavaScript
peuvent standardiser la façon dont
les utilisateurs interagissent avec votre application.
Si spécifié,
TextInput.type
est toujours
SINGLE_LINE
, même s'il est défini sur
MULTIPLE_LINE
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"items": [
{
object (
|
Champs | |
---|---|
items[]
|
Liste de suggestions utilisées pour les recommandations de saisie semi-automatique dans les champs de saisie de texte. |
SuggestionItem
Valeur suggérée que les utilisateurs peuvent saisir dans un champ de saisie de texte.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
text
|
Valeur d'une entrée suggérée dans un champ de saisie de texte. Cela correspond à ce que les utilisateurs saisissent eux-mêmes. |
Validation
Représente les données nécessaires pour valider le widget auquel il est associé.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"characterLimit": integer,
"inputType": enum (
|
Champs | |
---|---|
characterLimit
|
Spécifiez le nombre maximal de caractères pour les widgets de saisie de texte. Notez qu'il n'est utilisé que pour la saisie de texte et qu'il est ignoré pour les autres widgets.
|
inputType
|
Spécifiez le type de widgets d'entrée.
|
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. |
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 qui peuvent être prédites ou énumérées. Pour voir un exemple dans les applications Google Chat, consultez Ajoutez des éléments d'interface utilisateur sélectionnables.
Les applications de chat peuvent traiter la valeur des éléments sélectionnés ou saisis par les utilisateurs. Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire
Pour collecter des données non définies ou abstraites auprès des utilisateurs, utilisez le
TextInput
.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Champs | |
---|---|
name
|
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 du formulaire |
label
|
Texte qui s'affiche au-dessus du champ de saisie de sélection dans l'interface utilisateur. Spécifiez du texte qui aide l'utilisateur à saisir les informations dont votre application a besoin. Par exemple, si les utilisateurs sélectionnent l'urgence d'un ticket de travail dans un menu déroulant, le libellé peut être "Urgence". ou "Sélectionner le degré d'urgence". |
type
|
Type d'éléments présentés aux utilisateurs dans une
|
items[]
|
Tableau d'éléments sélectionnables. Par exemple, un tableau de cases d'option ou de cases à cocher. Jusqu'à 100 éléments sont acceptés. |
onChangeAction
|
Si une valeur 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 du formulaire |
multiSelectMaxSelectedItems
|
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. |
multiSelectMinQueryLength
|
Pour les menus à sélection multiple, nombre de caractères de texte saisis par l'utilisateur avant que l'application n'interroge la saisie semi-automatique et affiche les éléments suggérés 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
|
Pour les menus déroulants, validation de ce champ de saisie de sélection.
|
Champ d'union
|
|
externalDataSource
|
Une source de données externe, telle qu'une base de données relationnelle. |
platformDataSource
|
Une source de données de Google Workspace |
SelectionType
Format des éléments que les utilisateurs peuvent sélectionner. Différentes options permettent différents types d'interactions. Par exemple, les utilisateurs peuvent cocher plusieurs cases, mais ne peuvent sélectionner qu'un seul élément dans un menu déroulant.
Chaque entrée de sélection accepte un type de sélection. Il n'est pas possible, par exemple, de combiner des cases à cocher et des boutons bascules.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
CHECK_BOX
|
Ensemble de cases à cocher. Les utilisateurs peuvent cocher une ou plusieurs cases. |
RADIO_BUTTON
|
Ensemble de cases d'option. Les utilisateurs peuvent sélectionner une case d'option. |
SWITCH
|
Un ensemble d'interrupteurs. Les utilisateurs peuvent activer un ou plusieurs interrupteurs. |
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 multi-sélection, vous pouvez utiliser l'un des types de sources de données suivants:
Pour obtenir des exemples d'implémentation de menus à sélection multiple, consultez la section Ajouter un menu multi-sélection :
|
SelectionItem
Élément que les utilisateurs peuvent sélectionner dans une entrée de sélection, comme une case à cocher ou un commutateur.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "text": string, "value": string, "selected": boolean, "startIconUri": string, "bottomText": string } |
Champs | |
---|---|
text
|
Texte qui identifie ou décrit l'élément pour les utilisateurs. |
value
|
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 les données du formulaire |
selected
|
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. |
startIconUri
|
Pour les menus à sélection multiple, l'URL de l'icône affichée à côté de l'icône
|
bottomText
|
Pour les menus à sélection multiple, une description textuelle ou un libellé qui s'affiche sous le nom de l'élément
|
PlatformDataSource
Pour une
qui utilise un menu multi-sélection, une source de données de Google Workspace. Permet d'afficher les éléments d'un menu multi-sélection.
SelectionInput
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
data_source Source de données.
data_source
ne peut être que l'un des éléments suivants:
|
|
commonDataSource
|
Source de données partagée par toutes les applications Google Workspace, telles que les utilisateurs d'une organisation Google Workspace. |
hostAppDataSource
|
Source de données propre à une application hôte Google Workspace, comme les espaces dans Google Chat. |
CommonDataSource
Une source de données partagée par tous 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 peut uniquement afficher et sélectionner les utilisateurs de son organisation Google Workspace. |
HostAppDataSourceMarkup
Pour une
widget qui utilise un menu multi-sélection, une source de données provenant d'une application Google Workspace. La source de données insère les éléments de sélection pour le menu multi-sélection.
SelectionInput
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
data_source Application Google Workspace qui insère les éléments d'un menu multi-sélection.
data_source
ne peut être que l'un des éléments suivants:
|
|
chatDataSource
|
Source de données de Google Chat |
ChatClientDataSourceMarkup
Pour une
qui utilise un menu multi-sélection, une source de données de Google Chat. La source de données insère les éléments de sélection pour le menu multi-sélection. Par exemple, un utilisateur peut sélectionner les espaces Google Chat dont il fait partie.
SelectionInput
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
source Source de données Google Chat.
source
ne peut être que l'un des éléments suivants:
|
|
spaceDataSource
|
Espaces Google Chat dont l'utilisateur est membre. |
SpaceDataSource
Source de données qui renseigne les espaces Google Chat en tant qu'éléments de sélection pour un menu multi-sélection. Ne remplit que les espaces dont l'utilisateur est membre.
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "defaultToCurrentSpace": boolean } |
Champs | |
---|---|
defaultToCurrentSpace
|
Si défini sur
|
DateTimePicker
Permet aux utilisateurs de saisir une date, une heure, ou les deux. Pour voir un exemple dans les applications Google Chat, consultez Laisser l'utilisateur 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.
Représentation JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Champs | |
---|---|
name
|
Le nom sous lequel
Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez Recevoir les données du formulaire |
label
|
Texte qui invite les utilisateurs à saisir une date, une heure ou une date et une heure. Par exemple, si les utilisateurs planifient un rendez-vous, utilisez une étiquette telle que
|
type
|
Indique si le widget prend en charge la saisie d'une date, d'une heure, ou de la date et l'heure. |
valueMsEpoch
|
La valeur par défaut affichée dans le widget, en millisecondes depuis Heure de l'epoch Unix.
Spécifiez la valeur en fonction du type de sélecteur (
|
timezoneOffsetDate
|
Nombre représentant le décalage de fuseau horaire par rapport à l'heure UTC, en minutes. S'il est défini,
|
onChangeAction
|
Déclenchement lorsque l'utilisateur clique sur
Enregistrer
ou
Effacer
à partir de
|
validation
|
(Facultatif) Spécifiez la validation requise pour ce sélecteur de date et d'heure.
|
DateTimePickerType
Le format de la date et de l'heure dans
DateTimePicker
. Détermine si les utilisateurs peuvent saisir une date, une heure ou les deux.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
DATE_AND_TIME
|
Les utilisateurs saisissent une date et une heure. |
DATE_ONLY
|
Les utilisateurs saisissent une date. |
TIME_ONLY
|
Les utilisateurs saisissent une heure. |
Séparateur
Ce type ne comporte aucun champ.
Affiche un séparateur entre les widgets sous la forme d'une ligne horizontale. Pour voir un exemple dans les applications Google Chat, consultez Ajoutez une séparation horizontale entre les widgets.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Par exemple, le code JSON suivant crée un séparateur:
"divider": {}
Grille
Affiche une grille avec une collection d'éléments. Les éléments ne peuvent inclure que du texte ou des images. Pour les colonnes responsives, ou pour inclure plus que du texte ou des images, utilisez
Pour voir un exemple dans les applications Google Chat, consultez
Afficher une grille contenant une collection d'éléments.
Columns
Une grille peut comporter un nombre illimité de colonnes et d'éléments. Le nombre de lignes est calculé en divisant le nombre d'éléments par le nombre de colonnes. Une grille de 10 éléments et 2 colonnes contient 5 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"
}
}
}
Représentation JSON |
---|
{ "title": string, "items": [ { object ( |
Champs | |
---|---|
title
|
Texte qui s'affiche dans l'en-tête de la grille. |
items[]
|
Éléments à afficher dans la grille. |
borderStyle
|
Style de bordure à appliquer à chaque élément de la grille. |
columnCount
|
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). |
onClick
|
Ce rappel est réutilisé par chaque élément individuel 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.
Représentation JSON |
---|
{ "id": string, "image": { object ( |
Champs | |
---|---|
id
|
Identifiant spécifié par l'utilisateur pour cet élément de la grille. Cet identifiant est renvoyé dans le
|
image
|
Image qui s'affiche dans l'élément de grille. |
title
|
Titre de l'élément de grille. |
subtitle
|
Sous-titre de l'élément de grille. |
layout
|
Mise en page à utiliser pour l'élément de grille. |
ImageComponent
Représente une image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "imageUri": string, "altText": string, "cropStyle": { object ( |
Champs | |
---|---|
imageUri
|
URL de l'image. |
altText
|
Libellé d'accessibilité de l'image. |
cropStyle
|
Style de recadrage à appliquer à l'image. |
borderStyle
|
Style de bordure à appliquer à l'image. |
ImageCropStyle
Représente le style de recadrage appliqué à une image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Par exemple, voici comment appliquer un format 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Représentation JSON |
---|
{
"type": enum (
|
Champs | |
---|---|
type
|
Type de recadrage. |
aspectRatio
|
Le format à utiliser si le type de recadrage est
Par exemple, voici comment appliquer un format 16:9:
|
ImageCropType
Représente le style de recadrage appliqué à une image.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
SQUARE
|
Valeur par défaut. Applique un recadrage carré. |
CIRCLE
|
Applique un recadrage circulaire. |
RECTANGLE_CUSTOM
|
Applique un recadrage rectangulaire avec un format personnalisé. Définissez le format personnalisé avec
aspectRatio
|
RECTANGLE_4_3
|
Applique un recadrage rectangulaire au format 4:3. |
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.
Représentation JSON |
---|
{ "type": enum ( |
Champs | |
---|---|
type
|
Type de bordure. |
strokeColor
|
Les couleurs à utiliser
lorsque le type est
|
cornerRadius
|
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
|
Aperçu. |
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 sont affichés au-dessus de l'image de l'élément de grille. |
Colonnes
La
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 voir 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 hauteur de la première. Étant donné que chaque colonne peut contenir un nombre différent de widgets, vous ne pouvez pas définir de lignes ni aligner les widgets entre les colonnes.
Les colonnes s'affichent côte à côte. Vous pouvez personnaliser la largeur de chaque colonne à l'aide des
HorizontalSizeStyle
. Si la largeur de l'écran de l'utilisateur est trop étroite, la deuxième colonne passe à la ligne en dessous de la première:
- Sur le Web, la deuxième colonne affiche un retour automatique à la ligne si la largeur de l'écran est inférieure ou égale à 480 pixels.
- Sur les appareils iOS, la deuxième colonne renvoie une valeur 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 les
.
Grid
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Représentation JSON |
---|
{
"columnItems": [
{
object (
|
Champs | |
---|---|
columnItems[]
|
Tableau de colonnes. Vous pouvez inclure jusqu'à deux colonnes dans une fiche ou une boîte de dialogue. |
Colonne
Une colonne.
Modules complémentaires Google Workspace et applications Chat
Représentation JSON |
---|
{ "horizontalSizeStyle": enum ( |
Champs | |
---|---|
horizontalSizeStyle
|
Spécifie la façon dont une colonne remplit la largeur de la fiche. |
horizontalAlignment
|
Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne. |
verticalAlignment
|
Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne. |
widgets[]
|
Tableau de widgets inclus dans une colonne. Les widgets apparaissent dans l'ordre dans lequel ils sont spécifiés. |
HorizontalSizeStyle
Spécifie la façon dont une colonne remplit la largeur de la fiche. La largeur de chaque colonne dépend
HorizontalSizeStyle
et la largeur des widgets dans la colonne.
Modules complémentaires Google Workspace et applications Chat
Enums | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
FILL_AVAILABLE_SPACE
|
Valeur par défaut. La colonne remplit l'espace disponible, jusqu'à 70% de la largeur de la fiche. Si les deux colonnes sont définies sur
FILL_AVAILABLE_SPACE , chaque colonne remplit 50% de l'espace.
|
FILL_MINIMUM_SPACE
|
La colonne occupe le moins d'espace possible et ne dépasse pas 30% de la largeur de la fiche. |
HorizontalAlignment
Indique si les widgets sont alignés à gauche, à droite ou au centre d'une colonne.
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Enums | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
START
|
Valeur par défaut. Aligne les widgets sur la position de début de la colonne. Pour les mises en page de gauche à droite, la valeur est alignée sur la gauche. Pour les mises en page de droite à gauche, la ligne est alignée sur la 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 sur la droite. Pour les mises en page de droite à gauche, aligne les widgets sur la gauche. |
VerticalAlignment
Indique si les widgets sont alignés en haut, en bas ou au centre d'une colonne.
Modules complémentaires Google Workspace et applications Chat
Enums | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
CENTER
|
Valeur par défaut. Aligne les widgets au centre d'une colonne. |
TOP
|
Aligne les widgets en haut d'une colonne. |
BOTTOM
|
Aligne les widgets en bas d'une colonne. |
Widgets
Widgets compatibles que vous pouvez inclure dans une colonne.
Modules complémentaires Google Workspace et applications Chat
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
textParagraph
|
|
image
|
|
decoratedText
|
|
buttonList
|
|
textInput
|
|
selectionInput
|
|
dateTimePicker
|
|
chipList
|
|
ChipList
Liste de chips disposés horizontalement, qui peuvent défiler horizontalement ou s'étendre à la ligne suivante.
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "layout": enum ( |
Champs | |
---|---|
layout
|
Mise en page de la liste de chips spécifiée. |
chips[]
|
Tableau de chips. |
Mise en page
Mise en page de la liste de chips.
Enums | |
---|---|
LAYOUT_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
WRAPPED
|
Valeur par défaut. La liste de chips passe à la ligne suivante si l'espace horizontal est insuffisant. |
HORIZONTAL_SCROLLABLE
|
Les chips défilent horizontalement s'ils ne tiennent pas dans l'espace disponible. |
Puce électronique
Texte, icône ou chip de texte et d'icône sur lesquels les utilisateurs peuvent cliquer.
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "icon": { object ( |
Champs | |
---|---|
icon
|
Image de l'icône Si les
|
label
|
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. |
enabled
|
Indique si la puce est active et répond aux actions de l'utilisateur. La valeur par défaut est
|
disabled
|
Indique si la puce est inactive et ignore les actions de l'utilisateur. La valeur par défaut est
|
altText
|
Texte alternatif utilisé pour l'accessibilité. Définissez un texte descriptif qui indique aux utilisateurs à quoi sert le chip. Par exemple, si un chip ouvre un lien hypertexte, écrivez : "Ouvre un nouvel onglet de navigateur et accède à la documentation pour les développeurs Google Chat à l'adresse https://developers.google.com/workspace/chat". |
CollapseControl
Représente une commande d'expansion et de repli.
Disponible pour les applications Google Chat et non disponible pour les modules complémentaires Google Workspace.
Représentation JSON |
---|
{ "horizontalAlignment": enum ( |
Champs | |
---|---|
horizontalAlignment
|
Alignement horizontal des boutons "Développer" et "Réduire". |
expandButton
|
Facultatif. Définissez un bouton personnalisable pour développer la section. Les champs "expandButton" et "Réduire" 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é. |
collapseButton
|
Facultatif. Définissez un bouton personnalisable pour réduire la section. Les champs "expandButton" et "Réduire" 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é. |
DividerStyle
Style de séparateur d'une carte. Actuellement utilisé uniquement pour les séparateurs entre les sections de la fiche.
Disponible pour les applications Google Chat et les modules complémentaires Google Workspace.
Enums | |
---|---|
DIVIDER_STYLE_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
SOLID_DIVIDER
|
Option par défaut. Afficher un séparateur plein entre les sections. |
NO_DIVIDER
|
Si cette option est définie, aucun séparateur n'est affiché entre les sections. |
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 avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.
Représentation JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Champs | |
---|---|
actionLabel
|
Libellé qui s'affiche en tant qu'élément de menu d'actions. |
onClick
|
La
|
DisplayStyle
Dans les modules complémentaires Google Workspace, détermine la façon dont une carte s'affiche.
Disponible avec les modules complémentaires Google Workspace et non disponible dans les applications Google Chat.
Enums | |
---|---|
DISPLAY_STYLE_UNSPECIFIED
|
Ne pas utiliser. Non spécifié. |
PEEK
|
L'en-tête de la carte apparaît au bas de la barre latérale et couvre partiellement la carte supérieure actuelle de la pile. Cliquez sur l'en-tête pour faire apparaître la carte dans la pile. Si la carte n'a pas d'en-tête, un en-tête généré est utilisé à la place. |
REPLACE
|
Valeur par défaut. La carte s'affiche en remplaçant la vue de la carte supérieure dans la pile de cartes. |