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

Class 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) のいずれかしか設定できません。

// ...

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) のいずれかのみ設定できます。

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(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) のいずれかしか設定できません。

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) のいずれかのみ設定できます。

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) のいずれかのみ設定できます。

パラメータ

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

戻る

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

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

戻る

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 - チェーン用のこのオブジェクト。