テキストを任意の装飾で表示するウィジェット。指定可能なキーには、アイコン、上部にラベル、下部にラベルがあります。テキスト コンテンツといずれかのキーを設定するには、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");
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);
パラメータ
Name | 型 | 説明 |
---|---|---|
action | AuthorizationAction | この要素がクリックされたときに行う承認アクションを指定するオブジェクト。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setBottomLabel(text)
キーとして使用されるラベルテキストを設定します。テキスト コンテンツの下に表示されます。
パラメータ
Name | 型 | 説明 |
---|---|---|
text | String | ラベルのテキスト。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setButton(button)
テキストの右側に表示される Button
を設定します。DecoratedText
は 1 つのボタンまたは 1 つのスイッチのみをサポートできます。
パラメータ
Name | 型 | 説明 |
---|---|---|
button | Button | 追加するボタン。 |
リターン
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(); }
パラメータ
Name | 型 | 説明 |
---|---|---|
action | Action | この要素がクリックされたときに行う作成アクションを指定するオブジェクト。 |
composedEmailType | ComposedEmailType | 作成された下書きが単独の下書きか返信の下書きかを指定する列挙値。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setEndIcon(endIcon)
コンテンツの右側に表示される IconImage
(省略可)を設定します。DecoratedText
は、1 つのボタン、1 つのスイッチ、または 1 つのアイコンのみをサポートできます。
パラメータ
Name | 型 | 説明 |
---|---|---|
endIcon | IconImage | 追加するアイコン。 |
リターン
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(); }
パラメータ
Name | 型 | 説明 |
---|---|---|
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
オブジェクトを返すコールバック関数を指定する必要があります。
// ... 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(); }
パラメータ
Name | 型 | 説明 |
---|---|---|
action | Action | この要素がクリックされたときに行う、リンクを開くアクションを指定するオブジェクト。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setOpenLink(openLink)
オブジェクトがクリックされたときに開く URL を設定します。URL が既知で、開くだけでよい場合は、この関数を使用します。UI オブジェクトには、setOpenLink(openLink)
、setOnClickAction(action)
、setOnClickOpenLinkAction(action)
、setAuthorizationAction(action)
、setComposeAction(action, composedEmailType)
のいずれかのみを設定できます。
パラメータ
Name | 型 | 説明 |
---|---|---|
openLink | OpenLink | 開く URL を記述する OpenLink オブジェクト。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setStartIcon(startIcon)
テキスト コンテンツの前に表示するオプションの IconImage
を設定します。
パラメータ
Name | 型 | 説明 |
---|---|---|
startIcon | IconImage | 表示するアイコン。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setSwitchControl(switchToSet)
コンテンツの右側に表示される Switch
を設定します。DecoratedText
は 1 つのボタンまたは 1 つのスイッチのみをサポートできます。
パラメータ
Name | 型 | 説明 |
---|---|---|
switchToSet | Switch | 追加するスイッチ。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setText(text)
値として使用されるテキストを設定します。簡易 HTML 形式をサポートしています。必須。
パラメータ
Name | 型 | 説明 |
---|---|---|
text | String | このウィジェットのテキスト コンテンツ。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setTopLabel(text)
キーとして使用されるラベルテキストを設定します。テキスト コンテンツの上に表示されます。
パラメータ
Name | 型 | 説明 |
---|---|---|
text | String | ラベルのテキスト。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。
setWrapText(wrapText)
値のテキストを 1 行に表示するか複数行で表示するかを設定します。
パラメータ
Name | 型 | 説明 |
---|---|---|
wrapText | Boolean | true の場合、テキストは折り返して複数行に表示されます。それ以外の場合、テキストは切り捨てられます。 |
リターン
DecoratedText
- チェーン用のこのオブジェクト。