Class CardBuilder
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Strumento per la creazione di schede
Un generatore di oggetti Card.
Documentazione dettagliata
addCardAction(cardAction)
addSection(section)
Aggiunge una sezione a questa scheda. Non puoi aggiungere più di 100 sezioni a una scheda.
Parametri
Invio
CardBuilder: questo oggetto, per l'accodamento.
build()
Crea la scheda corrente e la convalida.
Invio
Card: una carta convalidata.
Lanci
Error: se la scheda creata non è valida.
setDisplayStyle(displayStyle)
Imposta lo stile di visualizzazione di questa scheda.
Se lo stile di visualizzazione è impostato su DisplayStyle.REPLACE, la scheda viene mostrata sostituendo la visualizzazione della scheda in alto nella serie di schede.
Se lo stile di visualizzazione è impostato su DisplayStyle.PEEK, l'intestazione della scheda viene visualizzata nella parte inferiore della barra laterale, coprendo parzialmente la scheda superiore corrente della serie. Se fai clic sull'intestazione, la scheda viene visualizzata nella serie di schede. Se la scheda non ha un'intestazione, viene utilizzata un'intestazione generata.
DisplayStyle funziona solo per la scheda restituita dalla funzione di attivazione contestuale.
Parametri
Invio
CardBuilder: questo oggetto, per l'accodamento.
setName(name)
Imposta il nome di questa scheda. Il nome può essere utilizzato per la navigazione.
Parametri
| Nome | Tipo | Descrizione |
name | String | Il nome. |
Invio
CardBuilder: questo oggetto, per l'accodamento.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-26 UTC.
[null,null,["Ultimo aggiornamento 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."]]
