Class UniversalActionResponseBuilder
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Documentation détaillée
build()
Crée et valide la réponse d'action universelle actuelle.
Renvois
UniversalActionResponse : UniversalActionResponse validé.
Génère
Error : si la réponse d'action universelle créée n'est pas valide.
displayAddOnCards(cardObjects)
Affiche le module complémentaire avec les fiches spécifiées.
Paramètres
| Nom | Type | Description |
cardObjects | Object[] | Tableau de Card à afficher. |
Renvois
UniversalActionResponseBuilder : cet objet, pour le chaînage.
setOpenLink(openLink)
Définit l'URL à ouvrir lorsque l'action universelle est sélectionnée.
Paramètres
| Nom | Type | Description |
openLink | OpenLink | Objet de lien à utiliser. |
Renvois
UniversalActionResponseBuilder : cet objet, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eUniversalActionResponseBuilder facilitates constructing UniversalActionResponse objects for handling user actions within Google Workspace add-ons.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to define the response behavior, including displaying add-on cards (\u003ccode\u003edisplayAddOnCards\u003c/code\u003e) or opening URLs (\u003ccode\u003esetOpenLink\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes and validates the response configuration.\u003c/p\u003e\n"]]],["The `UniversalActionResponseBuilder` constructs `UniversalActionResponse` objects. Key actions include: `build()`, which creates and validates the response, returning a `UniversalActionResponse`. `displayAddOnCards(cardObjects)` presents the add-on with provided `Card` objects, and `setOpenLink(openLink)` defines a URL that opens upon universal action selection, using an `OpenLink` object. Both `displayAddOnCards` and `setOpenLink` allow for method chaining. The `build()` method can throw an `Error` if the created object is not valid.\n"],null,["# Class UniversalActionResponseBuilder\n\nUniversalActionResponseBuilder\n\nA builder for the [UniversalActionResponse](/apps-script/reference/card-service/universal-action-response) objects. \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------------------------------|------------------------------------------------------------------------------------------|----------------------------------------------------------------|\n| [build()](#build()) | [UniversalActionResponse](/apps-script/reference/card-service/universal-action-response) | Builds the current universal action response and validates it. |\n| [displayAddOnCards(cardObjects)](#displayAddOnCards(Object)) | [UniversalActionResponseBuilder](#) | Displays the add-on with the specified cards. |\n| [setOpenLink(openLink)](#setOpenLink(OpenLink)) | [UniversalActionResponseBuilder](#) | Sets the URL to open when the universal action is selected. |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nBuilds the current universal action response and validates it.\n\n#### Return\n\n\n[UniversalActionResponse](/apps-script/reference/card-service/universal-action-response) --- A validated UniversalActionResponse.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed universal action response isn't valid.\n\n*** ** * ** ***\n\n### `display``Add``On``Cards(cardObjects)`\n\nDisplays the add-on with the specified cards.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|------------|---------------------------------------------------------------------------|\n| `card``Objects` | `Object[]` | An array of [Card](/apps-script/reference/card-service/card)s to display. |\n\n#### Return\n\n\n[UniversalActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Open``Link(openLink)`\n\nSets the URL to open when the universal action is selected.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|-----------------------------------------------------------|-------------------------|\n| `open``Link` | [OpenLink](/apps-script/reference/card-service/open-link) | The link object to use. |\n\n#### Return\n\n\n[UniversalActionResponseBuilder](#) --- This object, for chaining."]]
