Class KeyValue

KeyValue

非推奨。このクラスは非推奨のため、新しいスクリプトには使用しないでください。

このクラスは非推奨となりました。代わりに、DecoratedText を使用してください。

Methods

方法戻り値の型概要
setAuthorizationAction(action)KeyValueオブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。
setComposeAction(action, composedEmailType)KeyValueオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)KeyValueオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)KeyValueオブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。
setOpenLink(openLink)KeyValueオブジェクトがクリックされたときに開く 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);

パラメータ

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

戻る

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

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

戻る

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

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

戻る

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

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

パラメータ

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

戻る

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

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

パラメータ

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

戻る

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

サポート終了のメソッド