Class Button

ボタン

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

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

Methods

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

詳細なドキュメント

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

パラメータ

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

リターン

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


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

パラメータ

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

リターン

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


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

パラメータ

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

リターン

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


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

パラメータ

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

リターン

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


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

パラメータ

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

リターン

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