Class DecoratedText

DecoratedText

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

Google Workspace アドオンと Google Chat アプリでご利用いただけます。 

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

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

// ...

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

<ph type="x-smartling-placeholder"> 

// ...

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) セットしました。

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) を設定します。

パラメータ

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