Class Button

ボタン

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

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

メソッド

メソッド戻り値の型概要
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) のいずれか 1 つのみを設定できます。 

// ...

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

パラメータ

名前型説明
actionAuthorizationActionこの要素が クリックします。

戻る

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

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"> 

// ...

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作成された下書きが [スタンドアロン] または [返信の下書き] を選択します。

戻る

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

パラメータ

名前型説明
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();
}

パラメータ

名前型説明
actionActionこの要素が開いたときに行うリンクを開く操作を指定するオブジェクト。 クリックします。

戻る

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

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

パラメータ

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

戻る

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