Class DecoratedText

DecoratedText

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

Google Workspace アドオンと Google Chat アプリで利用できます。

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

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

メソッド

メソッド戻り値の型概要
addEventAction(eventAction)Widgetウィジェットで実行できるイベント アクションを追加します。
setAuthorizationAction(action)DecoratedTextオブジェクトがクリックされたときに、URL を開いて認証フローに移動する認証アクションを設定します。
setBottomLabel(text)DecoratedTextキーとして使用され、テキスト コンテンツの下に表示されるラベルテキストを設定します。
setButton(button)DecoratedTextテキストの右側に表示される Button を設定します。
setComposeAction(action, composedEmailType)DecoratedTextオブジェクトがクリックされたときに下書きメールを作成するアクションを設定します。
setEndIcon(endIcon)DecoratedTextコンテンツの右側に表示されるオプションの IconImage を設定します。
setId(id)Widget変更するウィジェットの識別に使用される一意の ID を設定します。
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キーとして使用され、テキスト コンテンツの上に表示されるラベル テキストを設定します。
setVisibility(visibility)Widgetウィジェットの可視性を設定します。
setWrapText(wrapText)DecoratedText値のテキストを 1 行で表示するか複数行で表示するかを設定します。

詳細なドキュメント

addEventAction(eventAction)

ウィジェットで実行できるイベント アクションを追加します。

パラメータ

名前説明
eventActionEventAction追加する EventAction

戻る

Widget - チェーン用の Object。


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

パラメータ

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

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

// ...

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

パラメータ

名前説明
actionActionこの要素がクリックされたときに実行するコンポーズ アクションを指定するオブジェクト。
composedEmailTypeComposedEmailType作成された下書きがスタンドアロンの下書きか返信の下書きかを指定する列挙値。

戻る

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


setEndIcon(endIcon)

コンテンツの右側に表示されるオプションの IconImage を設定します。DecoratedText でサポートできるのは、ボタン、スイッチ、アイコンのいずれか 1 つのみです。

パラメータ

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

戻る

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


setId(id)

変更するウィジェットの識別に使用される一意の ID を設定します。ウィジェットの変更はアドオンでのみサポートされています。

パラメータ

名前説明
idStringウィジェットの ID。64 文字以内で、`[a-zA-Z0-9-]+` の形式で指定します。

戻る

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


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

パラメータ

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

// ...

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

パラメータ

名前説明
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 つのみです。

パラメータ

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

戻る

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


setText(text)

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

パラメータ

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

戻る

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


setTopLabel(text)

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

パラメータ

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

戻る

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


setVisibility(visibility)

ウィジェットの可視性を設定します。デフォルト値は `VISIBLE` です。

パラメータ

名前説明
visibilityVisibilityウィジェットの Visibility

戻る

Widget - チェーン用の Object。


setWrapText(wrapText)

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

パラメータ

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

戻る

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