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. |
ActionResponse
|
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. |
ActionResponseBuilder
|
A builder for ActionResponse
objects. |
ActionStatus
|
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. |
AuthorizationAction
|
An authorization action that will send the user to the AuthorizationUrl when clicked. |
AuthorizationException
|
An error that can be returned to trigger an authorization card to be shown to the user. |
BorderStyle
|
A class that represents a complete border style that can be applied to widgets. |
BorderType
|
An enum that represents the border types that can be applied to widgets. |
Button
|
A base class for all buttons. |
ButtonSet
|
Holds a set of Button
objects that are displayed in a row. |
CalendarEventActionResponse
|
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. |
CalendarEventActionResponseBuilder
|
A builder for CalendarEventActionResponse
objects. |
Card
|
A context card that represents a single view in the UI. |
CardAction
|
A clickable menu item that is added to the card header menu. |
CardBuilder
|
A builder for Card
objects. |
CardHeader
|
The header of a Card
. |
CardSection
|
A card section holds groups of widgets and provides visual separation between them. |
CardService
|
CardService provides the ability to create generic cards used across different Google extensibility products, such as Google Workspace Add-ons . |
CardWithId
|
A builder for CardWithId
objects. |
ChatActionResponse
|
A class that represents the parameters that a Chat app can use to configure how its response is posted. |
ChatClientDataSource
|
For a SelectionInput
widget that uses a multiselect menu, a data source from Google Chat. |
ChatResponse
|
The response object for a card message in Google Chat. |
ChatResponseBuilder
|
A builder for ChatResponse
objects. |
ChatSpaceDataSource
|
A data source that populates Google Chat spaces as selection items for a multiselect menu. |
CommonDataSource
|
A data source shared by all Google Workspace applications. |
ComposeActionResponse
|
The response object that may be returned from a callback method for compose action in a Gmail add-on . |
ComposeActionResponseBuilder
|
A builder for ComposeActionResponse
objects. |
ComposedEmailType
|
An enum value that specifies whether the composed email is a standalone or reply draft. |
ContentType
|
An enum value that specifies the content type of the content generated by a UpdateDraftActionResponse
. |
DatePicker
|
An input field that allows inputing a date. |
DateTimePicker
|
An input field that allows users to input a date and time. |
DecoratedText
|
A widget that displays text with optional decorations. |
Dialog
|
For details, see Open interactive dialogs in the Google Chat documentation. |
DialogAction
|
A builder for DialogAction
objects. |
DisplayStyle
|
An enum that defines the display style of card. |
Divider
|
A horizontal divider. |
DriveItemsSelectedActionResponse
|
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. |
DriveItemsSelectedActionResponseBuilder
|
A builder for DriveItemsSelectedActionResponse
objects. |
EditorFileScopeActionResponse
|
Makes changes to an Editor, such as Google Docs, Sheets, or Slides in reaction to an action taken in the UI. |
EditorFileScopeActionResponseBuilder
|
A builder for EditorFileScopeActionResponse
objects. |
FixedFooter
|
The fixed footer shown at the bottom of a Card
. |
Grid
|
An organized grid to display a collection of grid items. |
GridItem
|
The items users interact with within a grid widget. |
GridItemLayout
|
An enum that defines the image and text style of a GridItem. |
HorizontalAlignment
|
An enum that specifies the horizontal alignment of a widget. |
HorizontalSizeStyle
|
An enum that sets how widgets fill the space of a column. |
HostAppDataSource
|
For a SelectionInput
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 ImageButton
or DecoratedText
widgets. |
IconImage
|
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. |
ImageButton
|
A ImageButton
with an image displayed on it. |
ImageComponent
|
An image component that can be added to grid items. |
ImageCropStyle
|
A class that represents a crop style that can be applied to image components. |
ImageCropType
|
An enum that represents the crop styles applied to image components. |
ImageStyle
|
An enum that defines an image cropping style. |
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. |
|
This class is deprecated. |
LinkPreview
|
Card action that displays a link preview card and smart chip in the host app. |
LoadIndicator
|
An enum type that specifies the type of loading or progress indicator to display while an Action
is being processed. |
Navigation
|
A helper object that controls card navigation. |
Notification
|
A notification shown to the user as a response to interacting with a UI element. |
OnClose
|
An enum that specifies what to do when a URL opened through an OpenLink
is closed. |
OpenAs
|
An enum that specifies how to open a URL. |
OpenLink
|
Represents an action to open a link with some options. |
PlatformDataSource
|
For a SelectionInput
widget that uses a multiselect menu, a data source from Google
Workspace. |
ResponseType
|
An enum that represents the type of Chat app response. |
SelectionInput
|
An input field that allows choosing between a set of predefined options. |
SelectionInputType
|
The format of the items that users can select. |
Status
|
An enum that represents the status code. |
Suggestions
|
Autocomplete suggestions to supplement a TextInput
widget. |
SuggestionsResponse
|
A response object that can be returned from a suggestions callback function. |
SuggestionsResponseBuilder
|
A builder for SuggestionsResponse
objects. |
Switch
|
A UI element that supports being toggled on or off. |
SwitchControlType
|
Type of a Switch
widget control. |
TextButton
|
A TextButton
with a text label. |
TextButtonStyle
|
An enum that specifies the style for TextButton
. |
TextInput
|
A input field widget that accepts text input. |
TextParagraph
|
A widget that displays text and supports basic HTML formatting . |
TimePicker
|
An input field that allows users to input a time. |
UniversalActionResponse
|
The response object that may be returned from a method that creates universal action. |
UniversalActionResponseBuilder
|
A builder for the UniversalActionResponse
objects. |
UpdateDraftActionResponse
|
Represents an action that updates the email draft that the user is currently editing. |
UpdateDraftActionResponseBuilder
|
A builder for UpdateDraftActionResponse
objects. |
UpdateDraftBccRecipientsAction
|
Updates the Bcc recipients of an email draft. |
UpdateDraftBodyAction
|
Updates the email draft body. |
UpdateDraftBodyType
|
An enum value that specifies the type of an UpdateDraftBodyAction
. |
UpdateDraftCcRecipientsAction
|
Updates the Cc recipients of an email draft. |
UpdateDraftSubjectAction
|
Updates the subject line of an email draft. |
UpdateDraftToRecipientsAction
|
Updates the To recipients of an email draft. |
UpdatedWidget
|
The response of the updated widget. |
VerticalAlignment
|
An enum that sets the vertical alignment of widgets in a column. |
Widget
|
Base class for all widgets that can be added to a Card
. |
WrapStyle
|
An enum that sets the wrapping style for content within a column. |
Action
Methods
Method | Return type | Brief description |
---|---|---|
Action
|
Sets the name of the callback function to be called. | |
Action
|
Sets the interaction with a user, only required when opening a dialog. | |
Action
|
Sets the loading indicator that displays while the action is in progress. | |
Action
|
Allows custom parameters to be passed to the callback function. | |
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
. |
ActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
ActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
ActionResponse
|
Builds the current action response and validates it. | |
ActionResponseBuilder
|
Sets the response to a Navigation
action. |
|
ActionResponseBuilder
|
Sets the notification to display when the action is activated. | |
ActionResponseBuilder
|
Sets the URL to navigate to when the action is activated. | |
ActionResponseBuilder
|
Sets a flag to indicate that this action changed the existing data state. |
ActionStatus
Methods
Method | Return type | Brief description |
---|---|---|
ActionStatus
|
Represents the status for a request to either open or submit a dialog. | |
ActionStatus
|
The message to send users about the status of their request. |
Attachment
Methods
Method | Return type | Brief description |
---|---|---|
Attachment
|
Sets the icon URL for the attachment. | |
Attachment
|
Sets the MIME type for the attachment. | |
Attachment
|
Sets the resource URL for the attachment. | |
Attachment
|
Sets the title for the attachment. |
AuthorizationAction
Methods
Method | Return type | Brief description |
---|---|---|
AuthorizationAction
|
Sets the authorization URL that user is taken to from the authorization prompt. |
AuthorizationException
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. | |
AuthorizationException
|
Sets the authorization URL that user is taken to from the authorization prompt. | |
AuthorizationException
|
The name of a function to call to generate a custom authorization prompt. | |
AuthorizationException
|
Sets the name that is displayed to the user when asking for authorization. | |
void
|
Triggers this exception to be thrown. |
BorderStyle
Methods
Method | Return type | Brief description |
---|---|---|
BorderStyle
|
Sets the corner radius of the border, for example 8. | |
BorderStyle
|
Sets the color of the border. | |
BorderStyle
|
Sets the type of the border. |
BorderType
Properties
Property | Type | Description |
---|---|---|
NO_BORDER
|
Enum
|
No border style. |
STROKE
|
Enum
|
Stroke border style. |
Button
Methods
Method | Return type | Brief description |
---|---|---|
Button
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
Button
|
Sets an action that composes a draft email when the object is clicked. | |
Button
|
Sets an action that executes when the object is clicked. | |
Button
|
Sets an action that opens a URL in a tab when the object is clicked. | |
Button
|
Sets a URL to be opened when the object is clicked. |
ButtonSet
Methods
Method | Return type | Brief description |
---|---|---|
ButtonSet
|
Adds a button. |
CalendarEventActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
CalendarEventActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
CalendarEventActionResponseBuilder
|
Specifies that the response should add the attachments to the Calendar event when the associated UI action is taken. | |
CalendarEventActionResponseBuilder
|
Specifies that the response should add the indicated attendees to the Calendar event when the associated UI action is taken. | |
CalendarEventActionResponse
|
Builds the current Calendar event action response and validates it. | |
CalendarEventActionResponseBuilder
|
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 |
---|---|---|
String
|
Prints the JSON representation of this object. |
CardAction
Methods
Method | Return type | Brief description |
---|---|---|
CardAction
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
CardAction
|
Sets an action that composes a draft email when the object is clicked. | |
CardAction
|
Sets an action that executes when the object is clicked. | |
CardAction
|
Sets an action that opens a URL in a tab when the object is clicked. | |
CardAction
|
Sets a URL to be opened when the object is clicked. | |
CardAction
|
Sets the menu text for this action. |
CardBuilder
Methods
Method | Return type | Brief description |
---|---|---|
CardBuilder
|
Adds a CardAction
to this Card. |
|
CardBuilder
|
Adds a section to this card. | |
Card
|
Builds the current card and validates it. | |
CardBuilder
|
Sets the display style for this card. | |
CardBuilder
|
Sets a fixed footer for this card. | |
CardBuilder
|
Sets the header for this card. | |
CardBuilder
|
Sets the name for this card. | |
CardBuilder
|
Sets the peek card header. |
CardHeader
Methods
Method | Return type | Brief description |
---|---|---|
CardHeader
|
Sets the alternative text for the header image. | |
CardHeader
|
Sets the cropping of the icon in the card header. | |
CardHeader
|
Sets the image to use in the header by providing its URL or data string. | |
CardHeader
|
Sets the subtitle of the card header. | |
CardHeader
|
Sets the title of the card header. |
CardSection
Methods
Method | Return type | Brief description |
---|---|---|
CardSection
|
Adds the given widget to this section. | |
CardSection
|
Sets whether the section can be collapsed. | |
CardSection
|
Sets the header of the section. | |
CardSection
|
Sets the number of widgets that are still shown when this section is collapsed. |
CardService
Properties
Property | Type | Description |
---|---|---|
BorderType
|
BorderType
|
The BorderType
enumeration. |
ComposedEmailType
|
ComposedEmailType
|
The ComposedEmailType
enumeration. |
ContentType
|
ContentType
|
The ContentType
enumeration. |
GridItemLayout
|
GridItemLayout
|
The GridItemLayout
enumeration. |
HorizontalAlignment
|
HorizontalAlignment
|
The HorizontalAlignment
enumeration. |
Icon
|
Icon
|
The Icon
enumeration. |
ImageCropType
|
ImageCropType
|
The ImageCropType
enumeration. |
ImageStyle
|
ImageStyle
|
The ImageStyle
enumeration. |
LoadIndicator
|
LoadIndicator
|
The LoadIndicator
enumeration. |
OnClose
|
OnClose
|
The OnClose
enumeration. |
OpenAs
|
OpenAs
|
The OpenAs
enumeration. |
SelectionInputType
|
SelectionInputType
|
The SelectionInputType
enumeration. |
TextButtonStyle
|
TextButtonStyle
|
The TextButtonStyle
enumeration. |
UpdateDraftBodyType
|
UpdateDraftBodyType
|
The UpdateDraftBodyType
enumeration. |
Methods
CardWithId
Methods
Method | Return type | Brief description |
---|---|---|
CardWithId
|
Sets the card of the cardWithId
. |
|
CardWithId
|
Sets the unique card ID of the cardWithId
. |
ChatActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
ChatActionResponse
|
Sets the dialog action to an event related to a dialog. | |
ChatActionResponse
|
The type of Chat app response. | |
ChatActionResponse
|
Sets the updated widget, used to provide autocomplete options for a widget. | |
ChatActionResponse
|
The URL for users to authenticate or configure. |
ChatClientDataSource
Methods
Method | Return type | Brief description |
---|---|---|
ChatClientDataSource
|
A data source that populates Google Chat spaces as selection items for a multiselect menu. |
ChatResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
ChatResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
ChatResponseBuilder
|
Sets the card field of the message. | |
ChatResponse
|
Builds the current action response and validates it. | |
ChatResponseBuilder
|
Sets the action response field of the message. | |
ChatResponseBuilder
|
Sets the text of the Chat message. |
ChatSpaceDataSource
Methods
Method | Return type | Brief description |
---|---|---|
ChatSpaceDataSource
|
If set to true
, the multi select menu selects the current Google Chat space as an item
by default. |
Column
Methods
Method | Return type | Brief description |
---|---|---|
Column
|
Adds a widget to the column. | |
Column
|
Sets the HorizontalAlignment
of the Column
. |
|
Column
|
Sets the HorizontalSizeStyle
of the Column. |
|
Column
|
Sets the VerticalAlignment
of the Column
. |
Columns
Methods
Method | Return type | Brief description |
---|---|---|
Columns
|
Adds a Column
to the Columns widget. |
|
Columns
|
Sets the wrap style of the columns, controls how the column resizes based on screen width. |
CommonDataSource
Properties
Property | Type | Description |
---|---|---|
UNKNOWN
|
Enum
|
Default value. |
USER
|
Enum
|
Google Workspace users. |
ComposeActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
ComposeActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
ComposeActionResponse
|
Builds the current compose action response and validates it. | |
ComposeActionResponseBuilder
|
Sets the draft GmailMessage
created
using GmailMessage.createDraftReply(body)
or
similar functions. |
ComposedEmailType
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. |
ContentType
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. |
DatePicker
Methods
Method | Return type | Brief description |
---|---|---|
DatePicker
|
Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. | |
DatePicker
|
Sets an Action
that the script performs whenever the picker input changes. |
|
DatePicker
|
Sets the title displayed above the input field. | |
DatePicker
|
Sets the prefilled value to be set in the input field. | |
DatePicker
|
Sets the prefilled value to be set in the input field. |
DateTimePicker
Methods
Method | Return type | Brief description |
---|---|---|
DateTimePicker
|
Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. | |
DateTimePicker
|
Sets an Action
that the script performs whenever the picker input changes. |
|
DateTimePicker
|
Sets the number of minutes that the time zone should be offset from UTC. | |
DateTimePicker
|
Sets the title displayed above the input field. | |
DateTimePicker
|
Sets the prefilled value to be set in the input field. | |
DateTimePicker
|
Sets the prefilled value to be set in the input field. |
DecoratedText
Methods
Method | Return type | Brief description |
---|---|---|
DecoratedText
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
DecoratedText
|
Sets the label text to be used as the key and is displayed below the text content. | |
DecoratedText
|
Sets the Button
that is displayed to the right of the text. |
|
DecoratedText
|
Sets an action that composes a draft email when the object is clicked. | |
DecoratedText
|
Sets the optional IconImage
that is displayed to the right of the content. |
|
DecoratedText
|
Sets an action that executes when the object is clicked. | |
DecoratedText
|
Sets an action that opens a URL in a tab when the object is clicked. | |
DecoratedText
|
Sets a URL to be opened when the object is clicked. | |
DecoratedText
|
Sets the optional IconImage
to display before the text content. |
|
DecoratedText
|
Sets the Switch
that is displayed to the right of the content. |
|
DecoratedText
|
Sets the text to be used as the value. | |
DecoratedText
|
Sets the label text to be used as the key and is displayed above the text content. | |
DecoratedText
|
Sets whether the value text should be displayed on a single line or multiple lines. |
Dialog
Methods
Method | Return type | Brief description |
---|---|---|
Dialog
|
Sets the card of the Dialog
. |
DialogAction
Methods
Method | Return type | Brief description |
---|---|---|
DialogAction
|
Sets the action status of DialogAction
. |
|
DialogAction
|
Sets the dialog of the DialogAction
. |
DisplayStyle
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
DriveItemsSelectedActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
DriveItemsSelectedActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
DriveItemsSelectedActionResponse
|
Builds the current Drive action response. | |
DriveItemsSelectedActionResponseBuilder
|
Specifies that the response requests file scope for the contextually-relevant item in Drive. |
EditorFileScopeActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
EditorFileScopeActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
EditorFileScopeActionResponse
|
Builds the current Editor action response. | |
EditorFileScopeActionResponseBuilder
|
Requests the drive.file
scope for the current active Editor document. |
FixedFooter
Methods
Method | Return type | Brief description |
---|---|---|
FixedFooter
|
Set the primary button in the fixed footer. | |
FixedFooter
|
Set the secondary button in the fixed footer. |
Grid
Methods
Method | Return type | Brief description |
---|---|---|
Grid
|
Adds a new grid item to the grid. | |
Grid
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
Grid
|
Sets the border style applied to each grid item. | |
Grid
|
Sets an action that composes a draft email when the object is clicked. | |
Grid
|
The number of columns to display in the grid. | |
Grid
|
Sets an action that executes when the object is clicked. | |
Grid
|
Sets an action that opens a URL in a tab when the object is clicked. | |
Grid
|
Sets a URL to be opened when the object is clicked. | |
Grid
|
Sets the title text of the grid. |
GridItem
Methods
Method | Return type | Brief description |
---|---|---|
GridItem
|
Sets the identifier for the grid item. | |
GridItem
|
Sets the image for this grid item. | |
GridItem
|
Sets the layout of text and image for the grid item. | |
GridItem
|
Sets the subtitle of the grid item. | |
GridItem
|
Sets the horizontal alignment of the grid item. | |
GridItem
|
Sets the title text of the grid item. |
GridItemLayout
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. |
HorizontalAlignment
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. |
HorizontalSizeStyle
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
. |
HostAppDataSource
Methods
Method | Return type | Brief description |
---|---|---|
HostAppDataSource
|
Sets the data source from Google Chat. |
Icon
Properties
Property | Type | Description |
---|---|---|
NONE
|
Enum
|
No icon. |
AIRPLANE
|
Enum
|
![]() |
BOOKMARK
|
Enum
|
![]() |
BUS
|
Enum
|
![]() |
CAR
|
Enum
|
![]() |
CLOCK
|
Enum
|
![]() |
CONFIRMATION_NUMBER_ICON
|
Enum
|
![]() |
DOLLAR
|
Enum
|
![]() |
DESCRIPTION
|
Enum
|
![]() |
EMAIL
|
Enum
|
![]() |
EVENT_PERFORMER
|
Enum
|
![]() |
EVENT_SEAT
|
Enum
|
![]() |
FLIGHT_ARRIVAL
|
Enum
|
![]() |
FLIGHT_DEPARTURE
|
Enum
|
![]() |
HOTEL
|
Enum
|
![]() |
HOTEL_ROOM_TYPE
|
Enum
|
![]() |
INVITE
|
Enum
|
![]() |
MAP_PIN
|
Enum
|
![]() |
MEMBERSHIP
|
Enum
|
![]() |
MULTIPLE_PEOPLE
|
Enum
|
![]() |
OFFER
|
Enum
|
![]() |
PERSON
|
Enum
|
![]() |
PHONE
|
Enum
|
![]() |
RESTAURANT_ICON
|
Enum
|
![]() |
SHOPPING_CART
|
Enum
|
![]() |
STAR
|
Enum
|
![]() |
STORE
|
Enum
|
![]() |
TICKET
|
Enum
|
![]() |
TRAIN
|
Enum
|
![]() |
VIDEO_CAMERA
|
Enum
|
![]() |
VIDEO_PLAY
|
Enum
|
![]() |
IconImage
Methods
Method | Return type | Brief description |
---|---|---|
IconImage
|
Sets the alternative text of the URL which is used for accessibility. | |
IconImage
|
Sets the predefined icon if the URL is not set. | |
IconImage
|
Sets the URL of the icon if the icon is not set. | |
IconImage
|
Sets the crop style for the image. |
Image
Methods
Method | Return type | Brief description |
---|---|---|
Image
|
Sets the alternative text of the image for accessibility. | |
Image
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
Image
|
Sets an action that composes a draft email when the object is clicked. | |
Image
|
Sets the image to use by providing its URL or data string. | |
Image
|
Sets an action that executes when the object is clicked. | |
Image
|
Sets an action that opens a URL in a tab when the object is clicked. | |
Image
|
Sets a URL to be opened when the object is clicked. |
ImageButton
Methods
Method | Return type | Brief description |
---|---|---|
ImageButton
|
Sets the alternative text of the button for accessibility. | |
ImageButton
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
ImageButton
|
Sets an action that composes a draft email when the object is clicked. | |
ImageButton
|
Sets a predefined Icon
to display on the button. |
|
ImageButton
|
Sets the URL of an image to use as this button's icon. | |
ImageButton
|
Sets an action that executes when the object is clicked. | |
ImageButton
|
Sets an action that opens a URL in a tab when the object is clicked. | |
ImageButton
|
Sets a URL to be opened when the object is clicked. |
ImageComponent
Methods
Method | Return type | Brief description |
---|---|---|
ImageComponent
|
Sets the alternative text of the image. | |
ImageComponent
|
Sets the border style applied to the image. | |
ImageComponent
|
Sets the crop style for the image. | |
ImageComponent
|
Sets the URL of the image. |
ImageCropStyle
Methods
Method | Return type | Brief description |
---|---|---|
ImageCropStyle
|
Sets the aspect ratio to use if the crop type is RECTANGLE_CUSTOM
. |
|
ImageCropStyle
|
Sets the crop type for the image. |
ImageCropType
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. |
ImageStyle
Properties
Property | Type | Description |
---|---|---|
SQUARE
|
Enum
|
No cropping. |
CIRCLE
|
Enum
|
Crop to a circle shape. |
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. |
KeyValue
KeyValue
Methods
Method | Return type | Brief description |
---|---|---|
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
|
Sets an action that composes a draft email when the object is clicked. | |
|
Sets an action that executes when the object is clicked. | |
|
Sets an action that opens a URL in a tab when the object is clicked. | |
|
Sets a URL to be opened when the object is clicked. |
LinkPreview
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. | |
LinkPreview
|
Sets the title that displays in the link preview above the preview card. | |
LinkPreview
|
Sets the card that displays information about a link from a third-party or non-Google service. | |
LinkPreview
|
Sets the title that displays in the smart chip for the link preview. |
LoadIndicator
Properties
Property | Type | Description |
---|---|---|
SPINNER
|
Enum
|
Use a spinner indicator. |
NONE
|
Enum
|
Do not use an indicator. |
Navigation
Methods
Method | Return type | Brief description |
---|---|---|
Navigation
|
Pops a card from the navigation stack. | |
Navigation
|
Pops to the specified card by its card name. | |
Navigation
|
Pops the card stack to the root card. | |
String
|
Prints the JSON representation of this object. | |
Navigation
|
Pushes the given card onto the stack. | |
Navigation
|
Does an in-place replacement of the current card. |
Notification
Methods
Method | Return type | Brief description |
---|---|---|
Notification
|
Sets the text to show in the notification. |
OnClose
Properties
Property | Type | Description |
---|---|---|
NOTHING
|
Enum
|
Do nothing on close. |
RELOAD
|
Enum
|
Reloads the add-on on when the window closes. |
OpenAs
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. |
OpenLink
Methods
Method | Return type | Brief description |
---|---|---|
OpenLink
|
Sets the behavior of the URL action when the URL window or tab is closed. | |
OpenLink
|
Sets the behavior of URL when it is opened. | |
OpenLink
|
Sets the URL to be opened. |
PlatformDataSource
Methods
Method | Return type | Brief description |
---|---|---|
PlatformDataSource
|
Sets the data source from Google Workspace. | |
PlatformDataSource
|
Used to populate spaces in multiselect menu. |
ResponseType
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. |
SelectionInput
Methods
Method | Return type | Brief description |
---|---|---|
SelectionInput
|
Adds a new item that can be selected. | |
SelectionInput
|
Adds a new item that can be selected, for multi-select menus. | |
SelectionInput
|
Sets external data source, such as a relational data base. | |
SelectionInput
|
Sets the key that identifies this selection input in the event object that is generated when there is a UI interaction. | |
SelectionInput
|
Sets the maximum number of items that a user can select. | |
SelectionInput
|
Sets the number of text characters that a user inputs before the app queries autocomplete and displays suggested items on the card. | |
SelectionInput
|
Sets an Action
to be performed whenever the selection input changes. |
|
SelectionInput
|
Sets a data source from Google Workspace. | |
SelectionInput
|
Sets the title to be shown ahead of the input field. | |
SelectionInput
|
Sets the type of this input. |
SelectionInputType
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. |
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 |
---|---|---|
Suggestions
|
Add a text suggestion. | |
Suggestions
|
Add a list of text suggestions. |
SuggestionsResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
SuggestionsResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
SuggestionsResponse
|
Builds the current suggestions response and validates it. | |
SuggestionsResponseBuilder
|
Sets the suggestions used in auto complete in text fields. |
Switch
Methods
Method | Return type | Brief description |
---|---|---|
Switch
|
Sets the control type of the switch. | |
Switch
|
Sets the key that identifies this switch in the event object that is generated when there is a UI interaction. | |
Switch
|
Sets the action to take when the switch is toggled. | |
Switch
|
Sets whether this switch should start as selected or unselected. | |
Switch
|
Sets the value that is sent as the form input when this switch is toggled on. |
SwitchControlType
Properties
Property | Type | Description |
---|---|---|
SWITCH
|
Enum
|
Toggle-styled control for a switch widget. |
CHECK_BOX
|
Enum
|
Checkbox-styled control for a switch widget. |
TextButton
Methods
Method | Return type | Brief description |
---|---|---|
TextButton
|
Sets the alternative text of the button for accessibility. | |
TextButton
|
Sets an authorization action that opens a URL to the authorization flow when the object is clicked. | |
TextButton
|
Sets the background color for TextButtonStyle.FILLED
button. |
|
TextButton
|
Sets an action that composes a draft email when the object is clicked. | |
TextButton
|
Sets whether the button is disabled. | |
TextButton
|
Sets an action that executes when the object is clicked. | |
TextButton
|
Sets an action that opens a URL in a tab when the object is clicked. | |
TextButton
|
Sets a URL to be opened when the object is clicked. | |
TextButton
|
Sets the text that displays on the button. | |
TextButton
|
Sets the button style. |
TextButtonStyle
Properties
Property | Type | Description |
---|---|---|
OUTLINED
|
Enum
|
Normal text button with clear background. |
FILLED
|
Enum
|
Text button with colored background. |
TextInput
Methods
Method | Return type | Brief description |
---|---|---|
TextInput
|
Sets the key that identifies this text input in the event object that is generated when there is a UI interaction. | |
TextInput
|
Sets a hint for the text input. | |
TextInput
|
Sets whether the input text shows on one line or multiple lines. | |
TextInput
|
Sets an action to be performed whenever the text input changes. | |
TextInput
|
Sets the suggestions for autocompletion in the text field. | |
TextInput
|
Sets the callback action to fetch suggestions based on user input for autocompletion. | |
TextInput
|
Sets the title to be shown above the input field. | |
TextInput
|
Sets the pre-filled value to be set in the input field. |
TextParagraph
Methods
Method | Return type | Brief description |
---|---|---|
TextParagraph
|
Sets the text of the paragraph. |
TimePicker
Methods
Method | Return type | Brief description |
---|---|---|
TimePicker
|
Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. | |
TimePicker
|
Sets the prefilled hours value to set in the input field. | |
TimePicker
|
Sets the prefilled minutes value to set in the input field. | |
TimePicker
|
Sets an Action
that the script performs whenever the picker input changes. |
|
TimePicker
|
Sets the title displayed above the input field. |
UniversalActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
UniversalActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
UniversalActionResponse
|
Builds the current universal action response and validates it. | |
UniversalActionResponseBuilder
|
Displays the add-on with the specified cards. | |
UniversalActionResponseBuilder
|
Sets the URL to open when the universal action is selected. |
UpdateDraftActionResponse
Methods
Method | Return type | Brief description |
---|---|---|
String
|
Prints the JSON representation of this object. |
UpdateDraftActionResponseBuilder
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftActionResponse
|
Builds the current update draft action response and validates it. | |
UpdateDraftActionResponseBuilder
|
Sets an action that updates the email Bcc recipients of a draft. | |
UpdateDraftActionResponseBuilder
|
Set an action that updates the email body of a draft. | |
UpdateDraftActionResponseBuilder
|
Sets an action that updates the Cc recipients of a draft. | |
UpdateDraftActionResponseBuilder
|
Sets an action that updates the subject line of a draft. | |
UpdateDraftActionResponseBuilder
|
Sets an action that updates the To recipients of a draft. |
UpdateDraftBccRecipientsAction
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftBccRecipientsAction
|
Updates the Bcc recipients of an email draft. |
UpdateDraftBodyAction
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftBodyAction
|
Adds the specified content to the draft body. | |
UpdateDraftBodyAction
|
Sets the UpdateDraftBodyType
of this update action on the draft body. |
UpdateDraftBodyType
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. |
UpdateDraftCcRecipientsAction
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftCcRecipientsAction
|
Updates the Cc recipients of an email draft. |
UpdateDraftSubjectAction
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftSubjectAction
|
Updates the subject line of an email draft. |
UpdateDraftToRecipientsAction
Methods
Method | Return type | Brief description |
---|---|---|
UpdateDraftToRecipientsAction
|
Updates the To recipients of an email draft. |
UpdatedWidget
Methods
Method | Return type | Brief description |
---|---|---|
UpdatedWidget
|
Adds a new item that can be selected. |
VerticalAlignment
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. |
Widget
WrapStyle
Properties
Property | Type | Description |
---|---|---|
NOWRAP
|
Enum
|
No wrapping. |
WRAP
|
Enum
|
Wraps the content for any widgets in a column. |