このページは Cloud Translation API によって翻訳されました。

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

パラメータ

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

戻る

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

`setBottomLabel(text)`

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

パラメータ

名前	型	説明
`text`	`String`	ラベルのテキスト。

戻る

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

`setButton(button)`

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

パラメータ

名前	型	説明
`button`	`Button`	追加ボタン。

戻る

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

`setComposeAction(action, composedEmailType)`

オブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。UI オブジェクトには、setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action)、setComposeAction(action, composedEmailType) のいずれかのみ設定できます。

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

注: このメソッドでは、Compose UI の拡張に使用される Compose アクションは設定されません。代わりに、このメソッドは、この UI 要素を Action に接続します。この Action は、アクションの完了時に Gmail で開かれる Apps Script で下書きメッセージを作成します。

// ...

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

パラメータ

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

戻る

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

`setEndIcon(endIcon)`

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

パラメータ

名前	型	説明
`endIcon`	`IconImage`	追加するアイコン。

戻る

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

パラメータ

名前	型	説明
`action`	`Action`	この要素がクリックされたときに実行するアクション。

戻る

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

パラメータ

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

戻る

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

`setOpenLink(openLink)`

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

パラメータ

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

戻る

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

`setStartIcon(startIcon)`

テキストコンテンツの前に表示するオプションの IconImage を設定します。

パラメータ

名前	型	説明
`startIcon`	`IconImage`	表示するアイコン。

戻る

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

`setSwitchControl(switchToSet)`

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

パラメータ

名前	型	説明
`switchToSet`	`Switch`	追加するスイッチ。

戻る

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

`setText(text)`

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

パラメータ

名前	型	説明
`text`	`String`	このウィジェットのテキストコンテンツ。

戻る

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

`setTopLabel(text)`

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

パラメータ

名前	型	説明
`text`	`String`	ラベルのテキスト。

戻る

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

`setWrapText(wrapText)`

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

パラメータ

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

戻る

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