本頁面由 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`	設定授權動作，在點選物件時開啟授權流程的網址。
`setBottomLabel(text)`	`DecoratedText`	設定要當做鍵使用的標籤文字，顯示在文字內容下方。
`setButton(button)`	`DecoratedText`	設定顯示在文字右側的 `Button`。
`setComposeAction(action, composedEmailType)`	`DecoratedText`	設定在點選物件時，撰寫電子郵件草稿的動作。
`setEndIcon(endIcon)`	`DecoratedText`	設定要顯示在內容右側的選用 `IconImage`。
`setOnClickAction(action)`	`DecoratedText`	設定在點選物件時執行的動作。
`setOnClickOpenLinkAction(action)`	`DecoratedText`	設定動作，當使用者點選物件時，在分頁中開啟網址。
`setOpenLink(openLink)`	`DecoratedText`	設定點選物件時要開啟的網址。
`setStartIcon(startIcon)`	`DecoratedText`	設定在文字內容之前顯示選用的 `IconImage`。
`setSwitchControl(switchToSet)`	`DecoratedText`	設定顯示在內容右側的 `Switch`。
`setText(text)`	`DecoratedText`	設定要用來做為值的文字。
`setTopLabel(text)`	`DecoratedText`	設定要當做索引鍵的標籤文字，並顯示在文字內容上方。
`setWrapText(wrapText)`	`DecoratedText`	設定值文字應顯示在單一行還是多行。

內容詳盡的說明文件

`setAuthorizationAction(action)`

設定授權動作，在點選物件時開啟授權流程的網址。系統會在新視窗中開啟網址。使用者完成授權流程並返回應用程式後，外掛程式就會重新載入。

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 只能支援一個按鈕或一個切換鈕。

參數

名稱	類型	說明
`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，在該元素中撰寫草稿郵件，並在動作完成時在 Gmail 中開啟。

// ...

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

參數

名稱	類型	說明
`action`	`Action`	這個物件用於指定點選這個元素時要執行的組合動作。
`composedEmailType`	`ComposedEmailType`	這個列舉值可指定所撰寫的草稿是獨立草稿還是回覆草稿。

回攻員

DecoratedText：這個物件用於鏈結。

`setEndIcon(endIcon)`

設定要顯示在內容右側的選用 IconImage。DecoratedText 只能支援一個按鈕、一個切換鈕或一個圖示。

參數

名稱	類型	說明
`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)`

設定在點選物件時，在分頁中開啟網址的動作。如果需要建構網址，或是除了建立 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)`

設定點選物件時要開啟的網址。當您已知網址，且只需要開啟網址時，請使用這個函式。UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 其中之一。

參數

名稱	類型	說明
`openLink`	`OpenLink`	描述要開啟的網址的 `OpenLink` 物件。

回攻員

DecoratedText：這個物件用於鏈結。

`setStartIcon(startIcon)`

設定選用的 IconImage，以便顯示文字內容。

參數

名稱	類型	說明
`startIcon`	`IconImage`	要顯示的圖示。

回攻員

DecoratedText：這個物件用於鏈結。

`setSwitchControl(switchToSet)`

設定顯示在內容右側的 Switch。DecoratedText 只能支援一個按鈕或一個切換鈕。

參數

名稱	類型	說明
`switchToSet`	`Switch`	要新增的切換按鈕。

回攻員

DecoratedText：這個物件用於鏈結。

`setText(text)`

設定要做為值的文字。支援基本 HTML 格式設定。必填。

參數

名稱	類型	說明
`text`	`String`	這個小工具的文字內容。

回攻員

DecoratedText：這個物件用於鏈結。

`setTopLabel(text)`

設定要當做鍵使用的標籤文字，並顯示在文字內容上方。

參數

名稱	類型	說明
`text`	`String`	標籤文字。

回攻員

DecoratedText：這個物件用於鏈結。

`setWrapText(wrapText)`

設定值文字應顯示在單一行還是多行。

參數

名稱	類型	說明
`wrapText`	`Boolean`	如果為 `true`，文字會斷行並顯示在多行中。否則文字會遭到截斷。

回攻員

DecoratedText：這個物件用於鏈結。