Class CardBuilder
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
內容詳盡的說明文件
addCardAction(cardAction)
addSection(section)
新增資訊卡的部分。您最多只能在資訊卡中新增 100 個版面。
參數
回攻員
CardBuilder
:這個物件用於鏈結。
build()
建構並驗證目前的資訊卡。
回攻員
Card
:已驗證的卡片。
擲回
Error
:如果建立的卡片無效。
setDisplayStyle(displayStyle)
設定此資訊卡的顯示樣式。
如果顯示樣式設為 DisplayStyle.REPLACE
,系統會取代資訊卡堆疊中頂端資訊卡的檢視畫面,顯示該資訊卡。
如果顯示樣式設為 DisplayStyle.PEEK
,資訊卡的標題會顯示在側欄底部,部分遮蓋目前堆疊頂端的資訊卡。點選標題可彈出資訊卡,並放入資訊卡堆疊。如果資訊卡沒有標頭,系統會改用產生的標頭。
DisplayStyle
只適用於從內容相關觸發事件函式傳回的資訊卡。
參數
回攻員
CardBuilder
:這個物件用於鏈結。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\u003cp\u003e\u003ccode\u003eCardBuilder\u003c/code\u003e helps in constructing \u003ca href=\"/apps-script/reference/card-service/card\"\u003eCard\u003c/a\u003e objects for Google Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to add sections, actions, headers, footers and define display styles for the card.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCardBuilder\u003c/code\u003e provides control over the card's structure and behavior within the user interface.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes the card creation and validates its structure before returning a \u003ccode\u003eCard\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eYou can chain methods together for a more fluent and concise building process.\u003c/p\u003e\n"]]],[],null,["# Class CardBuilder\n\nCardBuilder\n\nA builder for [Card](/apps-script/reference/card-service/card) objects. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------------|--------------------------------------------------|------------------------------------------------------------------------------------|\n| [addCardAction(cardAction)](#addCardAction(CardAction)) | [CardBuilder](#) | Adds a [CardAction](/apps-script/reference/card-service/card-action) to this Card. |\n| [addSection(section)](#addSection(CardSection)) | [CardBuilder](#) | Adds a section to this card. |\n| [build()](#build()) | [Card](/apps-script/reference/card-service/card) | Builds the current card and validates it. |\n| [setDisplayStyle(displayStyle)](#setDisplayStyle(DisplayStyle)) | [CardBuilder](#) | Sets the display style for this card. |\n| [setFixedFooter(fixedFooter)](#setFixedFooter(FixedFooter)) | [CardBuilder](#) | Sets a fixed footer for this card. |\n| [setHeader(cardHeader)](#setHeader(CardHeader)) | [CardBuilder](#) | Sets the header for this card. |\n| [setName(name)](#setName(String)) | [CardBuilder](#) | Sets the name for this card. |\n| [setPeekCardHeader(peekCardHeader)](#setPeekCardHeader(CardHeader)) | [CardBuilder](#) | Sets the peek card header. |\n\nDetailed documentation\n----------------------\n\n### `add``Card``Action(cardAction)`\n\nAdds a [CardAction](/apps-script/reference/card-service/card-action) to this Card.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|---------------------------------------------------------------|---------------------------------------------------------------------------|\n| `card``Action` | [CardAction](/apps-script/reference/card-service/card-action) | The [CardAction](/apps-script/reference/card-service/card-action) to use. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `add``Section(section)`\n\nAdds a section to this card. You can't add more than 100 sections to a card.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------|-----------------------------------------------------------------|-----------------------------------------------------------------------------|\n| `section` | [CardSection](/apps-script/reference/card-service/card-section) | The [CardSection](/apps-script/reference/card-service/card-section) to use. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `build()`\n\nBuilds the current card and validates it.\n\n#### Return\n\n\n[Card](/apps-script/reference/card-service/card) --- A validated card.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed card isn't valid.\n\n*** ** * ** ***\n\n### `set``Display``Style(displayStyle)`\n\nSets the display style for this card.\n\nIf the display style is set to `Display``Style.REPLACE`, the card is shown by replacing\nthe view of top card in the card stack.\n\nIf the display style is set to `Display``Style.PEEK`, the header of the card appears at\nthe bottom of the sidebar, partially covering the current top card of the stack. Clicking the\nheader pops the card into the card stack. If the card has no header, a generated header is used\ninstead.\n\n\n`Display``Style` only works for card returned from contextual trigger function.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------|-------------------------------------------------------------------|-------------------------------------------------------------------------------|\n| `display``Style` | [DisplayStyle](/apps-script/reference/card-service/display-style) | The [DisplayStyle](/apps-script/reference/card-service/display-style) to set. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Fixed``Footer(fixedFooter)`\n\nSets a fixed footer for this card.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------|\n| `fixed``Footer` | [FixedFooter](/apps-script/reference/card-service/fixed-footer) | The [FixedFooter](/apps-script/reference/card-service/fixed-footer) to use. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Header(cardHeader)`\n\nSets the header for this card.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|---------------------------------------------------------------|---------------------------------------------------------------------------|\n| `card``Header` | [CardHeader](/apps-script/reference/card-service/card-header) | The [CardHeader](/apps-script/reference/card-service/card-header) to use. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Name(name)`\n\nSets the name for this card. The name can be used for [navigation](/gmail/add-ons/how-tos/navigation).\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-------------|\n| `name` | `String` | The name. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Peek``Card``Header(peekCardHeader)`\n\nSets the peek card header.\n\nThe peek card is set on the first card returned from a contextual trigger function. It is\nused as a descriptive placeholder widget so that users can navigate from a homepage stack to\nthe contextual stack.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|---------------------------------------------------------------|---------------------------------------------------------------------------|\n| `peek``Card``Header` | [CardHeader](/apps-script/reference/card-service/card-header) | The [CardHeader](/apps-script/reference/card-service/card-header) to set. |\n\n#### Return\n\n\n[CardBuilder](#) --- This object, for chaining."]]