Class TextButton

TextButton

テキストラベルを含む TextButton。背景色を設定してボタンを無効にできます できます。

Google Workspace アドオンと Google Chat アプリでご利用いただけます。

var 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	ボタンを無効にするかどうかを設定します。
setOnClickAction(action)	TextButton	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	TextButton	オブジェクトがクリックされたときにタブで URL を開くアクションを設定します。
setOpenLink(openLink)	TextButton	オブジェクトがクリックされたときに開く URL を設定します。
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 つのみを設定できます。

// ...

var 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 オブジェクトを返すコールバック関数を指定する必要があります。

<ph type="x-smartling-placeholder">

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

// ...

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

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

パラメータ

名前	型	説明
action	Action	この要素が呼び出されたときに実行する作成アクションを指定するオブジェクト クリックします。
composedEmailType	ComposedEmailType	作成された下書きが [スタンドアロン] または [返信の下書き] を選択します。

戻る

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

---

setDisabled(disabled)

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

パラメータ

名前	型	説明
disabled	Boolean	無効状態。

戻る

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

---

setOnClickAction(action)

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

Action パラメータには、ActionResponse オブジェクトを返すコールバック関数を指定する必要があります。

// ...

var 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 オブジェクトを返すコールバック関数を指定する必要があります。

// ...

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

---

setText(text)

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

パラメータ

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

戻る

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

---

setTextButtonStyle(textButtonStyle)

ボタンのスタイルを設定します。設定しない場合、デフォルトで TextButtonStyle.OUTLINED ボタンが使用されます。

パラメータ

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

戻る

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