Class TextButton

TextButton

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

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

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

Methods

メソッド戻り値の型概要
setAltText(altText)TextButtonユーザー補助機能向けにボタンの代替テキストを設定します。
setAuthorizationAction(action)TextButtonオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setBackgroundColor(backgroundColor)TextButtonTextButtonStyle.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)

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

パラメータ

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

リターン

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


setAuthorizationAction(action)

オブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。新しいウィンドウで URL が開きます。ユーザーが認証フローを完了してアプリケーションに戻ると、アドオンが再読み込みされます。

UI オブジェクトには、setOpenLink(openLink)setOnClickAction(action)setOnClickOpenLinkAction(action)setAuthorizationAction(action)setComposeAction(action, composedEmailType) のいずれかのみを設定できます。

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

パラメータ

名前説明
actionAuthorizationActionこの要素がクリックされたときに行う承認アクションを指定するオブジェクト。

リターン

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


setBackgroundColor(backgroundColor)

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

パラメータ

名前説明
backgroundColorString#RGB 形式の色。

リターン

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


setComposeAction(action, composedEmailType)

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

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

// ...

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();
}

パラメータ

名前説明
actionActionこの要素がクリックされたときに行う作成アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成された下書きが単独の下書きか返信の下書きかを指定する列挙値。

リターン

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


setDisabled(disabled)

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

パラメータ

名前説明
disabledBoolean無効状態。

リターン

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();
}

パラメータ

名前説明
actionActionこの要素がクリックされたときに行うアクション。

リターン

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();
}

パラメータ

名前説明
actionActionこの要素がクリックされたときに行う、リンクを開くアクションを指定するオブジェクト。

リターン

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


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

パラメータ

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

リターン

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


setText(text)

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

パラメータ

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

リターン

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


setTextButtonStyle(textButtonStyle)

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

パラメータ

名前説明
textButtonStyleTextButtonStyleボタンのスタイル。

リターン

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