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)

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

パラメータ

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

戻る

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

パラメータ

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

戻る

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

setComposeAction(action, composedEmailType)

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

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

// ...

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();
}

パラメータ

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

戻る

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

setIcon(icon)

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

パラメータ

名前型説明
iconIcon定義済みの Icon 値のいずれか。

戻る

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

setIconUrl(url)

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

パラメータ

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

戻る

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

setImageButtonStyle(imageButtonStyle)

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

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

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

パラメータ

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

戻る

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

setMaterialIcon(icon)

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

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

パラメータ

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

戻る

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

setOnClickAction(action)

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

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();
}

パラメータ

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

戻る

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();
}

パラメータ

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

戻る

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

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

パラメータ

名前型説明
openLinkOpenLink開く 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();

パラメータ

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

戻る

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