Class Grid

格狀

用來顯示格線項目集合的排列格線。

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

const 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)

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

參數

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

回攻員

Grid：這個物件用於鏈結。

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

參數

名稱類型說明
actionAuthorizationAction指定在點選此元素時要採取的授權動作的物件。

回攻員

Grid：這個物件用於鏈結。

setBorderStyle(borderStyle)

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

參數

名稱類型說明
borderStyleBorderStyle要套用的框線樣式。

回攻員

Grid：這個物件用於鏈結。

setComposeAction(action, composedEmailType)

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

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

// ...

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

參數

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

回攻員

Grid：這個物件用於鏈結。

setNumColumns(numColumns)

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

參數

名稱類型說明
numColumnsInteger欄數。

回攻員

Grid：這個物件用於鏈結。

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

參數

名稱類型說明
actionAction點選這個元素後要採取的動作。

回攻員

Grid：這個物件用於鏈結。

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

參數

名稱類型說明
actionAction指定在點選此元素時要執行的開啟連結動作的物件。

回攻員

Grid：這個物件用於鏈結。

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

參數

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

回攻員

Grid：這個物件用於鏈結。

setTitle(title)

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

參數

名稱類型說明
titleString標題文字。

回攻員

Grid：用於鏈結的物件。