Class CardAction

CardAction

カードヘッダー メニューに追加されるクリック可能なメニュー項目。

var action = CardService.newAction();
// Finish building the action...

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

Methods

方法	戻り値の型	概要
setAuthorizationAction(action)	CardAction	オブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)	CardAction	オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)	CardAction	オブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)	CardAction	オブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。
setOpenLink(openLink)	CardAction	オブジェクトがクリックされたときに開く URL を設定します。
setText(text)	CardAction	この操作のメニュー テキストを設定します。

詳細なドキュメント

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

パラメータ

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

戻る

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

---

setComposeAction(action, composedEmailType)

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

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

注: この方法では、Compose UI の拡張に使用する作成アクションは設定されません。このメソッドは、この UI 要素を、アクションの完了時に Gmail で開く Apps Script の下書きメッセージを作成する Action に接続します。

// ...

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	作成された下書きがスタンドアロンまたは返信の下書きのどちらであるかを指定する列挙値。

戻る

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

---

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	この要素がクリックされたときに実行するアクション。

戻る

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

---

setOnClickOpenLinkAction(action)

オブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。この関数は、URL を作成する必要がある場合や、OpenLink オブジェクトを作成するために他のアクションを行う必要がある場合に使用します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみを設定できます。

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	この要素がクリックされたときに実行するオープンリンク アクションを指定するオブジェクト。

戻る

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

---

setOpenLink(openLink)

オブジェクトがクリックされたときに開く URL を設定します。この関数は、URL がすでにわかっているため開く必要がある場合にのみ使用します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれか 1 つのみを設定できます。

パラメータ

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

戻る

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

---

setText(text)

この操作のメニュー テキストを設定します。

パラメータ

名前	型	説明
text	String	メニュー項目のテキスト。

戻る

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