Class DecoratedText

DecoratedText

オプションの装飾が施されたテキストを表示するウィジェット。使用できるキーには、アイコン、上のラベル、下のラベルがあります。テキスト コンテンツとキーのいずれかを設定するには、setText(text) と、DecoratedTextDecoratedTextsetTopLabel(text)setBottomLabel(text) のいずれかを使用する必要があります。このクラスは、KeyValue を置き換えることを目的としています。

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var multilineDecoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel")
    .setWrapText(true)
    .setBottomLabel("BottomLabel");

Methods

方法戻り値の型概要
setAuthorizationAction(action)DecoratedTextオブジェクトがクリックされたときに承認フローの URL を開く認可アクションを設定します。
setBottomLabel(text)DecoratedTextキーとして使用するラベルテキストを設定し、テキスト コンテンツの下に表示されます。
setButton(button)DecoratedTextテキストの右側に表示される Button を設定します。
setComposeAction(action, composedEmailType)DecoratedTextオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setEndIcon(endIcon)DecoratedTextコンテンツの右側に表示される IconImage(省略可)を設定します。
setOnClickAction(action)DecoratedTextオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)DecoratedTextオブジェクトがクリックされたときに、タブで URL を開くアクションを設定します。
setOpenLink(openLink)DecoratedTextオブジェクトがクリックされたときに開く URL を設定します。
setStartIcon(startIcon)DecoratedTextテキスト コンテンツの前に表示する IconImage(省略可)を設定します。
setSwitchControl(switchToSet)DecoratedTextコンテンツの右側に表示される Switch を設定します。
setText(text)DecoratedText値として使用するテキストを設定します。
setTopLabel(text)DecoratedTextキーとして使用するラベルテキストを設定し、テキスト コンテンツの上に表示します。
setWrapText(wrapText)DecoratedText値テキストを 1 行に表示するか複数行に表示するかを設定します。

詳細なドキュメント

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

戻る

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


setBottomLabel(text)

キーとして使用するラベルテキストを設定し、テキスト コンテンツの下に表示されます。

パラメータ

名前説明
textStringラベルのテキスト。

戻る

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


setButton(button)

テキストの右側に表示される Button を設定します。DecoratedText は 1 つのボタンまたは 1 つのスイッチしかサポートできません。

パラメータ

名前説明
buttonButton追加するボタン。

戻る

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


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

戻る

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


setEndIcon(endIcon)

コンテンツの右側に表示される IconImage(省略可)を設定します。DecoratedText は 1 つのボタン、1 つのスイッチ、1 つのアイコンのみがサポートされます。

パラメータ

名前説明
endIconIconImage追加するアイコン。

戻る

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


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

戻る

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


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

戻る

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


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

パラメータ

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

戻る

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


setStartIcon(startIcon)

テキスト コンテンツの前に表示する IconImage(省略可)を設定します。

パラメータ

名前説明
startIconIconImage表示するアイコン。

戻る

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


setSwitchControl(switchToSet)

コンテンツの右側に表示される Switch を設定します。DecoratedText は 1 つのボタンまたは 1 つのスイッチしかサポートできません。

パラメータ

名前説明
switchToSetSwitch追加するスイッチ。

戻る

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


setText(text)

値として使用するテキストを設定します。基本的な HTML 形式に対応しています。必須。

パラメータ

名前説明
textStringこのウィジェットのテキスト コンテンツ。

戻る

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


setTopLabel(text)

キーとして使用するラベルテキストを設定し、テキスト コンテンツの上に表示します。

パラメータ

名前説明
textStringラベルのテキスト。

戻る

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


setWrapText(wrapText)

値テキストを 1 行に表示するか複数行に表示するかを設定します。

パラメータ

名前説明
wrapTextBooleantrue の場合、テキストはラップされて複数の行で表示されます。それ以外の場合、テキストは切り捨てられます。

戻る

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