Class 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) のいずれか 1 つのみです。

// ...

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) のいずれか 1 つのみです。

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

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

// ...

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

// ...

function composeEmailCallback(e) {
  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) のいずれか 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();
}

パラメータ

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

戻る

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

`setOnClickOpenLinkAction(action)`

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

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) のいずれか 1 つのみです。

パラメータ

名前	タイプ	説明
`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 \- チェーン用のこのオブジェクト。

Class ImageButton コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

setAltText(altText)

パラメータ

戻る

setAuthorizationAction(action)

パラメータ

戻る

setComposeAction(action, composedEmailType)

パラメータ

戻る

setIcon(icon)

パラメータ

戻る

setIconUrl(url)

パラメータ

戻る

setImageButtonStyle(imageButtonStyle)

パラメータ

戻る

setMaterialIcon(icon)

パラメータ

戻る

setOnClickAction(action)

パラメータ

戻る

setOnClickOpenLinkAction(action)

パラメータ

戻る

setOpenLink(openLink)

パラメータ

戻る

setOverflowMenu(menu)

パラメータ

戻る

Class ImageButton

`setAltText(altText)`

`setAuthorizationAction(action)`

`setComposeAction(action, composedEmailType)`

`setIcon(icon)`

`setIconUrl(url)`

`setImageButtonStyle(imageButtonStyle)`

`setMaterialIcon(icon)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setOverflowMenu(menu)`