AddOns Response Service
AddOns Response Service
This service allows scripts to configure and build Google Workspace add-ons that extend Google Workspace Studio.
Classes
| Name | Brief description |
|---|---|
Action | An action that Google Workspace add-ons that extend Google Workspace Studio can use to render anew card. |
Add | Add provides the ability to create responses for Google Workspaceadd-ons that extend Google Workspace Studio. |
Basic | An enum that represents the basic generic data types. |
Color | A Color object which represents a color in the RGBA color space. |
Data | A DataType is used to set the type of a variable. |
Dynamic | A DynamicResourceDefinition is a building block for aResource, it can contain one or more numbers ofResource to dynamically define the number of output variables provided by a step in GoogleWorkspace Studio. |
Error | A Enum that represents the error actionability. |
Error | A Enum that represents the retry-ability of action invocation when having an error. |
Font | An enum that represents the font weight of the styled text. |
Host | A HostAppAction is a type of Action that is handled by individual host apps. |
Hyperlink | A Hyperlink element used inText. |
Insert | A builder for InsertSection objects. |
Insert | A builder for InsertWidget objects. |
Link | The link object from a third-party resource which gets converted it to a smart chip in the hostapplication. |
List | Container for list items, where each list item can contain multipleText. |
List | A list item, where each list item can contain multipleText. |
List | An enum that represents the type of the list. |
Modify | A builder forModify objects that changes and updates an existing card'sinterface by passing theModify object to aAction. |
Navigation | A helper object that controls card navigation. |
Remove | A builder forRemove objects. |
Remove | A builder for RemoveWidget objects. |
Render | Renders or updates a card by performing anAction in response to a user interaction. |
Render | A builder forRender objects. |
Resource | Represents a application specific resource data, a resource data contains a collection ofkey-value pairs of variable names andVariable. |
Resource | A ResourceField is a basic building block of aDynamic, each resourcefield corresponds to a output variable of the current step. |
Resource | AResource is a type ofResource that isused to retrieve the definition of a list of resource fields through thedynamic function specified in the manifest. |
Resource | A ResourceRetrievedAction is used to retrieve custom resource content when needed, where thecustom resource field is defined in the ResourceData. |
Resource | An application specific resource type, the unique identifier of the resource type should have acorresponding WorkflowResourceDefinition. |
Return | A ReturnElementErrorAction indicates that an error occurred during element invocation. |
Return | Contains output variables generated by the executed action in Google Workspace Studio. |
Save | This action indicates that the host app (Google Workspace Studio) should save the agent. |
Styled | Text element with styles such as bold, italic and color. |
Text | A clickable chip in the text format. |
Text | A text format element, which can be aText,Styled,Hyperlink, orList. |
Text | An icon that is displayed in aText. |
Text | An enum that represents the style of the styled text. |
Time | Represents a timestamp object which is can be added to aVariable. |
Update | A builder forUpdate objects. |
Validation | An enum that represents the severity of the validation error. |
Value | A valueMetadata contains information about the potential values of a variable. |
Variable | Represents a variable data which can contain a collection of values in various types. |
Workflow | A WorkflowAction is a type ofHost that is used to perform a specific action inGoogle Workspace Studio. |
Workflow | A block of text with rich formatting options including styles, hyperlinks, and interactiveelements defined inText. |
Workflow | This action indicates that the host app (Google Workspace Studio) should display a validationerror. |
Action
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Action | Adds a ModifyCard operation to the action. |
add | Action | Adds a card navigation to the action. |
AddOnsResponseService
Methods
| Method | Return type | Brief description |
|---|---|---|
new | Action | Creates a newAction. |
new | Navigation | Creates a newNavigation. |
new | Render | Creates a newRender. |
BasicDataType
Properties
| Property | Type | Description |
|---|---|---|
BASIC_TYPE_UNSPECIFIED | Enum | Default value. |
STRING | Enum | A string of characters. |
INTEGER | Enum | An integer value. |
FLOAT | Enum | A floating point number. |
TIMESTAMP | Enum | A timestamp in ISO 8601 format. |
BOOLEAN | Enum | A boolean value. |
EMAIL_ADDRESS | Enum | A string in the format of an email address. |
GOOGLE_USER | Enum | A user of the Google services, in the format of “users/encoded_GAIA_ID” |
FILE | Enum | A file type. |
FORMATTED_TEXT | Enum | A text with rich formatting. |
Color
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Color | Sets the alpha component of the color. |
set | Color | Sets the blue component of the color. |
set | Color | Sets the green component of the color. |
set | Color | Sets the red component of the color. |
DataType
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Data | Sets the data type to one of the supportedBasics. |
set | Data | Sets the data type to a custom definedResource. |
set | Data | Sets theValue, which contains type-related information related to thevariable. |
DynamicResourceDefinition
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Dynamic | Adds a resource field to the dynamic resource definition. |
set | Dynamic | Sets the ID for the dynamic resource definition, this ID corresponds to theworkflow in the manifest. |
ErrorActionability
Properties
| Property | Type | Description |
|---|---|---|
ERROR_ACTIONABILITY_UNSPECIFIED | Enum | Unspecified. |
NOT_ACTIONABLE | Enum | The error is not fixable by the user through the configuration card. |
ACTIONABLE | Enum | The error is fixable by the user through the configuration card. |
ErrorRetryability
Properties
| Property | Type | Description |
|---|---|---|
RETRYABILITY_UNSPECIFIED | Enum | Unspecified. |
NOT_RETRYABLE | Enum | The error is not retryable, the flow terminates after the first try. |
RETRYABLE | Enum | The error is retryable, Workflow is going to try to execute the Step for up to 5 times. |
FontWeight
Properties
| Property | Type | Description |
|---|---|---|
FONT_WEIGHT_UNSPECIFIED | Enum | Standard weight with normal thickness. |
LIGHT | Enum | Lighter weight with reduced thickness. |
MEDIUM | Enum | Intermediate weight between light and bold. |
BOLD | Enum | Heavier weight with increased thickness. |
HostAppAction
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Host | Sets the host app action to Workflow action. |
Hyperlink
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Hyperlink | Sets the destination URL of the hyperlink. |
set | Hyperlink | Sets the text of the hyperlink. |
InsertSection
Methods
| Method | Return type | Brief description |
|---|---|---|
insert | Insert | Sets the onCardTop flag, which indicates whether the new section should be inserted at the topof the card. |
insert | Insert | Sets the section ID, and the new section is inserted below it. |
set | Insert | Sets the card section to be inserted. |
InsertWidget
Methods
| Method | Return type | Brief description |
|---|---|---|
insert | Insert | Sets the widget ID, and the new widget is inserted above the widget with the given ID. |
insert | Insert | Sets the widget ID, and the new widget is inserted below the widget with the given ID. |
set | Insert | Sets theWidget to be inserted. |
Link
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Link | Sets the title of the link. |
set | Link | Sets the URL of the link. |
ListContainer
Methods
| Method | Return type | Brief description |
|---|---|---|
add | List | Adds a list item to the list container. |
set | List | Sets the level of the list, starts from 0 for the top level, and increases by 1 for each nestedlist. |
set | List | Sets the type of the list to be ordered or unordered. |
ListItem
Methods
| Method | Return type | Brief description |
|---|---|---|
add | List | Adds aText to the list item. |
ListType
Properties
| Property | Type | Description |
|---|---|---|
LIST_TYPE_UNSPECIFIED | Enum | Default value. |
ORDERED | Enum | Ordered list. |
UNORDERED | Enum | Unordered list. |
ModifyCard
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Modify | Sets theInsert for this modify card object. |
set | Modify | Sets theInsert for this modify card object. |
set | Modify | Sets theRemove for this modify card object. |
set | Modify | Sets theRemove for this modify card object. |
set | Modify | Sets the replacementCard for this modify card object, the replacement sectionshould have the same id as an existing card section. |
set | Modify | Sets the replacement widget for this modify card object, the replacement widget should have thesame id as an existing widget. |
set | Modify | Sets theUpdate for this modify card object. |
Navigation
Methods
| Method | Return type | Brief description |
|---|---|---|
print | String | Prints the JSON representation of this object. |
push | Navigation | Pushes the given card onto the stack. |
RemoveSection
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Remove | Sets the section ID of the section to be removed. |
RemoveWidget
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Remove | Sets the widget ID of the widget to be removed. |
RenderAction
Methods
| Method | Return type | Brief description |
|---|---|---|
print | String | Prints the JSON representation of this object. |
RenderActionBuilder
Methods
| Method | Return type | Brief description |
|---|---|---|
build() | Render | Builds the current render action and validates it. |
set | Render | Sets the action that add-ons can use to update the UI to the render action. |
set | Render | Sets theHost handled by individual host apps to the render action. |
ResourceData
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Resource | Adds aVariable keyed by its variable name, a value is overwritten if the keyalready exists. |
set | Resource | Sets the map of the variable data keyed by variable names. |
ResourceField
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Resource | Sets the data type of the field, allows other steps to filter the variables by type atselection. |
set | Resource | Sets the description of the field that is displayed to the end user during variable selectionin subsequent steps. |
set | Resource | Sets a key for the provider function to provide the value to during the step's execution. |
ResourceFieldsDefinitionRetrievedAction
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Resource | Adds aDynamic to the resource fields definition retrieved action. |
ResourceRetrievedAction
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Resource | Sets theResource to the resource retrieved action to provide values to the dynamicresource fields or custom resource fields. |
ResourceType
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Resource | Sets the workflow resource definition id. |
ReturnElementErrorAction
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Return | Sets the error actionability, an error should be actionable if it can be resolved byre-configuring the step. |
set | Return | Sets the error log to be displayed to the end user at Workflow's activity feed. |
set | Return | Sets the error retry-ability, the flow terminates after the first try if an error is notretryable. |
ReturnOutputVariablesAction
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Return | Adds a variable data keyed by its variable name, a value is overwritten if the key alreadyexists. |
set | Return | Sets the Log of the executed workflow action to the end user at Workflow's activity feed. |
set | Return | Sets the map of the variable data keyed by variable name, a value is overwritten if the keyalready exists. |
SaveWorkflowAction
StyledText
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Styled | Sets the style of the styled text, can apply multiple styles to a single styled text. |
set | Styled | Sets the color of the styled text. |
set | Styled | Sets the font weight of the styled text. |
set | Styled | Sets the main content of the styled text. |
TextFormatChip
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Text | Sets the text displayed in the chip. |
set | Text | Sets the icon displayed in the chip. |
set | Text | Sets the URL to navigate to when the chip is clicked. |
TextFormatElement
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Text | Sets the text format element as aHyperlink. |
set | Text | Sets the text format element as aList. |
set | Text | Sets the text format element as aStyled. |
set | Text | Sets the text format element as a text string. |
set | Text | Sets the text format element as aText. |
TextFormatIcon
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Text | Sets the icon URL. |
set | Text | Sets the material icon name defined in Google Material Icons. |
TextStyle
Properties
| Property | Type | Description |
|---|---|---|
STYLE_UNSPECIFIED | Enum | No style applied. |
ITALIC | Enum | Italic style. |
UNDERLINE | Enum | Underline style. |
STRIKETHROUGH | Enum | Strikethrough style. |
LINE_BREAK | Enum | Line break. |
UPPERCASE | Enum | Uppercase style. |
CODE | Enum | Code style. |
CODE_BLOCK | Enum | Code block style. |
TimeStamp
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Time | Sets the nanos of the timestamp, it represents the number of nanoseconds within the currentsecond. |
set | Time | Sets the seconds of the timestamp, it represents the number of seconds since the Unixepoch(January 1, 1970, 00:00:00 UTC). |
UpdateWidget
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Update | Adds a new item that can be selected, for multi-select menus. |
ValidationErrorSeverity
Properties
| Property | Type | Description |
|---|---|---|
SEVERITY_UNSPECIFIED | Enum | Unspecified. |
CRITICAL | Enum | Critical, the error is critical and must be fixed before publish. |
WARNING | Enum | Warning, the error is non-critical and is not blocking publish. |
ValueMetadata
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Value | Adds a optional allowed types that can be dynamically casted for a variable data to this valuemetadata. |
add | Value | Adds an optional string value to the allowed enum values of a variable, this field can only beset if theData is set to String type. |
set | Value | Sets the optional default value of the variable, example, if the variable type is boolean,defaultValue may be set to "true" or "false". |
VariableData
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Variable | Adds a boolean value to the variable data. |
add | Variable | Adds an email address to the variable data. |
add | Variable | Adds a float value to the variable data. |
add | Variable | Adds a google user to the variable data. |
add | Variable | Adds an integer value to the variable data. |
add | Variable | Adds aResource value to the variable data. |
add | Variable | Adds a resource reference ID to the variable data. |
add | Variable | Adds a string value to the variable data. |
add | Variable | Adds aTime value to the variable data. |
add | Variable | Adds aWorkflow value to the variable data. |
WorkflowAction
WorkflowTextFormat
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Workflow | Adds aText to the workflow text format. |
WorkflowValidationErrorAction
Methods
| Method | Return type | Brief description |
|---|---|---|
set | Workflow | Sets the severity of the validation error. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.