このページは Cloud Translation API によって翻訳されました。

Class Button

すべてのボタンの基本クラス。

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

メソッド

メソッド	戻り値の型	概要
`setAuthorizationAction(action)`	`Button`	オブジェクトがクリックされたときに、認可フローの URL を開く認可アクションを設定します。
`setComposeAction(action, composedEmailType)`	`Button`	オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
`setOnClickAction(action)`	`Button`	オブジェクトがクリックされたときに実行されるアクションを設定します。
`setOnClickOpenLinkAction(action)`	`Button`	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
`setOpenLink(openLink)`	`Button`	オブジェクトがクリックされたときに開く URL を設定します。
`setOverflowMenu(menu)`	`Button`	オブジェクトがクリックされたときにポップアップメニューが開くように設定します。

詳細なドキュメント

`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`	この要素がクリックされたときに行う承認アクションを指定するオブジェクト。

戻る

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

`setComposeAction(action, composedEmailType)`

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

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

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

// ...

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`	作成された下書きがスタンドアロンか返信の下書きかを指定する列挙型値。

戻る

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

`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`	この要素がクリックされたときに実行するアクション。

戻る

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

`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`	この要素がクリックされたときに実行するリンクを開くアクションを指定するオブジェクト。

戻る

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

`setOpenLink(openLink)`

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

パラメータ

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

戻る

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

`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`	この要素がクリックされたときに表示するオーバーフローメニューを指定するオブジェクト。

戻る

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