AddOns Response Service

This service allows scripts to configure and build Google Workspace add-ons that extend Google Workspace flows.

Classes

Name	Brief description
`Action`	An action that Google Workspace add-ons that extend Google Workspace Flows can use to render a new card.
`AddOnsResponseService`	AddOnsResponseService provides the ability to create responses for Google Workspace add-ons that extend Google Workspace Flows.
`ModifyCard`	A builder for `ModifyCard` objects that changes and updates an existing card's interface by passing the `ModifyCard` object to a `Action`.
`Navigation`	A helper object that controls card navigation.
`RenderAction`	Renders or updates a card by performing an `Action` in response to a user interaction.
`RenderActionBuilder`	A builder for `RenderAction` objects.

`Action`

Methods

Method	Return type	Brief description
`addNavigation(navigation)`	`Action`	Add card navigation to the action.

`AddOnsResponseService`

Methods

Method	Return type	Brief description
`newAction()`	`Action`	Creates a new `Action`.
`newNavigation()`	`Navigation`	Creates a new `Navigation`.
`newRenderActionBuilder()`	`RenderActionBuilder`	Creates a new `RenderActionBuilder`.

`ModifyCard`

Methods

Method	Return type	Brief description
`setInsertSection(insertSection)`	`ModifyCard`	Sets the insert section for this action.
`setInsertWidget(insertWidget)`	`ModifyCard`	Sets the insert widget for this action.
`setRemoveSection(removeSection)`	`ModifyCard`	Sets the remove section for this action.
`setRemoveWidget(removeWidget)`	`ModifyCard`	Sets the remove widget for this action.
`setReplaceSection(replaceSection)`	`ModifyCard`	Sets the replace section for this action.
`setReplaceWidget(replaceWidget)`	`ModifyCard`	Sets the replace widget for this action.

`Navigation`

Methods

Method	Return type	Brief description
`printJson()`	`String`	Prints the JSON representation of this object.
`pushCard(card)`	`Navigation`	Pushes the given card onto the stack.

`RenderAction`

Methods

Method	Return type	Brief description
`printJson()`	`String`	Prints the JSON representation of this object.

`RenderActionBuilder`

Methods

Method	Return type	Brief description
`build()`	`RenderAction`	Builds the current render action and validates it.
`setAction(action)`	`RenderActionBuilder`	Sets the action that add-ons can use to update the UI to the render action.
`setHostAppAction(hostAppAction)`	`RenderActionBuilder`	Sets the host app action handled by individual host apps to the render action.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-29 UTC.

Blog
Read the Google Workspace Developers blog
Stack Overflow
Ask a question under the google-apps-script tag
Code Samples
Explore our code samples or copy them to build your own
Videos
Watch Apps Script tutorials