Class CardHeader

CardHeader

En-tête d'un élément Card.

Disponible avec les modules complémentaires Google Workspace et les applications Google Chat

var cardHeader = CardService.newCardHeader()
    .setTitle("Card header title")
    .setSubtitle("Card header subtitle")
    .setImageStyle(CardService.ImageStyle.CIRCLE)
    .setImageUrl("https://image.png");

Méthodes

MéthodeType renvoyéBrève description
setImageAltText(imageAltText)CardHeaderDéfinit le texte alternatif de l'image d'en-tête.
setImageStyle(imageStyle)CardHeaderDéfinit le recadrage de l'icône dans l'en-tête de la fiche.
setImageUrl(imageUrl)CardHeaderDéfinit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données.
setSubtitle(subtitle)CardHeaderDéfinit le sous-titre de l'en-tête de la carte.
setTitle(title)CardHeaderDéfinit le titre de l'en-tête de la carte.

Documentation détaillée

setImageAltText(imageAltText)

Définit le texte alternatif de l'image d'en-tête.

Paramètres

NomTypeDescription
imageAltTextStringTexte alternatif de l'image d'en-tête.

Renvois

CardHeader : objet pour le chaînage.


setImageStyle(imageStyle)

Définit le recadrage de l'icône dans l'en-tête de la fiche. Par défaut, aucun recadrage n'est défini. Facultatif.

Paramètres

NomTypeDescription
imageStyleImageStyleParamètre de style.

Renvois

CardHeader : objet pour le chaînage.


setImageUrl(imageUrl)

Définit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données.

L'URL fournie peut être une URL accessible au public ou une chaîne d'image encodée en base64. Pour obtenir ce dernier, vous pouvez utiliser le code suivant afin de créer une chaîne d'image encodée à partir d'une image de votre Google Drive, puis stocker cette chaîne pour une utilisation ultérieure avec setImageUrl(imageUrl). Cette méthode évite que votre module complémentaire n'ait besoin d'accéder à une URL d'image publique:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var encodedImageURL = "data:image/jpeg;base64," + Utilities.base64Encode(imageBytes);

// You can store encodeImageURL and use it as a parameter to CardHeader.setImageUrl(imageUrl).

Paramètres

NomTypeDescription
imageUrlStringAdresse URL d'une image hébergée à utiliser ou chaîne d'image encodée.

Renvois

CardHeader : objet pour le chaînage.


setSubtitle(subtitle)

Définit le sous-titre de l'en-tête de la carte. Facultatif.

Paramètres

NomTypeDescription
subtitleStringTexte du sous-titre de l'en-tête.

Renvois

CardHeader : objet pour le chaînage.


setTitle(title)

Définit le titre de l'en-tête de la carte. Obligatoire.

Paramètres

NomTypeDescription
titleStringTexte de l'en-tête.

Renvois

CardHeader : objet pour le chaînage.