Class ImageButton

ImageButton

画像が表示された ImageButton。

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

メソッド

メソッド	戻り値の型	概要
setAltText(altText)	ImageButton	ユーザー補助機能用にボタンの代替テキストを設定します。
setAuthorizationAction(action)	ImageButton	オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)	ImageButton	オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setIcon(icon)	ImageButton	ボタンに表示する定義済みの Icon を設定します。
setIconUrl(url)	ImageButton	このボタンのアイコンとして使用する画像の URL を設定します。
setImageButtonStyle(imageButtonStyle)	ImageButton	ボタンのスタイルを設定します。
setMaterialIcon(icon)	ImageButton	マテリアル デザインのアイコンを設定します。
setOnClickAction(action)	ImageButton	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	ImageButton	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
setOpenLink(openLink)	ImageButton	オブジェクトがクリックされたときに開く URL を設定します。
setOverflowMenu(menu)	ImageButton	オブジェクトがクリックされたときに開くポップアップ メニューを設定します。

詳細なドキュメント

setAltText(altText)

ユーザー補助機能用にボタンの代替テキストを設定します。必須。

パラメータ

名前	型	説明
altText	String	このボタンに割り当てる代替テキスト。

戻る

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

---

setAuthorizationAction(action)

オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。新しいウィンドウで URL が開きます。ユーザーが認可フローを完了してアプリに戻ると、アドオンが再読み込みされます。

UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかしか設定できません。

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

パラメータ

名前	型	説明
action	AuthorizationAction	この要素がクリックされたときに実行する認可アクションを指定するオブジェクト。

戻る

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

---

setComposeAction(action, composedEmailType)

オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかのみ設定できます。

Action パラメータには、ComposeActionResponseBuilder.setGmailDraft(draft) を使用して構成された ComposeActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

注: このメソッドでは、Compose UI の拡張に使用される Compose アクションは設定されません。代わりに、このメソッドは、この UI 要素を Action に接続します。この Action は、アクションの完了時に Gmail で開かれる Apps Script で下書きメッセージを作成します。

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

パラメータ

名前	型	説明
action	Action	この要素がクリックされたときに実行するコンポーズ アクションを指定するオブジェクト。
composedEmailType	ComposedEmailType	作成された下書きがスタンドアロンか返信の下書きかを指定する列挙型値。

戻る

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

---

setIcon(icon)

ボタンに表示する定義済みの Icon を設定します。ボタン画像を定義するには、この値または setIconUrl(url) のいずれかを使用する必要があります。

パラメータ

名前	型	説明
icon	Icon	事前定義された Icon 値のいずれか。

戻る

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

---

setIconUrl(url)

このボタンのアイコンとして使用する画像の URL を設定します。ボタン画像を定義するには、この値または setIcon(icon) のいずれかを使用する必要があります。

パラメータ

名前	型	説明
url	String	このボタンのアイコンとして使用するホストされている画像の URL アドレス。

戻る

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

---

setImageButtonStyle(imageButtonStyle)

ボタンのスタイルを設定します。設定しない場合、デフォルトは ImageButtonStyle.BORDERLESS ボタンになります。

Google Chat アプリでのみ使用できます。Google Workspace アドオンには使用できません。

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

パラメータ

名前	型	説明
imageButtonStyle	ImageButtonStyle	ボタンのスタイル。

戻る

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

---

setMaterialIcon(icon)

マテリアル デザインのアイコンを設定します。

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

パラメータ

名前	型	説明
icon	MaterialIcon	マテリアル デザインのアイコン。

戻る

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

---

setOnClickAction(action)

オブジェクトがクリックされたときに実行されるアクションを設定します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかしか設定できません。

Action パラメータには、ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

パラメータ

名前	型	説明
action	Action	この要素がクリックされたときに実行するアクション。

戻る

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

---

setOnClickOpenLinkAction(action)

オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。この関数は、URL をビルドする必要がある場合や、OpenLink オブジェクトの作成に加えて他のアクションを実行する必要がある場合に使用します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかしか設定できません。

Action パラメータには、ActionResponseBuilder.setOpenLink(openLink) を使用して構成された ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

パラメータ

名前	型	説明
action	Action	この要素がクリックされたときに実行するリンクを開くアクションを指定するオブジェクト。

戻る

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

---

setOpenLink(openLink)

オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっていて、開くだけでよい場合に使用します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかしか設定できません。

パラメータ

名前	型	説明
openLink	OpenLink	開く URL を記述する OpenLink オブジェクト。

戻る

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

---

setOverflowMenu(menu)

オブジェクトがクリックされたときに開くポップアップ メニューを設定します。メニューの各アイテムには、クリック時にトリガーされるアクションを指定できます。ネストされたメニューはサポートされていません。メニュー項目のアクションでオーバーフロー メニューを指定しないでください。

Google Chat アプリでのみ使用できます。Google Workspace アドオンには使用できません。

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

パラメータ

名前	型	説明
menu	OverflowMenu	この要素がクリックされたときに表示するオーバーフロー メニューを指定するオブジェクト。

戻る

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