Cards v1

Carte

Une carte est un élément d'interface utilisateur qui peut contenir des widgets d'interface utilisateur tels que du texte et des images.

Représentation JSON 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Champs
header

object (CardHeader)

En-tête de la carte. Un en-tête contient généralement un titre et une image.

sections[]

object (Section)

Les sections sont séparées par une ligne.

cardActions[]

object (CardAction)

Actions de cette fiche.

name

string

Nom de la carte.

CardHeader

Représentation JSON 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Champs
title

string

Vous devez spécifier le titre. L'en-tête a une hauteur fixe : si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.

subtitle

string

Sous-titre de l'en-tête de la fiche.

imageStyle

enum (ImageStyle)

Type d'image (par exemple, bordure carrée ou circulaire).

imageUrl

string

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

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Bordure carrée.
AVATAR Bordure circulaire.

Section

Une section contient un ensemble de widgets qui sont affichés (verticalement) dans l'ordre dans lequel ils sont spécifiés. Sur toutes les plates-formes, les fiches ont une largeur fixe étroite. Il n'est donc pas nécessaire d'utiliser des propriétés de mise en page (par exemple, float).

Représentation JSON 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Champs
header

string

En-tête de la section. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

widgets[]

object (WidgetMarkup)

Une section doit contenir au moins un widget.

WidgetMarkup

Un widget est un élément d'interface utilisateur qui présente du texte et des images.

Représentation JSON 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Champs
buttons[]

object (Button)

Liste de boutons. "Buttons" est également oneof data, et un seul de ces champs doit être défini.

Un WidgetMarkup ne peut comporter qu'un seul des éléments suivants. Vous pouvez utiliser plusieurs champs WidgetMarkup pour afficher plus d'éléments. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
textParagraph

object (TextParagraph)

Affichez un paragraphe de texte dans ce widget.

image

object (Image)

Affichez une image dans ce widget.

keyValue

object (KeyValue)

Affichez un élément clé-valeur dans ce widget.

Fin des champs mutuellement exclusifs.

TextParagraph

Un paragraphe de texte. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

Représentation JSON 
{
  "text": string
}
Champs
text

string

Image

Image spécifiée par une URL et pouvant comporter une action onclick.

Représentation JSON 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Champs
imageUrl

string

URL de l'image

onClick

object (OnClick)

L'action onclick.

aspectRatio

number

Le format de cette image (largeur et hauteur). Ce champ vous permet de réserver la bonne hauteur pour l'image en attendant qu'elle se charge. Il n'est pas destiné à remplacer le format intégré de l'image. Si ce champ n'est pas défini, le serveur le remplit en préchargeant l'image.

OnClick

Une action onclick (par exemple, ouvrir un lien).

Représentation JSON 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
action

object (FormAction)

Une action de formulaire est déclenchée par cette action onclick, si elle est spécifiée.

Fin des champs mutuellement exclusifs.

FormAction

Une action de formulaire décrit le comportement à adopter lorsque le formulaire est envoyé. Par exemple, vous pouvez appeler Apps Script pour gérer le formulaire.

Représentation JSON 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Champs
actionMethodName

string

Le nom de la méthode permet d'identifier la partie du formulaire qui a déclenché l'envoi du formulaire. Ces informations sont renvoyées à l'application Chat dans le cadre de l'événement de clic sur la fiche. Vous pouvez utiliser le même nom de méthode pour plusieurs éléments qui déclenchent un comportement commun.

parameters[]

object (ActionParameter)

Liste des paramètres d'action.

ActionParameter

Liste des paramètres de chaîne à fournir lorsque la méthode d'action est appelée. Par exemple, imaginez trois boutons de report : "Reporter maintenant", "Reporter d'un jour" et "Reporter à la semaine prochaine". Vous pouvez utiliser action method = snooze() en transmettant le type et la durée de répétition dans la liste des paramètres de chaîne.

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string

Nom du paramètre du script d'action.

value

string

Valeur du paramètre.

KeyValue

Un élément d'interface utilisateur contient une clé (libellé) et une valeur (contenu). Cet élément peut également contenir certaines actions, comme le bouton onclick.

Représentation JSON 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Champs
topLabel

string

Texte du libellé supérieur. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

content

string

Texte du contenu. Le texte mis en forme est accepté et toujours obligatoire. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

contentMultiline

boolean

Indique si le contenu doit être multiligne.

bottomLabel

string

Texte du libellé inférieur. Le texte mis en forme est accepté. Pour en savoir plus sur la mise en forme du texte, consultez Mettre en forme du texte dans les applications Google Chat et Mettre en forme du texte dans les modules complémentaires Google Workspace.

onClick

object (OnClick)

L'action onclick. Seuls le libellé supérieur, le libellé inférieur et la zone de contenu sont cliquables.

Vous devez définir au moins l'un des éléments suivants : icons, top_label et bottom_label. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
icon

enum (Icon)

Valeur d'énumération remplacée par l'API Chat par l'image d'icône correspondante.

iconUrl

string

Icône spécifiée par une URL.

Fin des champs mutuellement exclusifs.
Un widget de contrôle. Vous pouvez définir button ou switch_widget, mais pas les deux. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
button

object (Button)

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

Fin des champs mutuellement exclusifs.

Icône

Ensemble d'icônes compatibles.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Bouton

Bouton A. Il peut s'agir d'un bouton de texte ou d'un bouton d'image.

Représentation JSON 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Champs
Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
textButton

object (TextButton)

Bouton avec du texte et une action onclick.

imageButton

object (ImageButton)

Bouton avec image et action onclick.

Fin des champs mutuellement exclusifs.

TextButton

Bouton avec du texte et une action onclick.

Représentation JSON 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Champs
text

string

Texte du bouton

onClick

object (OnClick)

Action onclick du bouton.

ImageButton

Bouton d'image avec une action onclick.

Représentation JSON 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Champs
onClick

object (OnClick)

L'action onclick.

name

string

Nom de ce imageButton utilisé pour l'accessibilité. Une valeur par défaut est fournie si ce nom n'est pas spécifié.

L'icône peut être spécifiée par un Icon enum ou une URL. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
icon

enum (Icon)

Icône spécifiée par un enum qui renvoie à une icône fournie par l'API Chat.

iconUrl

string

Icône spécifiée par une URL.

Fin des champs mutuellement exclusifs.

CardAction

Une action de fiche est l'action associée à la fiche. Pour une fiche de facture, une action classique serait de supprimer la facture, de l'envoyer par e-mail ou de l'ouvrir dans un navigateur.

Non compatible avec les applications Chat.

Représentation JSON 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Champs
actionLabel

string

Libellé utilisé pour l'affichage dans l'élément de menu d'action.

onClick

object (OnClick)

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