Class CardBuilder
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
CardBuilder
ตัวสร้างสำหรับออบเจ็กต์ Card
เอกสารประกอบโดยละเอียด
addCardAction(cardAction)
addSection(section)
เพิ่มส่วนลงในการ์ดนี้ คุณเพิ่มส่วนลงในการ์ดได้ไม่เกิน 100 ส่วน
พารามิเตอร์
รีเทิร์น
CardBuilder — ออบเจ็กต์นี้สําหรับการต่อเชื่อม
build()
สร้างการ์ดปัจจุบันและตรวจสอบ
รีเทิร์น
Card — บัตรที่ตรวจสอบแล้ว
โยน
Error — หากการ์ดที่สร้างขึ้นไม่ถูกต้อง
setDisplayStyle(displayStyle)
กำหนดรูปแบบการแสดงผลสำหรับการ์ดนี้
หากตั้งค่ารูปแบบการแสดงผลเป็น DisplayStyle.REPLACE การ์ดจะแสดงโดยแทนที่มุมมองของการ์ดบนสุดในกองการ์ด
หากตั้งค่ารูปแบบการแสดงผลเป็น DisplayStyle.PEEK ส่วนหัวของการ์ดจะปรากฏที่ด้านล่างของแถบด้านข้าง ซึ่งจะบดบังการ์ดบนสุดของกองการ์ดบางส่วน การคลิกส่วนหัวจะเป็นการเปิดการ์ดในกองการ์ด หากการ์ดไม่มีส่วนหัว ระบบจะใช้ส่วนหัวที่สร้างขึ้นแทน
DisplayStyle ใช้ได้กับการ์ดที่แสดงผลจากฟังก์ชันทริกเกอร์ตามบริบทเท่านั้น
พารามิเตอร์
รีเทิร์น
CardBuilder — ออบเจ็กต์นี้สําหรับการต่อเชื่อม
setName(name)
ตั้งชื่อการ์ดนี้ ชื่อนี้สามารถใช้สำหรับการนําทาง
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
name | String | ชื่อ |
รีเทิร์น
CardBuilder — ออบเจ็กต์นี้สําหรับการต่อเชื่อม
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-26 UTC
[null,null,["อัปเดตล่าสุด 2025-07-26 UTC"],[[["\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."]]
