Class Grid

格線

有條理的格狀空間，可顯示一組格線項目。

適用於 Google Workspace 外掛程式和 Google Chat 應用程式。

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

方法

方法	傳回類型	簡短說明
addItem(gridItem)	Grid	在格狀檢視畫面中新增格線項目。
setAuthorizationAction(action)	Grid	設定授權動作，在物件點擊時開啟授權流程的網址。
setBorderStyle(borderStyle)	Grid	設定套用至每個格線項目的框線樣式。
setComposeAction(action, composedEmailType)	Grid	設定在物件點選時，撰寫電子郵件草稿的動作。
setNumColumns(numColumns)	Grid	格狀檢視中顯示的欄數。
setOnClickAction(action)	Grid	設定在點選物件時要執行的動作。
setOnClickOpenLinkAction(action)	Grid	設定當使用者點選物件時，於分頁中開啟網址的動作。
setOpenLink(openLink)	Grid	設定在點選物件時開啟的網址。
setTitle(title)	Grid	設定格線的標題文字。

內容詳盡的說明文件

addItem(gridItem)

在格狀檢視畫面中新增格線項目。

參數

名稱	類型	說明
gridItem	GridItem	要新增的格線項目。

回攻員

Grid：這個物件用於鏈結。

---

setAuthorizationAction(action)

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

UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 的其中一項。

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

參數

名稱	類型	說明
action	AuthorizationAction	這個物件會在使用者點擊此元素時，指定要採取的動作。

回攻員

Grid：這個物件用於鏈結。

---

setBorderStyle(borderStyle)

設定套用至每個格線項目的框線樣式。預設值為 NO_BORDER。

參數

名稱	類型	說明
borderStyle	BorderStyle	要套用的邊框樣式。

回攻員

Grid：這個物件用於鏈結。

---

setComposeAction(action, composedEmailType)

設定在物件點選時，撰寫電子郵件草稿的動作。UI 物件只能設定 setOpenLink(openLink)、setOnClickAction(action)、setOnClickOpenLinkAction(action)、setAuthorizationAction(action) 或 setComposeAction(action, composedEmailType) 的其中一項。

Action 參數必須指定回呼函式，該函式會傳回使用 ComposeActionResponseBuilder.setGmailDraft(draft) 設定的 ComposeActionResponse 物件。

注意：這個方法不會設定用於擴充 Compose UI 的撰寫動作。相反地，這個方法會將這個 UI 元素連結至 Action，後者會在動作完成時開啟在 Gmail 中開啟的 Apps Script 撰寫草稿訊息。

// ...

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

參數

名稱	類型	說明
action	Action	這個物件會在使用者點擊此元素時，指定要採取的動作。
composedEmailType	ComposedEmailType	此列舉值可指定撰寫的草稿是獨立或回覆草稿。

回攻員

Grid：這個物件用於鏈結。

---

setNumColumns(numColumns)

格狀檢視中顯示的欄數。如果顯示在右側面板中，您可以設定 1 至 2 欄，預設值為 1。如果對話方塊顯示，則可顯示 2 到 3 個資料欄，預設值為 2。

參數

名稱	類型	說明
numColumns	Integer	欄數。

回攻員

Grid：這個物件用於鏈結。

---

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

參數

名稱	類型	說明
action	Action	點按此元素時要採取的動作。

回攻員

Grid：這個物件用於鏈結。

---

setOnClickOpenLinkAction(action)

設定當使用者點選物件時，於分頁中開啟網址的動作。在需要建構網址，或需要在外掛程式中執行其他動作以建立 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();
}

參數

名稱	類型	說明
action	Action	此物件會在使用者點選此元素時，指定開啟的連結動作。

回攻員

Grid：這個物件用於鏈結。

---

setOpenLink(openLink)

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

參數

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

回攻員

Grid：這個物件用於鏈結。

---

setTitle(title)

設定格線的標題文字。文字必須是沒有格式的純字串。

參數

名稱	類型	說明
title	String	標題文字。

回攻員

Grid：這個物件用於鏈結。