Class TextButton

TextButton

テキスト ラベル付きの TextButton。必要に応じて、背景色を設定したり、ボタンを無効にしたりできます。

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

メソッド

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

詳細なドキュメント

setAltText(altText)

ユーザー補助機能用のボタンの代替テキストを設定します。設定しない場合、デフォルトではボタンに表示されるテキストになります。

パラメータ

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setBackgroundColor(backgroundColor)

TextButtonStyle.FILLED ボタンの背景色を設定します。TextButtonStyle.FILLED ボタンに設定されていない場合、ボタンはアドオン マニフェストで定義されているセカンダリ カラーを使用します。 このメソッドは、TextButtonStyle.OUTLINED ボタンでは何も行いません。

パラメータ

名前	タイプ	説明
backgroundColor	String	カラー（#rgb 形式）。

戻る

TextButton - このオブジェクト（チェーン用）。

---

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setDisabled(disabled)

ボタンを無効にするかどうかを設定します。無効になっているボタンはグレー表示になり、クリックできません。

パラメータ

名前	タイプ	説明
disabled	Boolean	無効状態。

戻る

TextButton - このオブジェクト（チェーン用）。

---

setIcon(icon)

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

パラメータ

名前	タイプ	説明
icon	Icon	定義済みの Icon 値のいずれか。

戻る

TextButton - このオブジェクト（チェーン用）。

---

setIconUrl(url)

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

パラメータ

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setMaterialIcon(icon)

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

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

パラメータ

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setOpenLink(openLink)

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

パラメータ

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setOverflowMenu(menu)

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

Google Chat アプリで利用できます。Google Workspace アドオンのデベロッパー プレビューで利用できます。

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

戻る

TextButton - このオブジェクト（チェーン用）。

---

setText(text)

ボタンに表示するテキストを設定します。

パラメータ

名前	タイプ	説明
text	String	ボタンに表示されるテキスト。

戻る

TextButton - このオブジェクト（チェーン用）。

---

setTextButtonStyle(textButtonStyle)

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

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

パラメータ

名前	タイプ	説明
textButtonStyle	TextButtonStyle	ボタンのスタイル。

戻る

TextButton - このオブジェクト（チェーン用）。