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) のいずれか 1 つのみを設定できます。

// ...

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

パラメータ

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

リターン

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


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

リターン

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


setOnClickAction(action)

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

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

リターン

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


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

リターン

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


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

パラメータ

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

リターン

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


setText(text)

このアクションのメニュー テキストを設定します。

パラメータ

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

リターン

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