Class CardHeader

CardHeader

Card のヘッダー。

Google Workspace アドオンと Google Chat アプリで利用できます。

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

詳細なドキュメント

setImageAltText(imageAltText)

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

パラメータ

名前	タイプ	説明
imageAltText	String	ヘッダー画像の代替テキスト。

戻る

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

---

setImageStyle(imageStyle)

カードのヘッダーにあるアイコンの切り抜きを設定します。デフォルトでは切り抜きは行われません。省略可。

パラメータ

名前	タイプ	説明
imageStyle	ImageStyle	スタイル設定。

戻る

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

---

setImageUrl(imageUrl)

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

指定された URL は、一般公開されている URL または base64 でエンコードされた画像文字列のいずれかになります。後者を取得するには、次のコードを使用して Google ドライブの画像からエンコードされた画像文字列を作成し、その文字列を保存して後で setImageUrl(imageUrl) で使用します。この方法では、アドオンが一般公開されている画像 URL にアクセスする必要がなくなります。

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

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

パラメータ

名前	タイプ	説明
imageUrl	String	使用するホスト画像の URL アドレス、またはエンコードされた画像文字列。

戻る

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

---

setSubtitle(subtitle)

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

パラメータ

名前	タイプ	説明
subtitle	String	ヘッダーのサブタイトル テキスト。

戻る

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

---

setTitle(title)

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

パラメータ

名前	タイプ	説明
title	String	ヘッダー テキスト。

戻る

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