Cards v1

Fiche

Une fiche est un élément d'interface utilisateur pouvant 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 de séparation.

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. La hauteur de l'en-tête est fixe : si un titre et un sous-titre sont spécifiés, chacun occupe une ligne. Si seul le titre est spécifié, il occupe les deux lignes.

subtitle

string

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

imageStyle

enum (ImageStyle)

Type de l'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 affichés (verticalement) dans l'ordre dans lequel ils sont spécifiés. Sur toutes les plates-formes, les cartes 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 le texte dans les applications Google Chat et Mettre en forme le 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)
    }
  ],

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Champs
buttons[]

object (Button)

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

Champ d'union data. Un élément WidgetMarkup ne peut contenir que l'un des éléments suivants. Vous pouvez utiliser plusieurs champs WidgetMarkup pour afficher plus d'éléments. data ne peut être que l'un des éléments suivants:
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.

TextParagraph

Un paragraphe de texte. Texte mis en forme accepté. 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.

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

string

Image

Une image spécifiée par une URL et pouvant avoir 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

Rapport d'aspect 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. Elle n'est pas destinée à remplacer le format intégré de l'image. Si cette valeur n'est pas définie, le serveur la remplit en préchargeant l'image.

OnClick

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

Représentation JSON 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Champs

Champ d'union data.

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

action

object (FormAction)

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

FormAction

Une action dans un formulaire décrit le comportement qui s'applique lors de l'envoi du formulaire. 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. Prenons l'exemple de trois boutons de mise en attente: répéter maintenant, répéter un jour et répéter la semaine suivante. Vous pouvez utiliser action method = snooze(), en transmettant le type de rappel et la durée du rappel 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 des actions telles que le bouton onclick.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
Champs
topLabel

string

Texte du libellé supérieur. Texte mis en forme accepté. 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.

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

contentMultiline

boolean

Indique si le contenu doit être multiligne.

bottomLabel

string

Texte du libellé du bas. Texte mis en forme accepté. 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.

onClick

object (OnClick)

Action onclick. Seuls l'étiquette supérieure, l'étiquette inférieure et la région de contenu sont cliquables.

Champ d'union icons. Vous devez définir au moins l'un des éléments suivants : icônes, top_label et bottom_label. icons ne peut être que l'un des éléments suivants:
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.

Champ d'union control. Widget de contrôle. Vous pouvez définir button ou switch_widget, mais pas les deux. control ne peut être que l'un des éléments suivants:
button

object (Button)

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

Icône

Ensemble des 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

Un bouton. Il peut s'agir d'un bouton textuel ou d'un bouton image.

Représentation JSON 
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Champs

Champ d'union type.

type ne peut être que l'un des éléments suivants:

textButton

object (TextButton)

Un bouton avec du texte et une action onclick

imageButton

object (ImageButton)

Un bouton avec une image et l'action onclick

TextButton

Bouton avec texte et action onclick.

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

string

Texte du bouton

onClick

object (OnClick)

Action onclick du bouton.

ImageButton

Un bouton Image avec une action onclick.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
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é.

Champ d'union icons. L'icône peut être spécifiée par un Icon, un enum ou une URL. icons ne peut être que l'un des éléments suivants:
icon

enum (Icon)

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

iconUrl

string

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

CardAction

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

Non compatible avec les applications Google Chat.

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

string

Libellé qui apparaissait dans l'élément de menu d'actions.

onClick

object (OnClick)

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