AddOns Response Service

AddOns Response Service

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

Classes

NameBrief description
ActionAn action that Google Workspace add-ons that extend Google Workspace Flows can use to render a new card.
AddOnsResponseServiceAddOnsResponseService provides the ability to create responses for Google Workspace add-ons that extend Google Workspace Flows.
ModifyCardA builder for ModifyCard objects that changes and updates an existing card's interface by passing the ModifyCard object to a Action.
NavigationA helper object that controls card navigation.
RenderActionRenders or updates a card by performing an Action in response to a user interaction.
RenderActionBuilderA builder for RenderAction objects.

Action

Methods

MethodReturn typeBrief description
addNavigation(navigation)ActionAdd card navigation to the action.

AddOnsResponseService

Methods

MethodReturn typeBrief description
newAction()ActionCreates a new Action.
newNavigation()NavigationCreates a new Navigation.
newRenderActionBuilder()RenderActionBuilderCreates a new RenderActionBuilder.

ModifyCard

Methods

MethodReturn typeBrief description
setInsertSection(insertSection)ModifyCardSets the insert section for this action.
setInsertWidget(insertWidget)ModifyCardSets the insert widget for this action.
setRemoveSection(removeSection)ModifyCardSets the remove section for this action.
setRemoveWidget(removeWidget)ModifyCardSets the remove widget for this action.
setReplaceSection(replaceSection)ModifyCardSets the replace section for this action.
setReplaceWidget(replaceWidget)ModifyCardSets the replace widget for this action.

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.
pushCard(card)NavigationPushes the given card onto the stack.

RenderAction

Methods

MethodReturn typeBrief description
printJson()StringPrints the JSON representation of this object.

RenderActionBuilder

Methods

MethodReturn typeBrief description
build()RenderActionBuilds the current render action and validates it.
setAction(action)RenderActionBuilderSets the action that add-ons can use to update the UI to the render action.
setHostAppAction(hostAppAction)RenderActionBuilderSets the host app action handled by individual host apps to the render action.