Class CardAction

CardAction

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

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

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

メソッド

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

// ...

const 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) のいずれか 1 つのみです。

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

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

// ...

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

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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) のいずれか 1 つのみです。

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

// ...

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

// ...

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