Class DecoratedText

DecoratedText

オプションの装飾付きのテキストを表示するウィジェット。使用できるキーには、アイコン、上のラベル、下のラベルがあります。テキスト コンテンツとキーのいずれかを設定するには、setText(text) と DecoratedText、DecoratedText、setTopLabel(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');

メソッド

メソッド戻り値の型概要
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) のいずれかしか設定できません。

// ...

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

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() {
  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 つのボタン、1 つのスイッチ、1 つのアイコンのみです。

パラメータ

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

戻る

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

setOnClickAction(action)

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

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) のいずれかしか設定できません。

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) のいずれかしか設定できません。

パラメータ

名前型説明
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 - チェーン用のこのオブジェクト。