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)CardHeaderURL またはデータ文字列を指定して、ヘッダーで使用する画像を設定します。
setSubtitle(subtitle)CardHeaderカードヘッダーのサブタイトルを設定します。
setTitle(title)CardHeaderカードヘッダーのタイトルを設定します。

詳細なドキュメント

setImageAltText(imageAltText)

ヘッダー画像の代替テキストを設定します。

パラメータ

名前型説明
imageAltTextStringヘッダー画像の代替テキスト。

戻る

CardHeader - チェーン用のオブジェクト。

setImageStyle(imageStyle)

カードヘッダーのアイコンの切り抜きを設定します。デフォルトは切り抜きなしです。省略可。

パラメータ

名前型説明
imageStyleImageStyleスタイル設定。

戻る

CardHeader - チェーン用のオブジェクト。

setImageUrl(imageUrl)

URL またはデータ文字列を指定して、ヘッダーで使用する画像を設定します。

提供される URL は、一般公開されている URL か、base64 でエンコードされた画像文字列のいずれかです。 後者を取得するには、次のコードを使用して、エンコードされた画像文字列を 保存して、後で setImageUrl(imageUrl) で使用できるように文字列を保存します。この方法により、アドオンが一般公開の 画像の URL: 

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

パラメータ

名前型説明
imageUrlString使用するホストされている画像の URL アドレス、またはエンコードされた画像文字列。

戻る

CardHeader - チェーン用のオブジェクト。

setSubtitle(subtitle)

カードヘッダーのサブタイトルを設定します。省略可。

パラメータ

名前型説明
subtitleStringヘッダーのサブタイトル テキスト。

戻る

CardHeader - チェーン用のオブジェクト。

setTitle(title)

カードヘッダーのタイトルを設定します。必須。

パラメータ

名前型説明
titleStringヘッダーのテキスト。

戻る

CardHeader - チェーン用のオブジェクト。