Class KeyValue

鍵值

已淘汰。這個類別已淘汰，不應在新的指令碼中使用。

這個類別已淘汰。請改用 DecoratedText。

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	KeyValue	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	KeyValue	設定動作，在使用者點選物件時，撰寫電子郵件草稿。
setOnClickAction(action)	KeyValue	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	KeyValue	設定動作，當使用者點選物件時，在分頁中開啟網址。
setOpenLink(openLink)	KeyValue	設定點選物件時要開啟的網址。

已淘汰的方法

方法	傳回類型	簡短說明
setBottomLabel(text)	KeyValue	設定要用來做為鍵的標籤文字。
setButton(button)	KeyValue	設定在內容右側顯示的 Button。
setContent(text)	KeyValue	設定要用來做為值的文字。
setIcon(icon)	KeyValue	設定要用來做為鍵的圖示。
setIconAltText(altText)	KeyValue	設定圖示的替代文字。
setIconUrl(url)	KeyValue	設定要用作鍵的圖示網址。
setMultiline(multiline)	KeyValue	設定值文字應顯示在單一行還是多行。
setSwitch(switchToSet)	KeyValue	設定內容右側顯示的 Switch。
setTopLabel(text)	KeyValue	設定要用來做為鍵的標籤文字。

內容詳盡的說明文件

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	指定在點選此元素時要採取的授權動作的物件。

回攻員

KeyValue：這個物件用於鏈結。

---

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(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

參數

名稱	類型	說明
action	Action	指定在點選此元素時要採取的 Compose 動作的物件。
composedEmailType	ComposedEmailType	這個列舉值可指定所撰寫草稿是獨立草稿還是回覆草稿。

回攻員

KeyValue：這個物件用於鏈結。

---

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	點選此元素時要採取的動作。

回攻員

KeyValue：這個物件用於鏈結。

---

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	指定在點選此元素時要執行的開啟連結動作的物件。

回攻員

KeyValue：這個物件用於鏈結。

---

setOpenLink(openLink)

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

參數

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

回攻員

KeyValue：這個物件用於鏈結。

已淘汰的方法

setBottomLabel(text)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

設定要用來做為鍵的標籤文字。顯示在 text-content 下方。

參數

名稱	類型	說明
text	String	標籤文字。注意：系統不支援基本 HTML 格式。

回攻員

KeyValue：這個物件用於鏈結。

---

setButton(button)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

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

參數

名稱	類型	說明
button	Button	新增按鈕。

回攻員

KeyValue：這個物件用於鏈結。

---

setContent(text)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

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

參數

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

回攻員

KeyValue：這個物件用於鏈結。

---

setIcon(icon)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

設定要用來做為鍵的圖示。

參數

名稱	類型	說明
icon	Icon	預先定義的 Icon 值之一。

回攻員

KeyValue：這個物件用於鏈結。

---

setIconAltText(altText)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

設定圖示的替代文字。

參數

名稱	類型	說明
altText	String	圖示的替代文字。

回攻員

KeyValue：這個物件用於鏈結。

---

setIconUrl(url)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

設定要用作鍵的圖示網址。

參數

名稱	類型	說明
url	String	要用來做為圖示的主機代管圖片網址。

回攻員

KeyValue：這個物件用於鏈結。

---

setMultiline(multiline)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

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

參數

名稱	類型	說明
multiline	Boolean	多行設定。

回攻員

KeyValue：這個物件用於鏈結。

---

setSwitch(switchToSet)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

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

參數

名稱	類型	說明
switchToSet	Switch	新增切換鈕。

回攻員

KeyValue：這個物件用於鏈結。

---

setTopLabel(text)

已淘汰。這個函式已淘汰，不建議在新指令碼中使用。

設定要用來做為鍵的標籤文字。顯示在文字內容上方。

參數

名稱	類型	說明
text	String	標籤文字。注意：系統不支援基本 HTML 格式。

回攻員

KeyValue：這個物件用於鏈結。