Card Service

    • The Card Service enables building card-based user interfaces for Google Workspace add-ons and Google Chat apps across desktop and mobile platforms.

    • Numerous classes are provided for interactive elements, layout, input and display widgets, response handling, data sources, and styling.

    • The service includes builders to construct complex UI components and enumerations for various property options.

    • Methods are available to configure properties, behaviors, and responses for UI elements.

    • Specific classes and methods are detailed for creating and managing different parts of the user interface, such as sections, cards, carousels, and responses.
    Card Service

    This service allows scripts to configure and build card and widget components and behaviors for a UI. The UI structures you build with this service are automatically available in both desktop and mobile devices, so you don't need to develop separate UIs for both.

    Classes

    Name Brief description
    Action An action that enables interactivity within UI elements.
    Action Response The response object that may be returned from a callback function (e.g., a form response handler) to perform one or more actions on the client.
    Action Response Builder A builder for Action Response objects.
    Action Status A class that represents the status for a request to either invoke or submit a dialog.
    Attachment Represents an attachment created by an add-on.
    Authorization Action An authorization action that will send the user to the AuthorizationUrl when clicked.
    Authorization Exception An error that can be returned to trigger an authorization card to be shown to the user.
    Border Style A class that represents a complete border style that can be applied to widgets.
    Border Type An enum that represents the border types that can be applied to widgets.
    Button A base class for all buttons.
    Button Set Holds a set of Button objects that are displayed in a row.
    Calendar Event Action Response Represents a response that makes changes to the calendar event that the user is currently editing in reaction to an action taken in the UI, such as a button click.
    Calendar Event Action Response Builder A builder for Calendar Event Action Response objects.
    Card A context card that represents a single view in the UI.
    Card Action A clickable menu item that is added to the card header menu.
    Card Builder A builder for Card objects.
    Card Header The header of a Card .
    Card Section A card section holds groups of widgets and provides visual separation between them.
    Card Service Card Service provides the ability to create generic cards used across different Google extensibility products, such as Google Workspace add-ons .
    Card With Id A builder for Card With Id objects.
    Carousel Carousel, also known as slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget.
    Carousel Card A card that can be displayed as a carousel item.
    Chat Action Response A class that represents the parameters that a Chat app can use to configure how its response is posted.
    Chat Client Data Source For a Selection Input widget that uses a multiselect menu, a data source from Google Chat.
    Chat Response The response object for a card message in Google Chat.
    Chat Response Builder A builder for Chat Response objects.
    Chat Space Data Source A data source that populates Google Chat spaces as selection items for a multiselect menu.
    Chip A Chip with an icon and text label.
    Chip List Holds a set of Chip objects that are displayed in a row, wrapping to the next line to horizontal scrollable.
    Chip List Layout An enum that specifies the layout for Chip List .
    Collapse Control A customizable collapse and expand control.
    Column A column.
    Columns The Columns widget displays up to 2 columns in a card or dialog.
    Common Data Source A data source shared by all Google Workspace applications.
    Common Widget Action Defines actions that don't involve evaluations, such as updating widget visibility.
    Compose Action Response The response object that may be returned from a callback method for compose action in a Gmail add-on .
    Compose Action Response Builder A builder for Compose Action Response objects.
    Composed Email Type An enum value that specifies whether the composed email is a standalone or reply draft.
    Condition A condition used to run an event action as part of CEL expression validation .
    Content Type An enum value that specifies the content type of the content generated by a Update Draft Action Response .
    Date Picker An input field that allows inputing a date.
    Date Time Picker An input field that allows users to input a date and time.
    Decorated Text A widget that displays text with optional decorations.
    Dialog For details, see Open interactive dialogs in the Google Chat documentation.
    Dialog Action A builder for Dialog Action objects.
    Display Style An enum that defines the display style of card.
    Divider A horizontal divider.
    Drive Items Selected Action Response Represents a response that makes changes to Drive while Drive items are selected and in reaction to an action taken in the UI, such as a button click.
    Drive Items Selected Action Response Builder A builder for Drive Items Selected Action Response objects.
    Editor File Scope Action Response Makes changes to an Editor, such as Google Docs, Sheets, or Slides in reaction to an action taken in the UI.
    Editor File Scope Action Response Builder A builder for Editor File Scope Action Response objects.
    Event Action An EventAction to run when a CEL expression validation condition is met.
    Expression Data The expression data that is used to evaluate an expression
    Expression Data Action Actions for CEL expression validation .
    Expression Data Action Type An enum that represents the type of the expression data action .
    Expression Data Condition Represents a CEL expression validation result.
    Expression Data Condition Type Represents whether the CEL expression evaluated successfully.
    Fixed Footer The fixed footer shown at the bottom of a Card .
    Grid An organized grid to display a collection of grid items.
    Grid Item The items users interact with within a grid widget.
    Grid Item Layout An enum that defines the image and text style of a GridItem.
    Horizontal Alignment An enum that specifies the horizontal alignment of a widget.
    Horizontal Size Style An enum that sets how widgets fill the space of a column.
    Host App Data Source For a Selection Input widget that uses a multiselect menu, a data source from a Google Workspace application.
    Icon Predefined icons that can be used in various UI objects, such as Image Button or Decorated Text widgets.
    Icon Image A predefined icon, a material design icon, or an icon from a URL with a customizable crop style.
    Image A widget that shows a single image.
    Image Button A Image Button with an image displayed on it.
    Image Button Style An enum that specifies the style for Image Button .
    Image Component An image component that can be added to grid items.
    Image Crop Style A class that represents a crop style that can be applied to image components.
    Image Crop Type An enum that represents the crop styles applied to image components.
    Image Style An enum that defines an image cropping style.
    Input Type An enum that defines the input type of the widget.
    Interaction An enum type that specifies what to do in response to an interaction with a user, such as a user clicking a button in a card message.
    Key Value This class is deprecated.
    Link Preview Card action that displays a link preview card and smart chip in the host app.
    Load Indicator An enum type that specifies the type of loading or progress indicator to display while an Action is being processed.
    Material Icon An object that supports all Google Font Icons .
    Navigation A helper object that controls card navigation.
    Notification A notification shown to the user as a response to interacting with a UI element.
    On Close An enum that specifies what to do when a URL opened through an Open Link is closed.
    Open As An enum that specifies how to open a URL.
    Open Link Represents an action to open a link with some options.
    Overflow Menu Holds a list of Overflow Menu Item objects that are displayed in a pop-up menu.
    Overflow Menu Item An Overflow Menu Item with an icon and text label.
    Platform Data Source For a Selection Input widget that uses a multiselect menu, a data source from Google Workspace.
    Response Type An enum that represents the type of Chat app response.
    Selection Input An input field that allows choosing between a set of predefined options.
    Selection Input Type The format of the items that users can select.
    Status An enum that represents the status code.
    Suggestions Autocomplete suggestions to supplement a Text Input widget.
    Suggestions Response A response object that can be returned from a suggestions callback function.
    Suggestions Response Builder A builder for Suggestions Response objects.
    Switch A UI element that supports being toggled on or off.
    Switch Control Type Type of a Switch widget control.
    Text Button A Text Button with a text label.
    Text Button Style An enum that specifies the style for Text Button .
    Text Input A input field widget that accepts text input.
    Text Paragraph A widget that displays text and supports basic HTML formatting .
    Time Picker An input field that allows users to input a time.
    Trigger A trigger that runs CEL expression validation widget event actions according to the action rule ID.
    Universal Action Response The response object that may be returned from a method that creates universal action.
    Universal Action Response Builder A builder for the Universal Action Response objects.
    Update Draft Action Response Represents an action that updates the email draft that the user is currently editing.
    Update Draft Action Response Builder A builder for Update Draft Action Response objects.
    Update Draft Bcc Recipients Action Updates the Bcc recipients of an email draft.
    Update Draft Body Action Updates the email draft body.
    Update Draft Body Type An enum value that specifies the type of an Update Draft Body Action .
    Update Draft Cc Recipients Action Updates the Cc recipients of an email draft.
    Update Draft Subject Action Updates the subject line of an email draft.
    Update Draft To Recipients Action Updates the To recipients of an email draft.
    Update Visibility Action Updates the visibility of a card widget to make it display or to hide it.
    Updated Widget The response of the updated widget.
    Validation An object that defines the validation rule for the widget that it is attached to.
    Variable Button Size An enum that represents the size of the variable picker button.
    Vertical Alignment An enum that sets the vertical alignment of widgets in a column.
    Visibility An enum that represents the visibility state of the widgets.
    Widget Base class for all widgets that can be added to a Card .
    Workflow Data Source For a Selection Input , Date Time Picker ` or Text Input widget, a data source from a Google Workspace flow.
    Workflow Data Source Type An enum that represents the type of the workflow data source.
    Wrap Style An enum that sets the wrapping style for content within a column.

    Action

    Methods

    Method Return type Brief description
    add Required Widget(requiredWidget)
    		Action Adds the names of the widgets that this Action needs for a valid submission.
    set All Widgets Are Required(allWidgetsAreRequired)
    		Action Indicates whether this Action requires inputs from all widgets.
    set Function Name(functionName)
    		Action Sets the name of the callback function to be called.
    set Interaction(interaction)
    		Action Sets the interaction with a user, only required when opening a dialog.
    set Load Indicator(loadIndicator)
    		Action Sets the loading indicator that displays while the action is in progress.
    set Parameters(parameters)
    		Action Allows custom parameters to be passed to the callback function.
    set Persist Values(persistValues)
    		Action Indicates whether form values are determined by the client's values or the server's values after an action response updates the form's Card .

    Action Response

    Methods

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

    Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Action Response Builds the current action response and validates it.
    set Navigation(navigation)
    		Action Response Builder Sets the response to a Navigation action.
    set Notification(notification)
    		Action Response Builder Sets the notification to display when the action is activated.
    set Open Link(openLink)
    		Action Response Builder Sets the URL to navigate to when the action is activated.
    set State Changed(stateChanged)
    		Action Response Builder Sets a flag to indicate that this action changed the existing data state.

    Action Status

    Methods

    Method Return type Brief description
    set Status Code(statusCode)
    		Action Status Represents the status for a request to either open or submit a dialog.
    set User Facing Message(message)
    		Action Status The message to send users about the status of their request.

    Attachment

    Methods

    Method Return type Brief description
    set Icon Url(iconUrl)
    		Attachment Sets the icon URL for the attachment.
    set Mime Type(mimeType)
    		Attachment Sets the MIME type for the attachment.
    set Resource Url(resourceUrl)
    		Attachment Sets the resource URL for the attachment.
    set Title(title)
    		Attachment Sets the title for the attachment.

    Authorization Action

    Methods

    Method Return type Brief description
    set Authorization Url(authorizationUrl)
    		Authorization Action Sets the authorization URL that user is taken to from the authorization prompt.

    Authorization Exception

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.
    set Authorization Url(authUrl)
    		Authorization Exception Sets the authorization URL that user is taken to from the authorization prompt.
    set Custom Ui Callback(callback)
    		Authorization Exception The name of a function to call to generate a custom authorization prompt.
    set Resource Display Name(name)
    		Authorization Exception Sets the name that is displayed to the user when asking for authorization.
    throw Exception()
    		void Triggers this exception to be thrown.

    Border Style

    Methods

    Method Return type Brief description
    set Corner Radius(radius)
    		Border Style Sets the corner radius of the border, for example 8.
    set Stroke Color(color)
    		Border Style Sets the color of the border.
    set Type(type)
    		Border Style Sets the type of the border.

    Border Type

    Properties

    Property Type Description
    NO_BORDER
    		Enum No border style.
    STROKE
    		Enum Stroke border style.

    Button

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Button Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Button Sets an action that composes a draft email when the object is clicked.
    set On Click Action(action)
    		Button Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Button Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Button Sets a URL to be opened when the object is clicked.
    set Overflow Menu(menu)
    		Button Sets a pop-up menu to be opened when the object is clicked.

    Button Set

    Methods

    Method Return type Brief description
    add Button(button)
    		Button Set Adds a button.

    Calendar Event Action Response

    Methods

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

    Calendar Event Action Response Builder

    Methods

    Method Return type Brief description
    add Attachments(attachments)
    		Calendar Event Action Response Builder Specifies that the response should add the attachments to the Calendar event when the associated UI action is taken.
    add Attendees(emails)
    		Calendar Event Action Response Builder Specifies that the response should add the indicated attendees to the Calendar event when the associated UI action is taken.
    build()
    		Calendar Event Action Response Builds the current Calendar event action response and validates it.
    set Conference Data(conferenceData)
    		Calendar Event Action Response Builder Specifies that the response should set the indicated conference data to the Calendar event when the associated UI action is taken.

    Card

    Methods

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

    Card Action

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Card Action Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Card Action Sets an action that composes a draft email when the object is clicked.
    set On Click Action(action)
    		Card Action Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Card Action Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Card Action Sets a URL to be opened when the object is clicked.
    set Text(text)
    		Card Action Sets the menu text for this action.

    Card Builder

    Methods

    Method Return type Brief description
    add Card Action(cardAction)
    		Card Builder Adds a Card Action to this Card.
    add Section(section)
    		Card Builder Adds a section to this card.
    build()
    		Card Builds the current card and validates it.
    set Display Style(displayStyle)
    		Card Builder Sets the display style for this card.
    set Fixed Footer(fixedFooter)
    		Card Builder Sets a fixed footer for this card.
    set Header(cardHeader)
    		Card Builder Sets the header for this card.
    set Name(name)
    		Card Builder Sets the name for this card.
    set Peek Card Header(peekCardHeader)
    		Card Builder Sets the peek card header.

    Card Header

    Methods

    Method Return type Brief description
    set Image Alt Text(imageAltText)
    		Card Header Sets the alternative text for the header image.
    set Image Style(imageStyle)
    		Card Header Sets the cropping of the icon in the card header.
    set Image Url(imageUrl)
    		Card Header Sets the image to use in the header by providing its URL or data string.
    set Subtitle(subtitle)
    		Card Header Sets the subtitle of the card header.
    set Title(title)
    		Card Header Sets the title of the card header.

    Card Section

    Methods

    Method Return type Brief description
    add Widget(widget)
    		Card Section Adds the given widget to this section.
    set Collapse Control(collapseControl)
    		Card Section Sets the customizable expand and collapse buttons of the section.
    set Collapsible(collapsible)
    		Card Section Sets whether the section can be collapsed.
    set Header(header)
    		Card Section Sets the header of the section.
    set Num Uncollapsible Widgets(numUncollapsibleWidgets)
    		Card Section Sets the number of widgets that are still shown when this section is collapsed.

    Card Service

    Properties

    Property Type Description
    Border Type
    		Border Type The Border Type enumeration.
    Chip List Layout
    		Chip List Layout The Chip List Layout enumeration.
    Composed Email Type
    		Composed Email Type The Composed Email Type enumeration.
    Content Type
    		Content Type The Content Type enumeration.
    Expression Data Action Type
    		Expression Data Action Type The Expression Data Action Type enumeration.
    Expression Data Condition Type
    		Expression Data Condition Type The Expression Data Condition Type enumeration.
    Grid Item Layout
    		Grid Item Layout The Grid Item Layout enumeration.
    Horizontal Alignment
    		Horizontal Alignment The Horizontal Alignment enumeration.
    Icon
    		Icon The Icon enumeration.
    Image Button Style
    		Image Button Style The Image Button Style enumeration.
    Image Crop Type
    		Image Crop Type The Image Crop Type enumeration.
    Image Style
    		Image Style The Image Style enumeration.
    Input Type
    		Input Type The Input Type enumeration.
    Load Indicator
    		Load Indicator The Load Indicator enumeration.
    On Close
    		On Close The On Close enumeration.
    Open As
    		Open As The Open As enumeration.
    Selection Input Type
    		Selection Input Type The Selection Input Type enumeration.
    Text Button Style
    		Text Button Style The Text Button Style enumeration.
    Update Draft Body Type
    		Update Draft Body Type The Update Draft Body Type enumeration.
    Visibility
    		Visibility The Visibility enumeration.
    Workflow Data Source Type
    		Workflow Data Source Type The Workflow Data Source Type enumeration.

    Methods

    Method Return type Brief description
    new Action()
    		Action Creates a new Action .
    new Action Response Builder()
    		Action Response Builder Creates a new Action Response Builder .
    new Action Status()
    		Action Status Creates a new Action Status .
    new Attachment()
    		Attachment Creates a new Attachment .
    new Authorization Action()
    		Authorization Action Creates a new Authorization Action .
    new Authorization Exception()
    		Authorization Exception Creates a new Authorization Exception .
    new Border Style()
    		Border Style Creates a new Border Style .
    new Button Set()
    		Button Set Creates a new Button Set .
    new Calendar Event Action Response Builder()
    		Calendar Event Action Response Builder Creates a new Calendar Event Action Response Builder .
    new Card Action()
    		Card Action Creates a new Card Action .
    new Card Builder()
    		Card Builder Creates a new Card builder.
    new Card Header()
    		Card Header Creates a new Card Header .
    new Card Section()
    		Card Section Creates a new Card Section .
    new Card With Id()
    		Card With Id Creates a new Card With Id .
    new Carousel()
    		Carousel Creates a Carousel .
    new Carousel Card()
    		Carousel Card Creates a new Carousel Card .
    new Chat Action Response()
    		Chat Action Response Creates a new Chat Action Response .
    new Chat Response Builder()
    		Chat Response Builder Creates a new Chat Response Builder .
    new Chip()
    		Chip Creates a new Chip .
    new Chip List()
    		Chip List Creates a new Chip List .
    new Collapse Control()
    		Collapse Control Creates a new Collapse Control .
    new Column()
    		Column Creates a new Column .
    new Columns()
    		Columns Creates a new set of Columns .
    new Compose Action Response Builder()
    		Compose Action Response Builder Creates a new Compose Action Response Builder .
    new Date Picker()
    		Date Picker Creates a new Date Picker .
    new Date Time Picker()
    		Date Time Picker Creates a new Date Time Picker .
    new Decorated Text()
    		Decorated Text Creates a new Decorated Text .
    new Dialog()
    		Dialog Creates a new Dialog .
    new Dialog Action()
    		Dialog Action Creates a new Dialog Action .
    new Divider()
    		Divider Creates a new Divider .
    new Drive Items Selected Action Response Builder()
    		Drive Items Selected Action Response Builder Creates a new Drive Items Selected Action Response Builder .
    new Editor File Scope Action Response Builder()
    		Editor File Scope Action Response Builder Creates a new Editor File Scope Action Response Builder .
    new Fixed Footer()
    		Fixed Footer Creates a new Fixed Footer .
    new Grid()
    		Grid Creates a new Grid .
    new Grid Item()
    		Grid Item Creates a new Grid Item .
    new Host App Data Source()
    		Host App Data Source Creates a new Host App Data Source and return an empty Host App Data Source .
    new Icon Image()
    		Icon Image Creates a new Icon Image .
    new Image()
    		Image Creates a new Image .
    new Image Button()
    		Image Button Creates a new Image Button .
    new Image Component()
    		Image Component Creates a new Image Component .
    new Image Crop Style()
    		Image Crop Style Creates a new Image Crop Style .
    new Key Value()
    		Key Value Creates a new Key Value .
    new Link Preview()
    		Link Preview Creates a new Link Preview .
    new Material Icon()
    		Material Icon Creates a new Material Icon .
    new Navigation()
    		Navigation Creates a new Navigation .
    new Notification()
    		Notification Creates a new Notification .
    new Open Link()
    		Open Link Creates a new Open Link .
    new Overflow Menu()
    		Overflow Menu Creates a new Overflow Menu .
    new Overflow Menu Item()
    		Overflow Menu Item Creates a new Overflow Menu Item .
    new Selection Input()
    		Selection Input Creates a new Selection Input .
    new Suggestions()
    		Suggestions Creates a new Suggestions .
    new Suggestions Response Builder()
    		Suggestions Response Builder Creates a new Suggestions Response Builder .
    new Switch()
    		Switch Creates a new Switch .
    new Text Button()
    		Text Button Creates a new Text Button .
    new Text Input()
    		Text Input Creates a new Text Input .
    new Text Paragraph()
    		Text Paragraph Creates a new Text Paragraph .
    new Time Picker()
    		Time Picker Creates a new Time Picker .
    new Universal Action Response Builder()
    		Universal Action Response Builder Creates a new Universal Action Response Builder .
    new Update Draft Action Response Builder()
    		Update Draft Action Response Builder Creates a new Update Draft Action Response Builder .
    new Update Draft Bcc Recipients Action()
    		Update Draft Bcc Recipients Action Creates a new Update Draft Bcc Recipients Action ;
    new Update Draft Body Action()
    		Update Draft Body Action Creates a new Update Draft Body Action .
    new Update Draft Cc Recipients Action()
    		Update Draft Cc Recipients Action Creates a new Update Draft Cc Recipients Action .
    new Update Draft Subject Action()
    		Update Draft Subject Action Creates a new Update Draft Subject Action .
    new Update Draft To Recipients Action()
    		Update Draft To Recipients Action Creates a new Update Draft To Recipients Action .
    new Validation()
    		Validation Creates a new Validation .

    Card With Id

    Methods

    Method Return type Brief description
    set Card(card)
    		Card With Id Sets the card of the card With Id .
    set Card Id(id)
    		Card With Id Sets the unique card ID of the card With Id .

    Methods

    Method Return type Brief description
    add Carousel Card(card)
    		Carousel Adds a carousel card.

    Carousel Card

    Methods

    Method Return type Brief description
    add Footer Widget(widget)
    		Carousel Card Adds the given widget to the footer of this carousel card.
    add Widget(widget)
    		Carousel Card Adds the given widget to this carousel card.

    Chat Action Response

    Methods

    Method Return type Brief description
    set Dialog Action(dialogAction)
    		Chat Action Response Sets the dialog action to an event related to a dialog.
    set Response Type(responseType)
    		Chat Action Response The type of Chat app response.
    set Updated Widget(updatedWidget)
    		Chat Action Response Sets the updated widget, used to provide autocomplete options for a widget.
    set Url(url)
    		Chat Action Response The URL for users to authenticate or configure.

    Chat Client Data Source

    Methods

    Method Return type Brief description
    set Space Data Source(spaceDataSource)
    		Chat Client Data Source A data source that populates Google Chat spaces as selection items for a multiselect menu.

    Chat Response

    Methods

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

    Chat Response Builder

    Methods

    Method Return type Brief description
    add Cards V2(cardWithId)
    		Chat Response Builder Sets the card field of the message.
    build()
    		Chat Response Builds the current action response and validates it.
    set Action Response(actionResponse)
    		Chat Response Builder Sets the action response field of the message.
    set Text(text)
    		Chat Response Builder Sets the text of the Chat message.

    Chat Space Data Source

    Methods

    Method Return type Brief description
    set Default To Current Space(defaultToCurrentSpace)
    		Chat Space Data Source If set to true , the multi select menu selects the current Google Chat space as an item by default.

    Chip

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Chip Sets the alternative text of the chip for accessibility.
    set Authorization Action(action)
    		Chip Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Chip Sets an action that composes a draft email when the object is clicked.
    set Disabled(disabled)
    		Chip Sets whether the chip is disabled.
    set Icon(icon)
    		Chip Sets the icon to be used as the chip.
    set Label(label)
    		Chip Sets the title of the chip.
    set On Click Action(action)
    		Chip Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Chip Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Chip Sets a URL to be opened when the object is clicked.

    Chip List

    Methods

    Method Return type Brief description
    add Chip(chip)
    		Chip List Adds a chip.
    set Layout(layout)
    		Chip List Sets the chip list layout.

    Chip List Layout

    Properties

    Property Type Description
    WRAPPED
    		Enum The chip list wraps to the next line if there isn't enough horizontal space.
    HORIZONTAL_SCROLLABLE
    		Enum The chips scroll horizontally if they don't fit in the available space.

    Collapse Control

    Methods

    Method Return type Brief description
    set Collapse Button(button)
    		Collapse Control Sets the Button that is displayed for "show less" button.
    set Expand Button(button)
    		Collapse Control Sets the Button that is displayed for "show more" button.
    set Horizontal Align(horizontalAlignment)
    		Collapse Control Sets the Horizontal Alignment of the Collapse Control .

    Column

    Methods

    Method Return type Brief description
    add Widget(widget)
    		Column Adds a widget to the column.
    set Horizontal Alignment(horizontalAlignment)
    		Column Sets the Horizontal Alignment of the Column .
    set Horizontal Size Style(horizontalSizeStyle)
    		Column Sets the Horizontal Size Style of the Column.
    set Vertical Alignment(verticalAlignment)
    		Column Sets the Vertical Alignment of the Column .

    Columns

    Methods

    Method Return type Brief description
    add Column(column)
    		Columns Adds a Column to the Columns widget.
    set Wrap Style(wrapStyle)
    		Columns Sets the wrap style of the columns, controls how the column resizes based on screen width.

    Common Data Source

    Properties

    Property Type Description
    UNKNOWN
    		Enum Default value.
    USER
    		Enum Google Workspace users.

    Common Widget Action

    Methods

    Method Return type Brief description
    set Update Visibility Action(updateVisibilityAction)
    		Common Widget Action Sets the update visibility action for widgets.

    Compose Action Response

    Methods

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

    Compose Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Compose Action Response Builds the current compose action response and validates it.
    set Gmail Draft(draft)
    		Compose Action Response Builder Sets the draft Gmail Message created using Gmail Message.createDraftReply(body) or similar functions.

    Composed Email Type

    Properties

    Property Type Description
    REPLY_AS_DRAFT
    		Enum A draft that is a reply to another message.
    STANDALONE_DRAFT
    		Enum A draft that is a standalone message.

    Condition

    Methods

    Method Return type Brief description
    set Action Rule Id(actionRuleId)
    		Condition The unique ID of the action rule to run in response to the condition.
    set Expression Data Condition(expressionDataCondition)
    		Condition Sets the CEL expression validation condition used to determine whether the event action should run.

    Content Type

    Properties

    Property Type Description
    TEXT
    		Enum Indicates that the generated content is plain text.
    MUTABLE_HTML
    		Enum Indicates that the generated content is formatted as HTML.
    IMMUTABLE_HTML
    		Enum Indicates that the generated content is formatted as HTML, but this content cannot be edited after it is generated.

    Date Picker

    Methods

    Method Return type Brief description
    set Field Name(fieldName)
    		Date Picker Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
    set On Change Action(action)
    		Date Picker Sets an Action that the script performs whenever the picker input changes.
    set Title(title)
    		Date Picker Sets the title displayed above the input field.
    set Value In Ms Since Epoch(valueMsEpoch)
    		Date Picker Sets the prefilled value to be set in the input field.
    set Value In Ms Since Epoch(valueMsEpoch)
    		Date Picker Sets the prefilled value to be set in the input field.

    Date Time Picker

    Methods

    Method Return type Brief description
    set Field Name(fieldName)
    		Date Time Picker Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
    set Host App Data Source(hostAppDataSource)
    		Date Time Picker In a Google Workspace flow, lets input variables accept datetime outputs from other steps in the flow.
    set On Change Action(action)
    		Date Time Picker Sets an Action that the script performs whenever the picker input changes.
    set Time Zone Offset In Mins(timeZoneOffsetMins)
    		Date Time Picker Sets the number of minutes that the time zone should be offset from UTC.
    set Title(title)
    		Date Time Picker Sets the title displayed above the input field.
    set Value In Ms Since Epoch(valueMsEpoch)
    		Date Time Picker Sets the prefilled value to be set in the input field.
    set Value In Ms Since Epoch(valueMsEpoch)
    		Date Time Picker Sets the prefilled value to be set in the input field.

    Decorated Text

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Decorated Text Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Bottom Label(text)
    		Decorated Text Sets the label text to be used as the key and is displayed below the text content.
    set Button(button)
    		Decorated Text Sets the Button that is displayed to the right of the text.
    set Compose Action(action, composedEmailType)
    		Decorated Text Sets an action that composes a draft email when the object is clicked.
    set End Icon(endIcon)
    		Decorated Text Sets the optional Icon Image that is displayed to the right of the content.
    set On Click Action(action)
    		Decorated Text Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Decorated Text Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Decorated Text Sets a URL to be opened when the object is clicked.
    set Start Icon(startIcon)
    		Decorated Text Sets the optional Icon Image to display before the text content.
    set Switch Control(switchToSet)
    		Decorated Text Sets the Switch that is displayed to the right of the content.
    set Text(text)
    		Decorated Text Sets the text to be used as the value.
    set Top Label(text)
    		Decorated Text Sets the label text to be used as the key and is displayed above the text content.
    set Wrap Text(wrapText)
    		Decorated Text Sets whether the value text should be displayed on a single line or multiple lines.

    Dialog

    Methods

    Method Return type Brief description
    set Body(card)
    		Dialog Sets the card of the Dialog .

    Dialog Action

    Methods

    Method Return type Brief description
    set Action Status(actionStatus)
    		Dialog Action Sets the action status of Dialog Action .
    set Dialog(dialog)
    		Dialog Action Sets the dialog of the Dialog Action .

    Display Style

    Properties

    Property Type Description
    PEEK
    		Enum Show the card header at the bottom of add-on content over existing content.
    REPLACE
    		Enum Show the card by replacing existing content.

    Divider

    Drive Items Selected Action Response

    Methods

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

    Drive Items Selected Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Drive Items Selected Action Response Builds the current Drive action response.
    request File Scope(itemId)
    		Drive Items Selected Action Response Builder Specifies that the response requests file scope for the contextually-relevant item in Drive.

    Editor File Scope Action Response

    Methods

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

    Editor File Scope Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Editor File Scope Action Response Builds the current Editor action response.
    request File Scope For Active Document()
    		Editor File Scope Action Response Builder Requests the drive.file scope for the current active Editor document.

    Event Action

    Methods

    Method Return type Brief description
    add Post Event Trigger(trigger)
    		Event Action Adds a CEL expression validation condition to evaluate after the event action runs.
    set Action Rule Id(actionRuleId)
    		Event Action Sets a unique identifier for the event action.
    set Common Widget Action(commonWidgetAction)
    		Event Action Set the common widget action for widgets.
    set Expression Data Action(expressionDataAction)
    		Event Action Sets the CEL expression validation data action for widgets.

    Expression Data

    Methods

    Method Return type Brief description
    add Condition(condition)
    		Expression Data Adds a condition to the current expression data.
    add Event Action(eventAction)
    		Expression Data Adds an event action to the current expression data.
    set Expression(expression)
    		Expression Data Sets the expression data value.
    set Id(id)
    		Expression Data Sets the expression data id.

    Expression Data Action

    Methods

    Method Return type Brief description
    set Action Type(type)
    		Expression Data Action Sets the type of the expression data action.

    Expression Data Action Type

    Properties

    Property Type Description
    ACTION_TYPE_UNSPECIFIED
    		Enum The unspecified action type.
    START_EXPRESSION_EVALUATION
    		Enum The action to start the CEL expression validation .

    Expression Data Condition

    Methods

    Method Return type Brief description
    set Condition Type(type)
    		Expression Data Condition Sets condition type for a CEL expression validation to indicate whether the expression evaluated successfully.

    Expression Data Condition Type

    Properties

    Property Type Description
    CONDITION_TYPE_UNSPECIFIED
    		Enum The unspecified condition type.
    EXPRESSION_EVALUATION_SUCCESS
    		Enum The CEL expression evaluated to a successful result.
    EXPRESSION_EVALUATION_FAILURE
    		Enum The CEL expression evaluated to a failure result.

    Fixed Footer

    Methods

    Method Return type Brief description
    set Primary Button(button)
    		Fixed Footer Set the primary button in the fixed footer.
    set Secondary Button(button)
    		Fixed Footer Set the secondary button in the fixed footer.

    Grid

    Methods

    Method Return type Brief description
    add Item(gridItem)
    		Grid Adds a new grid item to the grid.
    set Authorization Action(action)
    		Grid Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Border Style(borderStyle)
    		Grid Sets the border style applied to each grid item.
    set Compose Action(action, composedEmailType)
    		Grid Sets an action that composes a draft email when the object is clicked.
    set Num Columns(numColumns)
    		Grid The number of columns to display in the grid.
    set On Click Action(action)
    		Grid Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Grid Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Grid Sets a URL to be opened when the object is clicked.
    set Title(title)
    		Grid Sets the title text of the grid.

    Grid Item

    Methods

    Method Return type Brief description
    set Identifier(id)
    		Grid Item Sets the identifier for the grid item.
    set Image(image)
    		Grid Item Sets the image for this grid item.
    set Layout(layout)
    		Grid Item Sets the layout of text and image for the grid item.
    set Subtitle(subtitle)
    		Grid Item Sets the subtitle of the grid item.
    set Text Alignment(alignment)
    		Grid Item Sets the horizontal alignment of the grid item.
    set Title(title)
    		Grid Item Sets the title text of the grid item.

    Grid Item Layout

    Properties

    Property Type Description
    TEXT_BELOW
    		Enum The title and subtitle are shown below the grid item's image.
    TEXT_ABOVE
    		Enum The title and subtitle are shown above the grid item's image.

    Horizontal Alignment

    Properties

    Property Type Description
    START
    		Enum Align the widget to the start of the sentence side.
    CENTER
    		Enum Align the widget to the center.
    END
    		Enum Align the widget to the end of the sentence side.

    Horizontal Size Style

    Properties

    Property Type Description
    FILL_AVAILABLE_SPACE
    		Enum Sizes the Widget to fill the available horizontal space of a Column .
    FILL_MINIMUM_SPACE
    		Enum Resizes the Widget to fill the least amount of horizontal space in a Column .

    Host App Data Source

    Methods

    Method Return type Brief description
    set Chat Data Source(chatClientDataSource)
    		Host App Data Source Sets the data source from Google Chat.
    set Workflow Data Source(workflowDataSource)
    		Host App Data Source Sets the data source from Google Workspace Flows.

    Icon

    Properties

    Property Type Description
    NONE
    		Enum No icon.
    AIRPLANE
    		Enum Airplane flight icon
    BOOKMARK
    		Enum Bookmark icon
    BUS
    		Enum Bus icon
    CAR
    		Enum Car icon
    CLOCK
    		Enum Clock icon
    CONFIRMATION_NUMBER_ICON
    		Enum Confirmation number icon
    DOLLAR
    		Enum Dollar icon
    DESCRIPTION
    		Enum Description icon
    EMAIL
    		Enum Email icon
    EVENT_PERFORMER
    		Enum Email icon
    EVENT_SEAT
    		Enum Event seat icon
    FLIGHT_ARRIVAL
    		Enum Flight arrival icon
    FLIGHT_DEPARTURE
    		Enum Flight departure icon
    HOTEL
    		Enum Hotel icon
    HOTEL_ROOM_TYPE
    		Enum Hotel icon
    INVITE
    		Enum Invite icon
    MAP_PIN
    		Enum Map pin icon
    MEMBERSHIP
    		Enum Membershipt icon
    MULTIPLE_PEOPLE
    		Enum Multiple people icon
    OFFER
    		Enum Offer icon
    PERSON
    		Enum Person icon
    PHONE
    		Enum Phone icon
    RESTAURANT_ICON
    		Enum Restaurant icon
    SHOPPING_CART
    		Enum Shopping cart icon
    STAR
    		Enum Star icon
    STORE
    		Enum Store icon
    TICKET
    		Enum Ticket icon
    TRAIN
    		Enum Train icon
    VIDEO_CAMERA
    		Enum Video camera icon
    VIDEO_PLAY
    		Enum Video play icon

    Icon Image

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Icon Image Sets the alternative text of the URL which is used for accessibility.
    set Icon(icon)
    		Icon Image Sets the predefined icon if the URL is not set.
    set Icon Url(url)
    		Icon Image Sets the URL of the icon if the icon is not set.
    set Image Crop Type(imageCropType)
    		Icon Image Sets the crop style for the image.
    set Material Icon(icon)
    		Icon Image Sets the material design icon.

    Image

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Image Sets the alternative text of the image for accessibility.
    set Authorization Action(action)
    		Image Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Image Sets an action that composes a draft email when the object is clicked.
    set Image Url(url)
    		Image Sets the image to use by providing its URL or data string.
    set On Click Action(action)
    		Image Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Image Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Image Sets a URL to be opened when the object is clicked.

    Image Button

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Image Button Sets the alternative text of the button for accessibility.
    set Authorization Action(action)
    		Image Button Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Image Button Sets an action that composes a draft email when the object is clicked.
    set Icon(icon)
    		Image Button Sets a predefined Icon to display on the button.
    set Icon Url(url)
    		Image Button Sets the URL of an image to use as this button's icon.
    set Image Button Style(imageButtonStyle)
    		Image Button Sets the button style.
    set Material Icon(icon)
    		Image Button Sets the material design icon.
    set On Click Action(action)
    		Image Button Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Image Button Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Image Button Sets a URL to be opened when the object is clicked.
    set Overflow Menu(menu)
    		Image Button Sets a pop-up menu to be opened when the object is clicked.

    Image Button Style

    Properties

    Property Type Description
    BORDERLESS
    		Enum Image button with no border.
    OUTLINED
    		Enum Image button with clear background.
    FILLED
    		Enum Image button with colored background.
    FILLED_TONAL
    		Enum Image button with an alternative middle ground between filled and outlined buttons.

    Image Component

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Image Component Sets the alternative text of the image.
    set Border Style(borderStyle)
    		Image Component Sets the border style applied to the image.
    set Crop Style(imageCropStyle)
    		Image Component Sets the crop style for the image.
    set Image Url(url)
    		Image Component Sets the URL of the image.

    Image Crop Style

    Methods

    Method Return type Brief description
    set Aspect Ratio(ratio)
    		Image Crop Style Sets the aspect ratio to use if the crop type is RECTANGLE_CUSTOM .
    set Image Crop Type(type)
    		Image Crop Style Sets the crop type for the image.

    Image Crop Type

    Properties

    Property Type Description
    SQUARE
    		Enum Square shape crop style.
    CIRCLE
    		Enum Circle shape crop style.
    RECTANGLE_CUSTOM
    		Enum Rectangle shape crop style with custom ratio.
    RECTANGLE_4_3
    		Enum Rectangle shape crop style with 4:3 ratio.

    Image Style

    Properties

    Property Type Description
    SQUARE
    		Enum No cropping.
    CIRCLE
    		Enum Crop to a circle shape.

    Input Type

    Properties

    Property Type Description
    TEXT
    		Enum Accept regular text.
    INTEGER
    		Enum Accept an integer.
    FLOAT
    		Enum Accept a floating-point number.
    EMAIL
    		Enum Accept an email address.

    Interaction

    Properties

    Property Type Description
    INTERACTION_UNSPECIFIED
    		Enum Default value.
    OPEN_DIALOG
    		Enum Opens a dialog, a card-based interface that Chat apps use to interact with users.

    Key Value

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Key Value Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Key Value Sets an action that composes a draft email when the object is clicked.
    set On Click Action(action)
    		Key Value Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Key Value Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Key Value Sets a URL to be opened when the object is clicked.

    Link Preview

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.
    set Link Preview Title(title)
    		Link Preview Sets the title that displays in the link preview above the preview card.
    set Preview Card(previewCard)
    		Link Preview Sets the card that displays information about a link from a third-party or non-Google service.
    set Title(title)
    		Link Preview Sets the title that displays in the smart chip for the link preview.

    Load Indicator

    Properties

    Property Type Description
    SPINNER
    		Enum Use a spinner indicator.
    NONE
    		Enum Do not use an indicator.

    Material Icon

    Methods

    Method Return type Brief description
    set Fill(fill)
    		Material Icon Whether the icon renders as filled.
    set Grade(grade)
    		Material Icon Weight and grade affect a symbol’s thickness.
    set Name(name)
    		Material Icon Sets the name of the icon.
    set Weight(weight)
    		Material Icon The stroke weight of the icon.

    Methods

    Method Return type Brief description
    pop Card()
    		Navigation Pops a card from the navigation stack.
    pop To Named Card(cardName)
    		Navigation Pops to the specified card by its card name.
    pop To Root()
    		Navigation Pops the card stack to the root card.
    print Json()
    		String Prints the JSON representation of this object.
    push Card(card)
    		Navigation Pushes the given card onto the stack.
    update Card(card)
    		Navigation Does an in-place replacement of the current card.

    Notification

    Methods

    Method Return type Brief description
    set Text(text)
    		Notification Sets the text to show in the notification.

    On Close

    Properties

    Property Type Description
    NOTHING
    		Enum Do nothing on close.
    RELOAD
    		Enum Reloads the add-on on when the window closes.

    Open As

    Properties

    Property Type Description
    FULL_SIZE
    		Enum Open in a full window or tab.
    OVERLAY
    		Enum Open as an overlay such as a pop-up.

    Methods

    Method Return type Brief description
    set On Close(onClose)
    		Open Link Sets the behavior of the URL action when the URL window or tab is closed.
    set Open As(openAs)
    		Open Link Sets the behavior of URL when it is opened.
    set Url(url)
    		Open Link Sets the URL to be opened.

    Overflow Menu

    Methods

    Method Return type Brief description
    add Menu Item(menuItem)
    		Overflow Menu Adds a menu item.

    Overflow Menu Item

    Methods

    Method Return type Brief description
    set Authorization Action(action)
    		Overflow Menu Item Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Compose Action(action, composedEmailType)
    		Overflow Menu Item Sets an action that composes a draft email when the object is clicked.
    set Disabled(disabled)
    		Overflow Menu Item Sets whether the menu item is disabled.
    set On Click Action(action)
    		Overflow Menu Item Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Overflow Menu Item Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Overflow Menu Item Sets a URL to be opened when the object is clicked.
    set Start Icon(icon)
    		Overflow Menu Item Sets the menu item's leading icon.
    set Text(text)
    		Overflow Menu Item Sets the title of the menu item.

    Platform Data Source

    Methods

    Method Return type Brief description
    set Common Data Source(commonDataSource)
    		Platform Data Source Sets the data source from Google Workspace.
    set Host App Data Source(hostAppDataSource)
    		Platform Data Source Used to populate spaces in multiselect menu.

    Response Type

    Properties

    Property Type Description
    TYPE_UNSPECIFIED
    		Enum Default type that's handled as NEW_MESSAGE .
    NEW_MESSAGE
    		Enum Post as a new message in the topic.
    UPDATE_MESSAGE
    		Enum Update the Chat app's message.
    UPDATE_USER_MESSAGE_CARDS
    		Enum Update the cards on a user's message.
    REQUEST_CONFIG
    		Enum Privately ask the user for additional authentication or configuration.
    DIALOG
    		Enum Presents a dialog.
    UPDATE_WIDGET
    		Enum Widget text autocomplete options query.

    Selection Input

    Methods

    Method Return type Brief description
    add Item(text, value, selected)
    		Selection Input Adds a new item that can be selected.
    add Multi Select Item(text, value, selected, startIconUri, bottomText)
    		Selection Input Adds a new item that can be selected, for multi-select menus.
    set External Data Source(action)
    		Selection Input Sets external data source, such as a relational data base.
    set Field Name(fieldName)
    		Selection Input Sets the key that identifies this selection input in the event object that is generated when there is a UI interaction.
    set Multi Select Max Selected Items(maxSelectedItems)
    		Selection Input Sets the maximum number of items that a user can select.
    set Multi Select Min Query Length(queryLength)
    		Selection Input Sets the number of text characters that a user inputs before the app queries autocomplete and displays suggested items on the card.
    set On Change Action(action)
    		Selection Input Sets an Action to be performed whenever the selection input changes.
    set Platform Data Source(platformDataSource)
    		Selection Input Sets a data source from Google Workspace.
    set Title(title)
    		Selection Input Sets the title to be shown ahead of the input field.
    set Type(type)
    		Selection Input Sets the type of this input.

    Selection Input Type

    Properties

    Property Type Description
    CHECK_BOX
    		Enum Checkbox input style.
    RADIO_BUTTON
    		Enum Radio button input style.
    DROPDOWN
    		Enum Dropdown menu selection input style.
    SWITCH
    		Enum A set of switches.
    MULTI_SELECT
    		Enum A multiselect menu for static or dynamic data.
    OVERFLOW_MENU
    		Enum A UI element that houses additional options that don't fit within the primary interface

    Status

    Properties

    Property Type Description
    OK
    		Enum HTTP Mapping: 200 OK
    CANCELLED
    		Enum HTTP Mapping: 499 Client Closed Request
    UNKNOWN
    		Enum Unknown error.
    INVALID_ARGUMENT
    		Enum The client specified an invalid argument.
    DEADLINE_EXCEEDED
    		Enum HTTP Mapping: 504 Gateway Timeout
    NOT_FOUND
    		Enum HTTP Mapping: 404 Not Found
    ALREADY_EXISTS
    		Enum The entity that a client attempted to create already exists.
    PERMISSION_DENIED
    		Enum HTTP Mapping: 403 Forbidden
    UNAUTHENTICATED
    		Enum HTTP Mapping: 401 Unauthorized
    RESOURCE_EXHAUSTED
    		Enum HTTP Mapping: 429 Too Many Requests
    FAILED_PRECONDITION
    		Enum The operation was rejected because the system is not in a state required for the operation's execution.
    ABORTED
    		Enum The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.
    OUT_OF_RANGE
    		Enum The operation was attempted past the valid range.
    UNIMPLEMENTED
    		Enum HTTP Mapping: 501 Not Implemented
    INTERNAL
    		Enum Internal errors.
    UNAVAILABLE
    		Enum HTTP Mapping: 503 Service Unavailable
    DATA_LOSS
    		Enum Unrecoverable data loss or corruption.

    Suggestions

    Methods

    Method Return type Brief description
    add Suggestion(suggestion)
    		Suggestions Add a text suggestion.
    add Suggestions(suggestions)
    		Suggestions Add a list of text suggestions.

    Suggestions Response

    Methods

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

    Suggestions Response Builder

    Methods

    Method Return type Brief description
    build()
    		Suggestions Response Builds the current suggestions response and validates it.
    set Suggestions(suggestions)
    		Suggestions Response Builder Sets the suggestions used in auto complete in text fields.

    Switch

    Methods

    Method Return type Brief description
    set Control Type(controlType)
    		Switch Sets the control type of the switch.
    set Field Name(fieldName)
    		Switch Sets the key that identifies this switch in the event object that is generated when there is a UI interaction.
    set On Change Action(action)
    		Switch Sets the action to take when the switch is toggled.
    set Selected(selected)
    		Switch Sets whether this switch should start as selected or unselected.
    set Value(value)
    		Switch Sets the value that is sent as the form input when this switch is toggled on.

    Switch Control Type

    Properties

    Property Type Description
    SWITCH
    		Enum Toggle-styled control for a switch widget.
    CHECK_BOX
    		Enum Checkbox-styled control for a switch widget.

    Text Button

    Methods

    Method Return type Brief description
    set Alt Text(altText)
    		Text Button Sets the alternative text of the button for accessibility.
    set Authorization Action(action)
    		Text Button Sets an authorization action that opens a URL to the authorization flow when the object is clicked.
    set Background Color(backgroundColor)
    		Text Button Sets the background color for Text Button Style.FILLED button.
    set Compose Action(action, composedEmailType)
    		Text Button Sets an action that composes a draft email when the object is clicked.
    set Disabled(disabled)
    		Text Button Sets whether the button is disabled.
    set Icon(icon)
    		Text Button Sets a predefined Icon to display on the button.
    set Icon Url(url)
    		Text Button Sets the URL of an image to use as this button's icon.
    set Material Icon(icon)
    		Text Button Sets the material design icon.
    set On Click Action(action)
    		Text Button Sets an action that executes when the object is clicked.
    set On Click Open Link Action(action)
    		Text Button Sets an action that opens a URL in a tab when the object is clicked.
    set Open Link(openLink)
    		Text Button Sets a URL to be opened when the object is clicked.
    set Overflow Menu(menu)
    		Text Button Sets a pop-up menu to be opened when the object is clicked.
    set Text(text)
    		Text Button Sets the text that displays on the button.
    set Text Button Style(textButtonStyle)
    		Text Button Sets the button style.

    Text Button Style

    Properties

    Property Type Description
    OUTLINED
    		Enum Normal text button with clear background.
    TEXT
    		Enum DO NOT USE.
    FILLED
    		Enum Text button with colored background.
    FILLED_TONAL
    		Enum Normal text button with an alternative middle ground between filled and outlined buttons.
    BORDERLESS
    		Enum Normal text button with no border.

    Text Input

    Methods

    Method Return type Brief description
    set Field Name(fieldName)
    		Text Input Sets the key that identifies this text input in the event object that is generated when there is a UI interaction.
    set Hint(hint)
    		Text Input Sets a hint for the text input.
    set Host App Data Source(hostAppDataSource)
    		Text Input Sets a data source from Google Workspace applications.
    set Multiline(multiline)
    		Text Input Sets whether the input text shows on one line or multiple lines.
    set On Change Action(action)
    		Text Input Sets an action to be performed whenever the text input changes.
    set Suggestions(suggestions)
    		Text Input Sets the suggestions for autocompletion in the text field.
    set Suggestions Action(suggestionsAction)
    		Text Input Sets the callback action to fetch suggestions based on user input for autocompletion.
    set Title(title)
    		Text Input Sets the title to be shown above the input field.
    set Validation(validation)
    		Text Input Sets the validation rule for this widget.
    set Value(value)
    		Text Input Sets the pre-filled value to be set in the input field.

    Text Paragraph

    Methods

    Method Return type Brief description
    set Max Lines(maxLines)
    		Text Paragraph Sets the maximum number of lines of text that are displayed in the widget.
    set Text(text)
    		Text Paragraph Sets the text of the paragraph.

    Time Picker

    Methods

    Method Return type Brief description
    set Field Name(fieldName)
    		Time Picker Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
    set Hours(hours)
    		Time Picker Sets the prefilled hours value to set in the input field.
    set Minutes(minutes)
    		Time Picker Sets the prefilled minutes value to set in the input field.
    set On Change Action(action)
    		Time Picker Sets an Action that the script performs whenever the picker input changes.
    set Title(title)
    		Time Picker Sets the title displayed above the input field.

    Trigger

    Methods

    Method Return type Brief description
    set Action Rule Id(actionRuleId)
    		Trigger Sets the action rule id for the trigger.

    Universal Action Response

    Methods

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

    Universal Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Universal Action Response Builds the current universal action response and validates it.
    display Add On Cards(cardObjects)
    		Universal Action Response Builder Displays the add-on with the specified cards.
    set Open Link(openLink)
    		Universal Action Response Builder Sets the URL to open when the universal action is selected.

    Update Draft Action Response

    Methods

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

    Update Draft Action Response Builder

    Methods

    Method Return type Brief description
    build()
    		Update Draft Action Response Builds the current update draft action response and validates it.
    set Update Draft Bcc Recipients Action(updateDraftBccRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the email Bcc recipients of a draft.
    set Update Draft Body Action(updateDraftBodyAction)
    		Update Draft Action Response Builder Set an action that updates the email body of a draft.
    set Update Draft Cc Recipients Action(updateDraftCcRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the Cc recipients of a draft.
    set Update Draft Subject Action(updateDraftSubjectAction)
    		Update Draft Action Response Builder Sets an action that updates the subject line of a draft.
    set Update Draft To Recipients Action(updateDraftToRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the To recipients of a draft.

    Update Draft Bcc Recipients Action

    Methods

    Method Return type Brief description
    add Update Bcc Recipients(bccRecipientEmails)
    		Update Draft Bcc Recipients Action Updates the Bcc recipients of an email draft.

    Update Draft Body Action

    Methods

    Method Return type Brief description
    add Update Content(content, contentType)
    		Update Draft Body Action Adds the specified content to the draft body.
    set Update Type(updateType)
    		Update Draft Body Action Sets the Update Draft Body Type of this update action on the draft body.

    Update Draft Body Type

    Properties

    Property Type Description
    IN_PLACE_INSERT
    		Enum Default.
    INSERT_AT_START
    		Enum Update actions insert content at the start of message body.
    INSERT_AT_END
    		Enum Update actions insert content at the end of the message body.

    Update Draft Cc Recipients Action

    Methods

    Method Return type Brief description
    add Update Cc Recipients(ccRecipientEmails)
    		Update Draft Cc Recipients Action Updates the Cc recipients of an email draft.

    Update Draft Subject Action

    Methods

    Method Return type Brief description
    add Update Subject(subject)
    		Update Draft Subject Action Updates the subject line of an email draft.

    Update Draft To Recipients Action

    Methods

    Method Return type Brief description
    add Update To Recipients(toRecipientEmails)
    		Update Draft To Recipients Action Updates the To recipients of an email draft.

    Update Visibility Action

    Methods

    Method Return type Brief description
    set Visibility(visibility)
    		Update Visibility Action Sets the visibility of widgets to visible or hidden.

    Updated Widget

    Methods

    Method Return type Brief description
    add Item(text, value, selected, startIconUri, bottomText)
    		Updated Widget Adds a new item that can be selected.

    Validation

    Methods

    Method Return type Brief description
    set Character Limit(characterLimit)
    		Validation Sets the character limit of the widget.
    set Input Type(inputType)
    		Validation Sets the input type of the widget.

    Variable Button Size

    Properties

    Property Type Description
    UNSPECIFIED
    		Enum Automatically chooses COMPACT for Sidepanel, chooses FULL_SIZE otherwise.
    COMPACT
    		Enum For buttons labeled `+`
    FULL_SIZE
    		Enum For buttons labeled `+ variable`

    Vertical Alignment

    Properties

    Property Type Description
    CENTER
    		Enum Vertically places the content at the center of the container.
    TOP
    		Enum Vertically places the content at the top of the container.
    BOTTOM
    		Enum Vertically places the content at the bottom of the container.

    Visibility

    Properties

    Property Type Description
    VISIBLE
    		Enum The UI element is visible.
    HIDDEN
    		Enum The UI element is invisible.
    VISIBILITY_UNSPECIFIED
    		Enum The UI element is unspecified.

    Widget

    Workflow Data Source

    Methods

    Method Return type Brief description
    set Include Variables(includeVariables)
    		Workflow Data Source Whether to include variables from the previous step in the data source.
    set Type(type)
    		Workflow Data Source Sets the type of the workflow data source.
    set Variable Button Label(variableButtonLabel)
    		Workflow Data Source Sets the label of the variable picker button, which will be displayed after the `+` sign in FULL_SIZE button size.
    set Variable Button Size(variableButtonSize)
    		Workflow Data Source Sets the size of the variable picker button, Workflow will automatically using COMPACT in side panel and FULL_SIZE in other cases if UNSPECIFIED is selected.

    Workflow Data Source Type

    Properties

    Property Type Description
    UNKNOWN
    		Enum Default value.
    USER
    		Enum The data source is a user's data.
    SPACE
    		Enum The data source is a Google Chat space.
    USER_WITH_FREE_FORM
    		Enum The data source is a user's data; users can choose to view and select existing members from their Google Workspace organization or manually enter an email address or a valid domain.

    Wrap Style

    Properties

    Property Type Description
    NOWRAP
    		Enum No wrapping.
    WRAP
    		Enum Wraps the content for any widgets in a column.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: