Cards v2

object (CardHeader)

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

object (Section)

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

enum (DividerStyle)

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

object (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 indisponible 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:

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

string

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

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

object (CardFixedFooter)

Pied de page fixe affiché au bas de cette fiche.

Définir fixedFooter sans spécifier primaryButton ou secondaryButton entraîne une erreur. Pour les applications Chat, vous pouvez utiliser des pieds de page fixes dans les boîtes de dialogue, mais pas dans les messages de carte.

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

enum (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.

object (CardHeader)

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

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

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.

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

object (Widget)

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

boolean

Indique si cette section peut être réduite.

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

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

integer

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

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

object (CollapseControl)

Facultatif. Définissez les boutons d'expansion et de réduction de la section. Ce bouton ne s'affiche que si la section est réductible. Si ce champ n'est pas défini, le bouton par défaut est utilisé. Disponible pour les applications Google Chat et indisponible pour les modules complémentaires Google Workspace.

enum (HorizontalAlignment)

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

object (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 les articles 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>"
}

object (Image)

Affiche une image.

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

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

object (DecoratedText)

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

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

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

object (ButtonList)

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

object (TextInput)

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

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

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

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

object (SelectionInput)

Affiche une commande de sélection permettant 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:

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

object (DateTimePicker)

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

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

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

object (Divider)

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

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

"divider": {
}

object (Grid)

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

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

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

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

string

Texte affiché dans le widget.

integer

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

La valeur par défaut est 0, ce qui signifie que tout le contexte est affiché. Les valeurs négatives sont ignorées. Disponible pour les applications Google Chat et indisponible 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

object (OnClick)

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

string

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

object (Action)

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

object (OpenLink)

Si elle est spécifiée, cette onClick déclenche une action d'ouverture de lien.

object (Action)

Un module complémentaire déclenche cette action lorsqu'il doit ouvrir un lien. Cela diffère du openLink 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.

object (Card)

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

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

object (OverflowMenu)

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

string

Fonction personnalisée à appeler lorsque l'utilisateur clique sur l'élément contenant ou l'active de toute autre manière.

Pour obtenir un exemple d'utilisation, consultez la section Lire les données du formulaire.

object (ActionParameter)

Liste des paramètres d'action.

enum (LoadIndicator)

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

boolean

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

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

enum (Interaction)

Facultatif. Obligatoire à l'ouverture d'une 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 elle n'est pas spécifiée, l'application répond en exécutant une 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 cette valeur est spécifiée pour un module complémentaire, la fiche entière est supprimée et rien n'est affiché dans le client.

Disponible pour les applications Google Chat et non disponible 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.

boolean

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.

string

URL à ouvrir.

enum (OpenAs)

Comment ouvrir un lien

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

enum (OnClose)

Indique si le client a oublié un lien après l'avoir ouvert ou l'observe jusqu'à la fermeture de la fenêtre.

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

object (OverflowMenuItem)

Obligatoire. Liste des options du menu.

object (Icon)

Icône affichée devant le texte.

string

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

object (OnClick)

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

boolean

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

string

Facultatif. Description de l'icône utilisée pour l'accessibilité. Si aucune valeur n'est spécifiée, la valeur par défaut Button est fournie. Il est recommandé de définir une description utile de ce que l'icône affiche et, le cas échéant, de son fonctionnement. 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 élément Button, altText apparaît en tant que 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é.

enum (ImageType)

Style de recadrage appliqué à l'image. Dans certains cas, l'application d'un recadrage CIRCLE entraîne l'affichage de l'image plus grande qu'une icône intégrée.

string

Afficher 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 les icônes intégrées.

string

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

Exemple :

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

Les types de fichiers acceptés incluent .png et .jpg.

object (MaterialIcon)

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

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

"materialIcon": {
  "name": "check_box"
}

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

string

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

boolean

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

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

integer

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

integer

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.

object (Icon)

Obsolète et remplacé par startIcon.

object (Icon)

Icône affichée devant le texte.

string

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

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.

boolean

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.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

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

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

string

Texte affiché dans le bouton.

object (Icon)

Icône affichée dans le bouton. Si les valeurs icon et text sont définies, l'icône s'affiche avant le texte.

object (Color)

Facultatif. Couleur du bouton. Si elle 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 en blanc.

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

Par exemple, l'exemple suivant définit la couleur rouge à son intensité maximale :

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

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

object (OnClick)

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

boolean

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 de substitution utilisé pour l'accessibilité.

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

enum (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 forcé sur FILLED 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.

number

Quantité de rouge dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Quantité de vert dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Quantité de bleu dans la couleur en tant que valeur dans l'intervalle [0, 1].

number

Fraction de cette couleur à appliquer au pixel. En d'autres termes, la couleur finale du pixel est définie par l'équation :

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

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

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

boolean

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

object (Action)

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

enum (ControlType)

Affichage du bouton dans l'interface utilisateur

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

object (Button)

Tableau de boutons.

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 apparaît au-dessus du champ de saisie 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 de texte pour aider les utilisateurs à saisir une valeur spécifique. Ce texte est toujours visible.

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

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

enum (Type)

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

object (Action)

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

Exemples d'actions à effectuer : exécuter une fonction personnalisée ou ouvrir une boîte de dialogue dans Google Chat.

object (Suggestions)

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

Par exemple, un champ de saisie de texte pour un langage de programmation peut suggérer Java, JavaScript, Python et C++. Lorsque les utilisateurs commencent à saisir Jav, la liste des suggestions se filtre pour 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 des JavaScript, vous pouvez standardiser la façon dont les utilisateurs interagissent avec votre application.

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

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

object (Action)

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

Si 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 spécifiée ici, comme exécuter une fonction personnalisée.

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

object (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. Exemple : Enter a number from 0 to 100.

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

Action

Navigation

Transmettre ou mettre à jour les fiches affichées

Card

La pile de cartes pousse une carte sur la pile de cartes.

Card

La pile de cartes remplace la carte du dessus par une nouvelle carte et conserve les valeurs des champs de formulaire remplis. Pour un champ non équivalent, la valeur est supprimée.

object (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. Il s'agit de ce que les utilisateurs saisissent eux-mêmes.

integer

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

enum (InputType)

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

string

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

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

string

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

enum (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.

object (SelectionItem)

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

object (Action)

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

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

integer

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.

integer

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 immédiatement renseignés.
• 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.

object (Validation)

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

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

object (Action)

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

object (PlatformDataSource)

Source de données Google Workspace.

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 de formulaire.

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

boolean

Indique si l'élément est sélectionné par défaut. Si la zone de saisie de sélection n'accepte qu'une seule valeur (par exemple, pour les cases d'option ou un menu déroulant), ne définissez ce champ que 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. 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.

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

object (ChatClientDataSourceMarkup)

Source de données Google Chat.

object (SpaceDataSource)

Espaces Google Chat dont l'utilisateur est membre

boolean

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

string

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

Pour en savoir plus sur l'utilisation des entrées de formulaire, consultez la section Recevoir des 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.

enum (DateTimePickerType)

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

string (int64 format)

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

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

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

integer

Nombre représentant le décalage horaire par rapport à UTC, en minutes. Si ce paramètre est défini, valueMsEpoch s'affiche dans le fuseau horaire spécifié. Si ce champ n'est pas défini, la valeur par défaut est le fuseau horaire de l'utilisateur.

object (Action)

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

object (Validation)

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

string

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

object (GridItem)

Éléments à afficher dans la grille.

object (BorderStyle)

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

integer

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

object (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.

object (ImageComponent)

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

enum (GridItemLayout)

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

string

URL de l'image.

string

Libellé d'accessibilité de l'image.

object (ImageCropStyle)

Style de recadrage à appliquer à l'image.

object (BorderStyle)

Style de bordure à appliquer à l'image.

enum (ImageCropType)

Type de recadrage.

number

Format à utiliser si le type de recadrage est RECTANGLE_CUSTOM.

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

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

enum (BorderType)

Type de bordure.

object (Color)

Couleurs à utiliser lorsque le type est BORDER_TYPE_STROKE.

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

Par exemple, l'exemple suivant définit la couleur rouge à son intensité maximale :

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

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

integer

Rayon d'angle de la bordure.

object (Column)

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

enum (HorizontalSizeStyle)

Indique comment une colonne remplit la largeur de la fiche.

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

object (TextParagraph)

Widget TextParagraph.

object (Image)

Widget Image

object (DecoratedText)

Widget DecoratedText

object (ButtonList)

Widget ButtonList

object (TextInput)

Widget TextInput

object (SelectionInput)

Widget SelectionInput.

object (DateTimePicker)

Widget DateTimePicker

object (ChipList)

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

enum (Layout)

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

object (Chip)

Tableau de chips.

object (Icon)

Image de l'icône. Si les valeurs icon et text sont définies, l'icône s'affiche avant le texte.

string

Texte affiché dans le chip.

object (OnClick)

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

boolean

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

boolean

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

string

Texte de substitution utilisé pour l'accessibilité.

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

enum (HorizontalAlignment)

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

object (Button)

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

object (Button)

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

string

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

object (OnClick)

L'action onClick pour cette tâche.

object (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.

object (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.