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

詳細なドキュメント

setImageAltText(imageAltText)

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

パラメータ

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

戻る

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

setImageStyle(imageStyle)

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

パラメータ

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

戻る

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

パラメータ

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

戻る

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

setSubtitle(subtitle)

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

パラメータ

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

戻る

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

setTitle(title)

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

パラメータ

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

戻る

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