Cards v1

Fiche

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 un séparateur de lignes.

cardActions[]

object (CardAction)

Actions associées à 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 indiquer le titre. 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

string

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

imageStyle

enum (ImageStyle)

Type de l'image (par exemple, bordure carrée ou bordure 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 fiches ont une largeur fixe étroite. Les propriétés de mise en page (par exemple, float, par exemple) ne sont donc pas nécessaires pour le moment.

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 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 de boutons. Les boutons sont également oneof data et un seul de ces champs doit être défini.

Champ d'union data A WidgetMarkup ne peut contenir que l'un des éléments suivants. Vous pouvez utiliser plusieurs 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 du 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 onclick action.

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

string

URL de l'image

onClick

object (OnClick)

La onclick action.

aspectRatio

number

Proportions de cette image (largeur et hauteur). Ce champ vous permet de réserver la hauteur adaptée à l'image en attendant son chargement. Elle n'est pas destinée à remplacer le format intégré de l'image. Si cette règle n'est pas configurée, le serveur la remplit en préchargeant l'image.

OnClick

Une 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 onclick action si 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é son envoi. 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 courant.

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

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

string

Nom du paramètre pour le script d'action.

value

string

Valeur du paramètre.

KeyValue

Un élément d'interface utilisateur contient une clé (étiquette) et une valeur (contenu). Cet élément peut également contenir des actions telles que 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é du haut. Texte mis en forme 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 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 Mettre en forme du texte dans les applications Google Chat et Mettre en forme le 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 Mettre en forme du texte dans les applications Google Chat et Mettre en forme le texte dans les modules complémentaires Google Workspace

onClick

object (OnClick)

La onclick action. Seuls le libellé du haut, le libellé du bas et la zone de contenu sont cliquables.

Champ d'union icons Au moins une des icônes, top_label et bottom_label doit être définie. 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'icône correspondante.

iconUrl

string

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

Champ d'union control Un 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 de type texte ou 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 onclick action.

imageButton

object (ImageButton)

Un bouton avec une image et onclick action.

TextButton

Un bouton avec du texte et onclick action.

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

string

Texte du bouton

onClick

object (OnClick)

La onclick action du bouton.

ImageButton

Un bouton "Image" avec onclick action.

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)

La onclick action.

name

string

Le 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 élément Icon enum ou une URL. icons ne peut être que l'un des éléments suivants:
icon

enum (Icon)

L'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)

L'action "onclick" pour cet élément d'action.