- EventObject
- CommonEventObject
- HostApp
- Platform
- TimeZone
- Inputs
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organizer
- Attendee
- ConferenceData
- ConferenceSolution
- Key
- EntryPoint
- Parameters
- AddOnParameters
- Capabilities
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- Icon
- StyledText
- Style
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
A Google add-on interaction event that contains data about a user's interaction with an add-on within a host app.
The event object is passed as JSON to an add-on's callback function or trigger (for AppsScript), or https endpoint (for HTTP), when a user interacts with an add-on within a host app. The event object stores a host app event object defined by each host app, as well as a common event object containing some common fields related to the event.
For more information see Event objects.
| JSON representation |
|---|
{ "commonEventObject": { object ( |
| Fields | |
|---|---|
commonEventObject |
An object containing information common to all event objects, regardless of the host application. |
authorizationEventObject |
Only set for requests to HTTP endpoints |
| The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
calendar |
Only present if the calling host is Google Calendar. An object containing calendar and event information. |
drive |
Only present if the calling host is Google Drive. An object containing Drive information. |
gmail |
Only present if the calling host is Gmail. An object containing Gmail information. |
sheets |
Only present if the calling host is Google Sheets. An object containing Sheets information. |
slides |
Only present if the calling host is Google Slides. An object containing Slides information. |
docs |
Only present if the calling host is Google Docs. An object containing Docs information. |
chat |
Only present if the calling host is Google Chat. An object containing Chat information. |
workflow |
Only present if the calling host is Google Workspace Studio. An object containing workflow information. |
| End of mutually exclusive fields. | |
CommonEventObject
The common event object is the portion of the overall event object that carries general, host-independent information to the add-on from the user's client. This information includes details such as the user's locale, host app, and platform.
In addition to homepage and contextual triggers, add-ons construct and pass event objects to action callback functions when the user interacts with widgets. Your add-on's callback function can query the common event object to determine the contents of open widgets in the user's client. For example, your add-on can locate the text a user has entered into a TextInput widget in the eventObject.commentEventObject.formInputs object.
For Chat apps, the name of the function that the user invoked when interacting with a widget.
| JSON representation |
|---|
{ "userLocale": string, "hostApp": enum ( |
| Fields | |
|---|---|
userLocale |
Disabled by default. The user's language and country/region identifier in the format of ISO 639 language code-ISO 3166 country/region code. For example, To turn on this field, you must set |
hostApp |
Indicates the host app the add-on is active in when the event object is generated. Possible values include the following:
|
platform |
The platform enum which indicates the platform where the event originates ( |
timeZone |
Disabled by default. The timezone ID and offset from Coordinated Universal Time (UTC). To turn on this field, you must set Only supported for the event types |
formInputs |
A map containing the current values of the widgets in the displayed card. The map keys are the string The structure of the map value object is dependent on the widget type: Note: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add
Example: for a text input widget with
Example: for a multi-value widget with
Example: For a picker with a
Example: For a picker with a
Example: For a picker with a An object containing a list of |
parameters |
Any additional parameters you supply to an action using Developer Preview: For add-ons that extend Google Chat, to suggest items based on what the users type in multiselect menus, use the value of the An object containing a list of |
invokedFunction |
Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the |
HostApp
The Google Workspace application for a Google Workspace add-on or Google Chat app.
For add-ons, the Workspace application from which a Google Workspace add-on launches. For Chat apps, the host app is always CHAT.
| Enums | |
|---|---|
UNSPECIFIED_HOST_APP |
Google can't identify a host app. |
GMAIL |
The add-on launches from Gmail. |
CALENDAR |
The add-on launches from Google Calendar. |
DRIVE |
The add-on launches from Google Drive. |
DEMO |
Not used. |
DOCS |
The add-on launches from Google Docs. |
MEET |
The add-on launches from Google Meet. |
SHEETS |
The add-on launches from Google Sheets. |
SLIDES |
The add-on launches from Google Slides. |
DRAWINGS |
The add-on launches from Google Drawings. |
CHAT |
A Google Chat app. |
Platform
Identifies which platform this call originated from.
| Enums | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types CARD_CLICKED and SUBMIT_DIALOG.
| JSON representation |
|---|
{ "id": string, "offset": integer } |
| Fields | |
|---|---|
id |
The IANA TZ time zone database code, such as "America/Toronto". |
offset |
The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC). |
Inputs
Types of data that users can input on cards or dialogs. The input type depends on the type of values that the widget accepts.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| Fields | |
|---|---|
| The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
stringInputs |
A list of strings that represent the values that the user inputs in a widget. If the widget only accepts one value, such as a |
dateTimeInput |
Date and time input values from a |
dateInput |
Date input values from a |
timeInput |
Time input values from a |
| End of mutually exclusive fields. | |
StringInputs
Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented.
| JSON representation |
|---|
{ "value": [ string ] } |
| Fields | |
|---|---|
value[] |
An list of strings entered by the user. |
DateTimeInput
Date and time input values.
| JSON representation |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Fields | |
|---|---|
msSinceEpoch |
Time since epoch time, in milliseconds. |
hasDate |
Whether the |
hasTime |
Whether the |
DateInput
Date input values.
| JSON representation |
|---|
{ "msSinceEpoch": string } |
| Fields | |
|---|---|
msSinceEpoch |
Time since epoch time, in milliseconds. |
TimeInput
Time input values.
| JSON representation |
|---|
{ "hours": integer, "minutes": integer } |
| Fields | |
|---|---|
hours |
The hour on a 24-hour clock. |
minutes |
The number of minutes past the hour. Valid values are 0 to 59. |
AuthorizationEventObject
Encapsulates authorization information for the add-on request
| JSON representation |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| Fields | |
|---|---|
userOAuthToken |
The end user OAuth access token, authorized with the requested scopes. (After oAuth consent unbundling, this will be authorized with end-user authorized scopes) |
userIdToken |
An end-user ID token, if appropriate ID scopes are requested |
systemIdToken |
An ID token for the G Suite Add-ons service account for this deployment |
authorizedScopes[] |
List of OAuth scopes authorized by the user. |
CalendarEventObject
The Calendar event object is the portion of the overall event object that carries information about a user's calendar and calendar events. It's only present in an event object if the host application is Google Calendar.
The following table lists the fields present in the calendar field of an event object. Fields marked as User-generated data are present in the event object if and only if the data is present in the Calendar event and the add-on sets its addOns.calendar.currentEventAccess manifest field to READ or READ_WRITE.
| JSON representation |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| Fields | |
|---|---|
id |
The event ID. |
recurringEventId |
The ID of a recurring event. |
calendarId |
The calendar ID. |
organizer |
An object representing the organizer of the event. |
attendees[] |
User-generated data. A list of the attendees of the calendar event. |
conferenceData |
User-generated data. An object representing any conference data associated with this event, such as Google Meet conference details. |
capabilities |
User-generated data. An object describing the capabilities of the add-on to view or update event information. |
Organizer
| JSON representation |
|---|
{ "email": string } |
| Fields | |
|---|---|
email |
The event organizer's email address. |
Attendee
Attendee objects carry information about individual attendees to Google Calendar events. This information is present in the event object if and only if the data is present in the Calendar event and the add-on sets its addOns.calendar.currentEventAccess manifest field to READ or READ_WRITE.
| JSON representation |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| Fields | |
|---|---|
email |
The attendee email address. |
displayName |
The attendee displayed name. |
organizer |
true if the attendee is an organizer for this event. |
self |
true if this attendee represents the calendar in which this event appears; false otherwise. |
resource |
true if the attendee represents a resource, such as room or piece of equipment; false otherwise. |
optional |
true if the attendance for this attendee is marked as optional; false otherwise. |
responseStatus |
The attendee's response status. Possible values include the following:
|
comment |
The attendee's response comment, if any. |
additionalGuests |
The number of additional guests the attendee had indicated they are bringing. Defaults to zero. |
ConferenceData
Conference data objects carry information about conferences that are attached to Google Calendar events. These can be Google conference solutions, such as Google Meet, or third-party conferences. This information is present in the event object if and only if the data is present in the Calendar event and the add-on sets its addOns.calendar.currentEventAccess manifest field to READ or READ_WRITE.
| JSON representation |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| Fields | |
|---|---|
conferenceId |
The ID of the conference. This ID is meant to allow applications to keep track of conferences; you shouldn't display this ID to users. |
conferenceSolution |
An object representing the conference solution, such as Hangouts or Google Meet. |
entryPoints[] |
The list of conference entry points, such as URLs or phone numbers. |
notes |
Additional notes (such as instructions from the domain administrator or legal notices) about the conference to display to the user. Can contain HTML. The maximum length is 2048 characters. |
parameters |
An object containing a map of defined parameter data for use by the add-on. |
ConferenceSolution
| JSON representation |
|---|
{
"iconUri": string,
"key": {
object ( |
| Fields | |
|---|---|
iconUri |
The URI for the user-visible icon representing this conference solution. |
key |
The key which uniquely identifies the conference solution for this event. |
name |
The user-visible name of this conference solution (not localized). |
Key
| JSON representation |
|---|
{ "type": string } |
| Fields | |
|---|---|
type |
The conference solution type. Possible values include the following:
|
EntryPoint
Entry point objects carry information about the established means of accessing a given conference, such as by phone or video. This information is present in the event object if and only if the data is present in the Calendar event and the add-on sets its addOns.calendar.currentEventAccess manifest field to READ or READ_WRITE.
| JSON representation |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| Fields | |
|---|---|
accessCode |
The access code used to access the conference. The maximum length is 128 characters. Conference providers typically only use a subset of {accessCode, meetingCode, passcode, password, pin} to provide access to conferences. Match and only ever display the fields the conference provider uses. |
entryPointType |
The type of entry point. Possible values are the following:
|
label |
The user-visible label for the entry point URI (not localized). |
meetingCode |
The meeting code used to access the conference. The maximum length is 128 characters. Conference providers typically only use a subset of {accessCode, meetingCode, passcode, password, pin} to provide access to conferences. Match and only ever display the fields the conference provider uses. |
passcode |
The passcode used to access the conference. The maximum length is 128 characters. Conference providers typically only use a subset of {accessCode, meetingCode, passcode, password, pin} to provide access to conferences. Match and only ever display the fields the conference provider uses. |
password |
The password used to access the conference. The maximum length is 128 characters. Conference providers typically only use a subset of {accessCode, meetingCode, passcode, password, pin} to provide access to conferences. Match and only ever display the fields the conference provider uses. |
pin |
The PIN used to access the conference. The maximum length is 128 characters. Conference providers typically only use a subset of {accessCode, meetingCode, passcode, password, pin} to provide access to conferences. Match and only ever display the fields the conference provider uses. |
uri |
The URI of the entry point. The maximum length is 1300 characters. The formatting depends on the entry point type:
|
regionCode |
Region code of the phone number. Needed by users if the URI doesn't include a country code. Values are based on the public CLDR list of region codes. |
entryPointFeatures[] |
Features of the entry point. Currently these features only apply to phone entry points:
|
Parameters
| JSON representation |
|---|
{
"addOnParameters": {
object ( |
| Fields | |
|---|---|
addOnParameters |
A map of parameter string keys and values. These keys and values are defined by the add-on developer to attach information to a specific conference for the add-on's use. |
AddOnParameters
| JSON representation |
|---|
{ "parameters": { string: string, ... } } |
| Fields | |
|---|---|
parameters |
An object containing a list of |
Capabilities
| JSON representation |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Fields | |
|---|---|
canSeeAttendees |
User-generated data. true if the add-on can read the event attendee list; false otherwise. |
canAddAttendees |
User-generated data. true if the add-on can add new attendees to the event attendee list; false otherwise. |
canSeeConferenceData |
User-generated data. true if the add-on can read the event conference data; false otherwise. |
canSetConferenceData |
User-generated data. true if the add-on can update the event conference data; false otherwise. |
canAddAttachments |
User-generated data. true if the add-on can add new attachments to the event; false otherwise. |
DriveEventObject
The Drive event object is the portion of the overall event object that carries information about a user's Google Drive and its contents. It's only present in an event object if the host application is Google Drive.
| JSON representation |
|---|
{ "selectedItems": [ { object ( |
| Fields | |
|---|---|
selectedItems[] |
A list of items (files or folders) selected in Drive. |
activeCursorItem |
The Drive item that is currently active. |
DriveItemMetadata
Drive item objects carry information about specific Drive items, such as files or folders.
| JSON representation |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| Fields | |
|---|---|
id |
The ID of the selected item. |
iconUrl |
The URL of the icon that represents the selected item. |
mimeType |
The MIME type of the selected item. |
title |
The title of the selected item. |
addonHasFileScopePermission |
If true, the add-on has requested and received https://www.googleapis.com/auth/drive.file scope authorization for this item. Otherwise, this field is false. If the add-on uses a more permissive scope such as https://www.googleapis.com/auth/drive or https://www.googleapis.com/auth/drive.readonly, this field isn't relevant. Always use the least permissive scopes possible when designing add-ons to protect user information. |
GmailEventObject
The Gmail event object is the portion of the overall event object that carries information about a user's Gmail messages. It's only present in an event object if the host application is Gmail.
| JSON representation |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| Fields | |
|---|---|
messageId |
The ID of the currently open Gmail message. |
threadId |
The currently open Gmail thread ID. |
accessToken |
The Gmail-specific access token. You can use this token with the |
toRecipients[] |
Disabled by default. The list of "To:" recipient email addresses currently included in a draft the add-on is composing. To turn on this field, you must set the |
ccRecipients[] |
Disabled by default. The list of "CC:" recipient email addresses currently included in a draft the add-on is composing. To turn on this field, you must set the |
bccRecipients[] |
Disabled by default. The list of "BCC:" recipient email addresses currently included in a draft the add-on is composing. To turn on this field, you must set the |
SheetsEventObject
The Sheets event object is the portion of the overall event object that carries information about a user's document and its contents. It's only present in an event object if the add-on extends Google Sheets.
| JSON representation |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Fields | |
|---|---|
id |
Only present if the |
title |
Only present if the |
addonHasFileScopePermission |
If |
matchedUrl |
Only present if the following conditions are met:
The URL of the link that generates a preview in Google Sheets. To use this field, you must configure the Example payload for when a user previews the link |
MatchedUrl
Event object returned with link preview requests.
| JSON representation |
|---|
{ "url": string } |
| Fields | |
|---|---|
url |
The URL that was matched. |
SlidesEventObject
The Slides event object is the portion of the overall event object that carries information about a user's document and its contents. It's only present in an event object if the add-on extends Google Slides.
| JSON representation |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Fields | |
|---|---|
id |
Only present if the |
title |
Only present if the |
addonHasFileScopePermission |
If |
matchedUrl |
Only present if the following conditions are met:
The URL of the link that generates a preview in Google Slides. To use this field, you must configure the Example payload for when a user previews the link |
DocsEventObject
The Docs event object is the portion of the overall event object that carries information about a user's document and its contents. It's only present in an event object if the add-on extends Google Docs.
| JSON representation |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Fields | |
|---|---|
id |
Only present if the |
title |
Only present if the |
addonHasFileScopePermission |
If |
matchedUrl |
Only present if the following conditions are met:
The URL of the link that generates a preview in Google Docs. To use this field, you must configure the Example payload for when a user previews the link |
ChatEventObject
A Google Chat app event object payload sent from Google server to add-ons. Payloads can be used to identify the type of event.
| JSON representation |
|---|
{ "type": enum ( |
| Fields | |
|---|---|
type |
The type of the event, only populated for App Home events in Chat apps that are not add-ons. |
user |
The user who interacts with the Chat app. |
space |
The space in which the event occurred, only populated for App Home events in Chat apps that are not add-ons. |
eventTime |
The timestamp indicating when the event object occurs. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
| The payload of the event object. Payloads are dependent on the event object type. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
messagePayload |
A user sends the Chat app a message, or @mentions the Chat app in a space. App command invocations (such as slash commands and quick commands) are delivered in |
addedToSpacePayload |
A user adds the Chat app to a Chat space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. |
removedFromSpacePayload |
A user removes the Chat app from a space. |
buttonClickedPayload |
Represents payload data when a user interacts with an interactive element of a card or dialog that triggers an If a user interacts with a dialog, the ButtonClickedPayload's The complete payload also includes |
widgetUpdatedPayload |
A user updates a widget in an in-stream card or in a dialog. The complete payload also includes |
appCommandPayload |
A user invokes an app command. |
systemCommandPayload |
A user invokes a system command. |
| End of mutually exclusive fields. | |
EventType
The type of the event, only populated for App Home events in Chat apps that are not add-ons.
| Enums | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Default value for the enum. DO NOT USE. |
APP_HOME |
A user opens a direct message from a Chat app that uses app home. Only the type, user, and space fields are included for events of this type. For more information, see Build a homepage for a Google Chat app. |
SUBMIT_FORM |
A user submits information in an app home card. Only the type, user, and space fields are included for events of this type. For more information, see [Build a homepage for a Google Chat app]((https://developers.google.com/workspace/chat/send-app-home-card-message). |
MessagePayload
A user sends the Chat app a message, or @mentions the Chat app in a space. App command invocations (such as slash commands and quick commands) use AppCommandPayload instead.
| JSON representation |
|---|
{ "space": { object ( |
| Fields | |
|---|---|
space |
Required. The Chat space in which the event object occurs. |
message |
The message that triggers the event object. |
configCompleteRedirectUri |
Optional. The URL the Chat app should redirect the user to after they complete an authorization or configuration flow outside of Google Chat. For more information, see Connect a Chat app with other services & tools. |
AddedToSpacePayload
A user adds the Chat app to a space, or a DM between the app and a user is created.
| JSON representation |
|---|
{
"space": {
object ( |
| Fields | |
|---|---|
space |
Required. The Chat space in which the event object occurs. |
interactionAdd |
Whether the app was added to the space with a user interaction (e.g., by @ mentioning the Chat app or invoking with a slash command). If this is set to true then there will be a separate event object associated with the interaction itself dispatched to the Chat app. |
configCompleteRedirectUri |
Optional. The URL the Chat app should redirect the user to after they complete an authorization or configuration flow outside of Google Chat. For more information, see Connect a Chat app with other services & tools. |
RemovedFromSpacePayload
A user removes the Chat app from a space.
| JSON representation |
|---|
{
"space": {
object ( |
| Fields | |
|---|---|
space |
Required. The Chat space in which the event object occurs. |
ButtonClickedPayload
A user interacts with an interactive element of a card or dialog from a Chat Add-on that triggers an Action callback. Despite the name, this payload is populated for all card and dialog Action callbacks, including button clicks, onChangeAction triggers, onClick actions, CardAction clicks, and dialog submission or cancellation (SUBMIT_DIALOG and CANCEL_DIALOG).
If a user interacts with a dialog, the ButtonClickedPayload's isDialogEvent field is set to true and includes a DialogEventType. This payload maps to SUBMIT_FORM and CARD_CLICKED event types for Chat apps that are not add-ons.
The complete payload also includes CommonEventObject.form_inputs and CommonEventObject.parameters.
| JSON representation |
|---|
{ "space": { object ( |
| Fields | |
|---|---|
space |
Required. The Chat space in which the event object occurs. |
message |
The message that triggers the event object. |
isDialogEvent |
For |
dialogEventType |
The type of dialog event object received. |
DialogEventType
For event objects that contain ButtonClicked or AppCommand event payloads, the types of interactions with dialogs.
To learn more about Google Chat app event objects, see Receive and respond to interactions with your Google Chat app.
| Enums | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
Default value. Unspecified. |
REQUEST_DIALOG |
A user opens a dialog. |
SUBMIT_DIALOG |
A user clicks an interactive element of a dialog. For example, a user fills out information in a dialog and clicks a button to submit the information. |
CANCEL_DIALOG |
A user closes a dialog without submitting information, or the dialog is canceled. |
WidgetUpdatedPayload
A user updates a widget in an in-stream card or dialog.
The complete payload also includes CommonEventObject.parameters['autocomplete_widget_query'].
| JSON representation |
|---|
{
"space": {
object ( |
| Fields | |
|---|---|
space |
Required. The Chat space in which the event object occurs. |
AppCommandPayload
A user invokes an app command.
| JSON representation |
|---|
{ "appCommandMetadata": { object ( |
| Fields | |
|---|---|
appCommandMetadata |
Populated for app commands, including slash commands and quick commands. |
space |
Optional. The Chat space in which the event object occurs. |
thread |
Optional. The thread in which the event object occurs, if applicable. This field is populated if the event object is associated with a specific message or thread. |
message |
Optional. The message that triggers the event object, if applicable. This field is only populated for slash commands. |
configCompleteRedirectUri |
Optional. The URL the user should be redirected to after they complete an authorization or configuration flow outside of Google Chat. For more information, see Connect a Chat app with other services & tools. |
isDialogEvent |
Optional. Whether the user is interacting with or about to interact with a dialog. |
dialogEventType |
Optional. The type of dialog event object received. This field only applies if |
AppCommandMetadata
Metadata about a Chat app command.
| JSON representation |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Fields | |
|---|---|
appCommandId |
The ID for the command specified in the Chat API configuration. |
appCommandType |
The type of Chat app command. |
AppCommandType
The type of Chat app command. For details, see Types of Chat app commands.
| Enums | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Default value. Unspecified. |
SLASH_COMMAND |
A slash command. The user sends the command in a Chat message. |
QUICK_COMMAND |
A quick command. The user selects the command from the Chat menu in the message reply area. |
MESSAGE_ACTION |
A message action. The user selects the command from the message context menu in Chat. |
SystemCommandPayload
A user invokes a system command.
| JSON representation |
|---|
{ "systemCommandMetadata": { object ( |
| Fields | |
|---|---|
systemCommandMetadata |
Metadata about the system command that was invoked. |
space |
Optional. The Chat space in which the event object occurs. |
thread |
Optional. The thread in which the event object occurs, if applicable. This field is populated if the event object is associated with a specific message or thread. |
SystemCommandMetadata
Metadata about a system command that is triggered by the user.
| JSON representation |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| Fields | |
|---|---|
| The system command invoked. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
cancelStream |
Command for cancelling an active stream message. |
| End of mutually exclusive fields. | |
CancelStream
Command for cancelling an active stream message.
| JSON representation |
|---|
{ "streamMessage": string } |
| Fields | |
|---|---|
streamMessage |
Required. The resource name of the stream message on which the cancel command was performed. Format: |
WorkflowEventObject
LINT.IfChange The event object passed to Workflow add-ons.
| JSON representation |
|---|
{ "executionMetadata": { object ( |
| Fields | |
|---|---|
executionMetadata |
Metadata about the workflow execution. |
triggerEventSource |
Source of the triggering events. |
| The type of workflow event payload. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
actionInvocation |
Invocation of a workflow action. |
triggerCreation |
Creation of a workflow trigger. |
triggerDeletion |
Deletion of a workflow trigger. |
resourceRetrieval |
Retrieval of a resource (used for variable inflation). |
elementConfiguration |
Configuration of a workflow element. |
resourceFieldsDefinitionRetrieval |
The retrieval of field definitions supported by a resource. |
elementUiAutocomplete |
Autocomplete suggestions for the currently rendered card. |
| End of mutually exclusive fields. | |
ActionInvocation
Invocation of a workflow action.
| JSON representation |
|---|
{ "inputs": { string: { object ( |
| Fields | |
|---|---|
inputs |
Map of the input variables keyed by input variable name. An object containing a list of |
triggerId |
Trigger ID to use for async action responses. |
flowLevelContext |
Optional. Flow-level context from preceding steps. |
VariableData
Represents variable data, which can hold multiple values of different types.
| JSON representation |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| Fields | |
|---|---|
booleanValues[] |
Boolean values. |
integerValues[] |
Integer values. |
floatValues[] |
Float values. |
stringValues[] |
String values. |
timestampValues[] |
Timestamp values. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
resourceReferences[] |
Resource references (IDs). |
emailAddressValues[] |
Email address values. |
googleUserValues[] |
Google user values in the format |
textFormatValues[] |
Workflow Text Format values. |
ResourceReference
Id value of application specific resource.
| JSON representation |
|---|
{
"resourceType": {
object ( |
| Fields | |
|---|---|
resourceType |
The type of the resource this ID points to. |
resourceId |
ID of the resource. |
ResourceType
Name of custom resource type.
| JSON representation |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Fields | |
|---|---|
workflowBundleId |
ID of the workflow bundle that owns this resource type. This is optional and if empty it's considered to be the same bundle where it's being used. |
workflowResourceDefinitionId |
Unique identifier of the resource. This is only required to be unique within the same bundle. |
WorkflowTextFormat
A block of text with rich formatting options including styles, hyperlinks, and interactive elements.
| JSON representation |
|---|
{
"textFormatElements": [
{
object ( |
| Fields | |
|---|---|
textFormatElements[] |
A collection of text format elements. |
TextFormatElement
A single element within a WorkflowTextFormat message, which can be a chip, styled text, a hyperlink, or a list container.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "chip": { object ( |
| Fields | |
|---|---|
| Element that represents one of several possible text format elements. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
text |
Text in the text format. |
chip |
Clickable chip in the text format. |
styledText |
Styled text in the text format. |
hyperlink |
Hyperlink in the text format. |
listContainer |
List container in the text format. |
| End of mutually exclusive fields. | |
Chip
A clickable chip in the text format.
| JSON representation |
|---|
{
"icon": {
object ( |
| Fields | |
|---|---|
icon |
The icon displayed in the chip. |
label |
The text displayed in the chip. |
url |
The URL to navigate to when the chip is clicked. |
Icon
An icon in the chip.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "iconUrl": string, "materialIconName": string // End of mutually exclusive fields. } |
| Fields | |
|---|---|
| The icon displayed in the chip. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
iconUrl |
Display a custom icon hosted at an HTTPS URL. For example: Supported file types include |
materialIconName |
The icon name defined in the Google Material Icon, for example, |
| End of mutually exclusive fields. | |
StyledText
Text element with styles such as bold, italic and color.
| JSON representation |
|---|
{ "text": string, "styles": [ enum ( |
| Fields | |
|---|---|
text |
The main content of the text. |
styles[] |
A collection of styles applied to the text. |
fontWeight |
The font weight of the text. |
color |
The color of the text. |
wrapStyle |
The wrap style of the text. |
Style
Enum for different text styles such as italic, underline, etc.
| Enums | |
|---|---|
STYLE_UNSPECIFIED |
No style applied. DO NOT USE. |
ITALIC |
Italic style. |
UNDERLINE |
Underline style. |
STRIKETHROUGH |
Strikethrough style. |
LINE_BREAK |
Line break. |
UPPERCASE |
Uppercase style. |
CODE |
Code. |
CODE_BLOCK |
Code block. |
FontWeight
Enum for different font weights.
| Enums | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
Standard weight with normal thickness. DO NOT USE. |
LIGHT |
Lighter weight with reduced thickness. |
MEDIUM |
Intermediate weight between light and bold. |
BOLD |
Heavier weight with increased thickness. |
WrapStyle
Enum for different wrap styles.
| Enums | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
No wrap style specified. |
NO_WRAP |
No wrap style. |
Hyperlink
Hyperlink element with text and link.
| JSON representation |
|---|
{ "link": string, "text": string } |
| Fields | |
|---|---|
link |
The destination URL of the hyperlink. |
text |
The text of the hyperlink. |
ListContainer
Container for list items, where each list item can contain multiple TextFormatElement's.
| JSON representation |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Fields | |
|---|---|
listNestLevel |
The nest level of the list. Starts from 0 for the top level, and increases by 1 for each nested list. |
listType |
The type of the list. |
listItems[] |
A collection of list items. |
ListType
Enum for different list types.
| Enums | |
|---|---|
LIST_TYPE_UNSPECIFIED |
No list type specified. DO NOT USE. |
ORDERED |
Ordered list. |
UNORDERED |
Unordered list. |
BLOCKQUOTE |
Represents a blockquote list. |
ListItem
A list item.
| JSON representation |
|---|
{
"textFormatElements": [
{
object ( |
| Fields | |
|---|---|
textFormatElements[] |
A collection of text format elements. |
FlowLevelContext
Flow-level context containing outputs from preceding steps.
| JSON representation |
|---|
{
"stepContexts": [
{
object ( |
| Fields | |
|---|---|
stepContexts[] |
Optional. List of preceding steps. The order matters, so make sure the execution order is maintained in this list. |
StepContext
Step context metadata and outputs for flow-level context.
| JSON representation |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| Fields | |
|---|---|
stepId |
Optional. Unique ID of the step in the workflow graph. |
outputs |
Optional. Map of output variables produced by this step, keyed by variable name. An object containing a list of |
TriggerCreation
Creation of a workflow trigger.
| JSON representation |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Fields | |
|---|---|
triggerId |
Unique identifier of the trigger provided during creation. |
triggerType |
Type of the trigger. |
inputs |
Map of the input variables keyed by input variable name. An object containing a list of |
notifyUri |
The endpoint that will be called when the trigger fires. |
TriggerType
Type of the trigger.
| Enums | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
Default value. DO NOT USE. |
REPEATING |
The trigger will fire every time the input conditions are met. |
TriggerDeletion
Deletion of a workflow trigger.
| JSON representation |
|---|
{ "triggerId": string } |
| Fields | |
|---|---|
triggerId |
Unique identifier of the trigger provided during creation. |
ResourceRetrieval
Retrieval of a resource.
| JSON representation |
|---|
{
"resourceReference": {
object ( |
| Fields | |
|---|---|
resourceReference |
Type and ID of the resource to be retrieved. |
ElementConfiguration
Invocation when configuring a workflow element.
| JSON representation |
|---|
{ "inputs": { string: { object ( |
| Fields | |
|---|---|
inputs |
Map of the input variables keyed by input variable name. This map could be empty. Used when configuring single workflow element (trigger or action) in workflow home. An object containing a list of |
displayDestination |
The destination of the element configuration card. Elements can use this field to return different configuration card layouts based on the destination. |
nodeId |
The node id of the primitive config being rendered. |
workflowId |
The workflow id of the primitive config being rendered. |
availableVariables[] |
Available variables ordered by node position. |
DisplayDestination
Indicates where the returning element configuration card will be displayed.
| Enums | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
Default value. DO NOT USE. |
DISPLAY_DESTINATION_SIDE_PANEL |
Configuration card is to be displayed in the Side Panel. |
DISPLAY_DESTINATION_FULL_SCREEN |
Configuration card is to be displayed in the Full Screen app. |
VariableReference
A variable reference to a variable in the workflow.
| JSON representation |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| Fields | |
|---|---|
parentElementId |
The primitive id of the element that produces the variable We can expand this to WorkflowElement or a more detailed metadata proto if needed. |
nodeId |
Node reference id |
path |
The variable selector path signature |
dataType |
The variable data type |
iconUrl |
The icon url of the primitive that produces this variable. |
stepNumber |
The step number of the primitive that produces this variable. |
descriptionText |
The description of the variable. |
displayText |
The display text of the variable chip. |
DataType
Type of the variable.
| JSON representation |
|---|
{ "valueMetadata": { object ( |
| Fields | |
|---|---|
valueMetadata |
Metadata about the potential values of a variable. |
| The type of data. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
basicType |
Basic data type. |
resourceType |
Application resource id type. |
| End of mutually exclusive fields. | |
BasicType
Basic generic data types.
| Enums | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
Default value. DO NOT USE. |
STRING |
A string of characters. |
INTEGER |
An integer number. |
FLOAT |
A floating point number. |
TIMESTAMP |
Timestamp in ISO 8601 format. |
BOOLEAN |
A value that can be true or false. |
EMAIL_ADDRESS |
An email address, which is a string in the format of an email address. |
GOOGLE_USER |
User of Google services, in the format users/{user}. |
FILE |
File reference. |
FORMATTED_TEXT |
Text with rich formatting. |
ValueMetadata
Information about the potential values of a variable.
| JSON representation |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| Fields | |
|---|---|
enumValues[] |
Optional. Specifies the allowed values for a string. This may only be set if |
dynamicTypes[] |
Optional. Specifies the allowed types that can be dynamically casted for a variable. This may only be set if the DataType is a String and the variable is an output. |
semanticDescriptors[] |
Optional. Helps describe the semantic meaning of a variable. |
dynamicSchema |
Optional. Configuration for dynamically resolving this variable's schema. |
defaultValue |
Optional. String specifying the default value for this variable. For example, for booleans, |
SemanticDescriptor
Metadata about the semantic meaning of a variable.
| JSON representation |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Fields | |
|---|---|
resourceAttribute |
Indicates that the variable corresponds to a specific attribute of a resource. This is particularly useful for variables that represent an identifier for a resource (id, url, key, etc.). The recommended format is: - Examples: - The client will use this information to hint the user what output variables are compatible with a certain input. |
disallowedResourceAttributes[] |
Optional. Only applicable for inputs, and ignored for outputs. Disallowed attributes that correspond to this semantic descriptor. The client will explicitly prevent variable selection for outputs that correspond to any of these disallowed resource attributes. |
DynamicSchema
Configuration for dynamically resolving this variable's schema at runtime.
| JSON representation |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| Fields | |
|---|---|
requiredInputIds[] |
IDs of sibling input variables that must be provided before this variable's schema can be dynamically resolved. |
strictEnum |
When true, the variable's value must match one of the dynamically resolved enum values. When false, dynamically resolved values are treated as non-strict suggestions. |
ResourceFieldsDefinitionRetrieval
Retrieves definition of fields supported by a resource.
| JSON representation |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| Fields | |
|---|---|
elementId |
Specifies the ID of the element whose dynamic resource schema to fetch. |
inputs |
This comprises of field inputs of the node that provides the variable. Map of the input variables keyed by input variable name. An object containing a list of |
ElementUiAutocomplete
Autocomplete suggestions for the currently rendered card.
| JSON representation |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Fields | |
|---|---|
query |
The query to autocomplete. |
inputs |
Map of the input variables keyed by input variable name. An object containing a list of |
invokedFunction |
The invoked function associated with the widget. |
resourceId |
The resource ID that should be autocompleted for. This is an optional field and may not be set. |
operationId |
The ID of the operation that provided the resource to be autocompleted. This is an optional field and may not be set. |
ExecutionMetadata
Metadata about the workflow execution.
| JSON representation |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| Fields | |
|---|---|
versionId |
The version of the workflow element being invoked. |
timeZone |
The time zone of the workflow being saved. e.g. "America/Los_Angeles". |
stepNumber |
Represents the step number of the primitive being invoked. |
TriggerEventSource
Source of the trigger event that triggered this execution.
| Enums | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
Default value. DO NOT USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
Execution is triggered automatically by events. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
Execution is triggered via test run. |