Class CardHeader

CardHeader

Card 的标头。

适用于 Google Workspace 插件和 Google Chat 应用。

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

方法

方法	返回类型	简介
setImageAltText(imageAltText)	CardHeader	设置标题图片的替代文本。
setImageStyle(imageStyle)	CardHeader	设置卡片标题中图标的裁剪。
setImageUrl(imageUrl)	CardHeader	通过提供图片的网址或数据字符串，设置要在标头中使用的图片。
setSubtitle(subtitle)	CardHeader	设置卡片标题的副标题。
setTitle(title)	CardHeader	设置卡片标题的标题。

详细文档

setImageAltText(imageAltText)

设置标题图片的替代文本。

参数

名称	类型	说明
imageAltText	String	标题图片的替代文本。

返回

CardHeader - 此对象，用于链接。

---

setImageStyle(imageStyle)

设置对卡片标题中图标的裁剪。默认为不剪裁。可选。

参数

名称	类型	说明
imageStyle	ImageStyle	样式设置。

返回

CardHeader - 此对象，用于链接。

---

setImageUrl(imageUrl)

通过提供图片的网址或数据字符串，设置要在标头中使用的图片。

提供的网址可以是可公开访问的网址，也可以是 base64 编码的图片字符串。 要获得后者，您可以使用以下代码，根据 图片，然后存储该字符串，以便日后与 setImageUrl(imageUrl) 搭配使用。使用此方法时，您的插件无需公开访问 可用的图片网址：

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

参数

名称	类型	说明
imageUrl	String	要使用的托管图片的网址，或经过编码的图片字符串。

返回

CardHeader - 此对象，用于链接。

---

setSubtitle(subtitle)

设置卡片标题的副标题。可选。

参数

名称	类型	说明
subtitle	String	标头副标题文本。

返回

CardHeader - 此对象，用于链接。

---

setTitle(title)

设置卡片标题的标题。必填。

参数

名称	类型	说明
title	String	标题文本。

返回

CardHeader - 此对象，用于实现链式连接。