{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/google-chat-integrations-for-workspace/json-schema/google-chat-integrations-for-workspace-message-schema.json", "title": "Message", "description": "A message in a Google Chat space.", "x-generated": "2026-11-11", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/google-chat-integrations-for-workspace-spaces-api-openapi.yml#/components/schemas/Message", "type": "object", "properties": { "accessoryWidgets": { "description": "Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).", "type": "array", "items": { "$ref": "#/$defs/AccessoryWidget" } }, "thread": { "$ref": "#/$defs/Thread", "description": "The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread)." }, "elements": { "$ref": "#/$defs/Elements", "description": "Optional. Additional message components, including inline `citations` (where each citation is associated with a specific portion of the message text) and `cited_sources` (which are general references used to generate the response and are not directly linked to specific segments of the text). On input, provide `elements` when creating or updating a message. On output, both `citations` and `cited_sources` are populated when reading a message that contains them. Callers can read structured citation metadata from `elements`, while `formatted_text` also includes inline citation tags or source links depending on `markup_syntax`. These differ from `annotations`, which are output-only and offer supplementary information tied to message fragments or the entire message text." }, "slashCommand": { "$ref": "#/$defs/SlashCommand", "description": "Output only. Slash command information, if applicable." }, "emojiReactionSummaries": { "items": { "$ref": "#/$defs/EmojiReactionSummary" }, "readOnly": true, "type": "array", "description": "Output only. The list of emoji reaction summaries on the message." }, "quotedMessageMetadata": { "$ref": "#/$defs/QuotedMessageMetadata", "description": "Optional. Information about a message that another message quotes. When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message)." }, "argumentText": { "readOnly": true, "description": "Output only. Plain-text body of the message with all Chat app mentions stripped out.", "type": "string" }, "actionResponse": { "$ref": "#/$defs/ActionResponse", "description": "Input only. Parameters that a Chat app can use to configure how its response is posted." }, "cards": { "description": "Deprecated: Use `cards_v2` instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. `cards` and `cards_v2` can have a maximum size of 32 KB.", "items": { "$ref": "#/$defs/Card" }, "type": "array", "deprecated": true }, "attachment": { "items": { "$ref": "#/$defs/Attachment" }, "description": "Optional. User-uploaded attachment.", "type": "array" }, "attachedGifs": { "description": "Output only. GIF images that are attached to the message.", "readOnly": true, "items": { "$ref": "#/$defs/AttachedGif" }, "type": "array" }, "space": { "$ref": "#/$defs/Space", "description": "Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`." }, "cardsV2": { "description": "Optional. An array of [cards](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards). Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)", "items": { "$ref": "#/$defs/CardWithId" }, "type": "array" }, "name": { "description": "Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).", "type": "string" }, "formattedText": { "type": "string", "description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/workspace/chat/format-messages) for bold, italic, strikethrough, monospace, monospace block, bulleted list, and block quote. * [User mentions](https://developers.google.com/workspace/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)—for example, `* item`. For more information, see [View text formatting sent in a message](https://developers.google.com/workspace/chat/format-messages#view_text_formatting_sent_in_a_message)", "readOnly": true }, "lastUpdateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.", "type": "string" }, "createTime": { "type": "string", "description": "Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.", "format": "google-datetime" }, "fallbackText": { "type": "string", "description": "Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications." }, "matchedUrl": { "$ref": "#/$defs/MatchedUrl", "description": "Output only. A URL in the Chat message `text` field that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/workspace/chat/preview-links)." }, "privateMessageViewer": { "$ref": "#/$defs/User", "description": "Optional. Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and omit the following: * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private)." }, "text": { "type": "string", "description": "Optional. Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a message](https://developers.google.com/workspace/chat/create-messages)." }, "deletionMetadata": { "$ref": "#/$defs/DeletionMetadata", "description": "Output only. Information about a deleted message. A message is deleted when `delete_time` is set." }, "silent": { "readOnly": true, "description": "Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients.", "type": "boolean" }, "threadReply": { "type": "boolean", "readOnly": true, "description": "Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`." }, "deleteTime": { "description": "Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.", "readOnly": true, "type": "string", "format": "google-datetime" }, "markupSyntax": { "type": "string", "description": "Optional. Specifies how the server interprets the message `text` field content when creating a message or updating the `text` field of a message. When calling `UpdateMessage`, set `markup_syntax` and `text` on the `Message` resource and include `text` (not `markup_syntax`) in `update_mask`.", "enum": [ "MARKUP_SYNTAX_UNSPECIFIED", "MARKUP_SYNTAX_CHAT", "MARKUP_SYNTAX_MARKDOWN" ] }, "clientAssignedMessageId": { "type": "string", "description": "Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the [`messageId`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message)." }, "sender": { "$ref": "#/$defs/User", "description": "Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type` fields for both internal and external users, unless they are members of the space or have a prior affinity, like a direct message (DM) conversation, with the calling user." }, "annotations": { "readOnly": true, "items": { "$ref": "#/$defs/Annotation" }, "type": "array", "description": "Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0." } }, "$defs": { "AccessPermissionSetting": { "properties": { "principals": { "type": "array", "items": { "$ref": "#/$defs/Principal" }, "description": "Optional. Unordered list. Allowed principals for this permission." } }, "description": "An access permission setting.", "type": "object" }, "AccessPermissionSettings": { "properties": { "viewSpaceMembershipSetting": { "$ref": "#/$defs/AccessPermissionSetting", "description": "Optional. Access permission setting for viewing space membership. Must be specified together with `PermissionSettings.view_space_membership` in the update mask and request body when updating who can view space membership. When granting view access to a target audience, you must also grant `PermissionSettings.view_space_membership` to all members in the same request. To remove an existing target audience (for example, to restrict view access to space managers or assistant managers only), specify an empty `AccessPermissionSetting` (with no `principals`)." }, "discoverSpaceSetting": { "$ref": "#/$defs/AccessPermissionSetting", "description": "Optional. Access permission setting for discovering the space." }, "joinSpaceSetting": { "$ref": "#/$defs/AccessPermissionSetting", "description": "Optional. Access permission setting for joining the space." } }, "description": "Access permission settings for a space.", "type": "object" }, "AccessSettings": { "type": "object", "description": "Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space.", "properties": { "accessPermissionSettings": { "$ref": "#/$defs/AccessPermissionSettings", "description": "Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request." }, "audience": { "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "type": "string" }, "accessState": { "enum": [ "ACCESS_STATE_UNSPECIFIED", "PRIVATE", "DISCOVERABLE" ], "readOnly": true, "type": "string", "description": "Output only. Indicates the access state of the space." } } }, "AccessoryWidget": { "description": "One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).", "type": "object", "properties": { "buttonList": { "$ref": "#/$defs/GoogleAppsCardV1ButtonList", "description": "A list of buttons." } } }, "ActionParameter": { "type": "object", "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.", "properties": { "key": { "description": "The name of the parameter for the action script.", "type": "string" }, "value": { "description": "The value of the parameter.", "type": "string" } } }, "ActionResponse": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "NEW_MESSAGE", "UPDATE_MESSAGE", "UPDATE_USER_MESSAGE_CARDS", "REQUEST_CONFIG", "DIALOG", "UPDATE_WIDGET" ], "description": "Input only. The type of Chat app response." }, "url": { "description": "Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)", "type": "string" }, "dialogAction": { "$ref": "#/$defs/DialogAction", "description": "Input only. A response to an interaction event related to a [dialog](https://developers.google.com/workspace/chat/dialogs). Must be accompanied by `ResponseType.Dialog`." }, "updatedWidget": { "$ref": "#/$defs/UpdatedWidget", "description": "Input only. The response of the updated widget." } }, "description": "Parameters that a Chat app can use to configure how its response is posted." }, "ActionStatus": { "properties": { "statusCode": { "description": "The status code.", "type": "string", "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ] }, "userFacingMessage": { "description": "The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.", "type": "string" } }, "description": "Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs).", "type": "object" }, "Annotation": { "properties": { "userMention": { "$ref": "#/$defs/UserMentionMetadata", "description": "The metadata of user mention." }, "startIndex": { "format": "int32", "description": "Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.", "type": "integer" }, "type": { "description": "The type of this annotation.", "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "USER_MENTION", "SLASH_COMMAND", "RICH_LINK", "CUSTOM_EMOJI" ], "type": "string" }, "customEmojiMetadata": { "$ref": "#/$defs/CustomEmojiMetadata", "description": "The metadata for a custom emoji." }, "slashCommand": { "$ref": "#/$defs/SlashCommandMetadata", "description": "The metadata for a slash command." }, "richLinkMetadata": { "$ref": "#/$defs/RichLinkMetadata", "description": "The metadata for a rich link." }, "length": { "description": "Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.", "type": "integer", "format": "int32" } }, "description": "Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", "type": "object" }, "AttachedGif": { "properties": { "uri": { "type": "string", "description": "Output only. The URL that hosts the GIF image.", "readOnly": true } }, "description": "A GIF image that's specified by a URL.", "type": "object" }, "Attachment": { "type": "object", "description": "An attachment in Google Chat.", "properties": { "downloadUri": { "readOnly": true, "type": "string", "description": "Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content." }, "source": { "description": "Output only. The source of the attachment.", "enum": [ "SOURCE_UNSPECIFIED", "DRIVE_FILE", "UPLOADED_CONTENT" ], "readOnly": true, "type": "string" }, "contentName": { "readOnly": true, "description": "Output only. The original file name for the content, not the full path.", "type": "string" }, "contentType": { "description": "Output only. The content type (MIME type) of the file.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.", "type": "string" }, "thumbnailUri": { "readOnly": true, "description": "Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content.", "type": "string" }, "driveDataRef": { "$ref": "#/$defs/DriveDataRef", "description": "Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API." }, "attachmentDataRef": { "$ref": "#/$defs/AttachmentDataRef", "description": "Optional. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data." } } }, "AttachmentDataRef": { "properties": { "attachmentUploadToken": { "type": "string", "description": "Optional. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments." }, "resourceName": { "type": "string", "description": "Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data." } }, "description": "A reference to the attachment data.", "type": "object" }, "Audience": { "description": "A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience).", "type": "object", "properties": { "name": { "description": "The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", "type": "string" } } }, "Button": { "description": "A button. Can be a text button or an image button.", "type": "object", "properties": { "textButton": { "$ref": "#/$defs/TextButton", "description": "A button with text and `onclick` action." }, "imageButton": { "$ref": "#/$defs/ImageButton", "description": "A button with image and `onclick` action." } } }, "CalendarEventLinkData": { "properties": { "calendarId": { "type": "string", "description": "The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar." }, "eventId": { "type": "string", "description": "The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event." } }, "type": "object", "description": "Data for Calendar event links." }, "Card": { "description": "A card is a UI element that can contain UI widgets such as text and images.", "type": "object", "properties": { "cardActions": { "items": { "$ref": "#/$defs/CardAction" }, "type": "array", "description": "The actions of this card." }, "name": { "description": "Name of the card.", "type": "string" }, "header": { "$ref": "#/$defs/CardHeader", "description": "The header of the card. A header usually contains a title and an image." }, "sections": { "type": "array", "description": "Sections are separated by a line divider.", "items": { "$ref": "#/$defs/Section" } } } }, "CardAction": { "properties": { "onClick": { "$ref": "#/$defs/OnClick", "description": "The onclick action for this action item." }, "actionLabel": { "description": "The label used to be displayed in the action menu item.", "type": "string" } }, "type": "object", "description": "A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser. Not supported by Google Chat apps." }, "CardHeader": { "properties": { "imageUrl": { "description": "The URL of the image in the card header.", "type": "string" }, "title": { "type": "string", "description": "The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines." }, "imageStyle": { "description": "The image's type (for example, square border or circular border).", "enum": [ "IMAGE_STYLE_UNSPECIFIED", "IMAGE", "AVATAR" ], "type": "string" }, "subtitle": { "description": "The subtitle of the card header.", "type": "string" } }, "type": "object" }, "CardWithId": { "type": "object", "description": "A [card](https://developers.google.com/workspace/chat/api/reference/rest/v1/cards) in a Google Chat message. Chat apps can create cards with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). As part of the [Developer Preview Program](https://developers.google.com/workspace/preview), if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see [Send a message](https://developers.google.com/workspace/chat/create-messages). [Card builder](https://addons.gsuite.google.com/uikit/builder)", "properties": { "ownerUser": { "$ref": "#/$defs/User", "description": "Output only. The app that owns the card." }, "cardId": { "description": "Required if the message contains multiple cards. A unique identifier for a card in a message.", "type": "string" }, "card": { "$ref": "#/$defs/GoogleAppsCardV1Card", "description": "A card. Maximum size is 32 KB." } } }, "ChatClientDataSourceMarkup": { "properties": { "spaceDataSource": { "$ref": "#/$defs/SpaceDataSource", "description": "Google Chat spaces that the user is a member of." } }, "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Chat. The data source populates selection items for the multiselect menu. For example, a user can select Google Chat spaces that they're a member of. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "object" }, "ChatSpaceLinkData": { "properties": { "space": { "description": "The space of the linked Chat space resource. Format: `spaces/{space}`", "type": "string" }, "thread": { "type": "string", "description": "The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`" }, "message": { "description": "The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`", "type": "string" } }, "type": "object", "description": "Data for Chat space links." }, "Citation": { "description": "Citations are inline references that can provide users more detailed information about the inline reference. Corresponding inline citations should be present in the message text in a markup format of `{text}`. Citations are only supported when the message's `markup_syntax` is set to `MARKDOWN`. Unreferenced citations in `Elements.citations` (those without a matching `` tag in the message text) are ignored and do not cause the message to be rejected.", "properties": { "id": { "description": "Required. The ID of the citation. This ID is defined by the app creating the citation and must match the `data-id` attribute of the `` tag in the message text. Must contain only ASCII letters and numbers, and less than 63 characters.", "type": "string" }, "citedSources": { "description": "Optional. A list of sources that are relevant to the citation. Sources are displayed in the citation hover card.", "items": { "$ref": "#/$defs/CitedSource" }, "type": "array" } }, "type": "object" }, "CitedSource": { "properties": { "snippet": { "$ref": "#/$defs/Snippet", "description": "Optional. Snippet containing information directly from the source." }, "footer": { "$ref": "#/$defs/Footer", "description": "Optional. Additional information to show alongside the snippet in the form of a footer." }, "uri": { "description": "Required. The URI pointing to the resource referenced by this `CitedSource`.", "type": "string" }, "title": { "type": "string", "description": "Required. The plaintext title of the `CitedSource`. Does not support markdown format." } }, "type": "object", "description": "A reference to a source of information." }, "Color": { "type": "object", "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "properties": { "green": { "format": "float", "type": "number", "description": "The amount of green in the color as a value in the interval [0, 1]." }, "alpha": { "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", "type": "number", "format": "float" }, "red": { "type": "number", "format": "float", "description": "The amount of red in the color as a value in the interval [0, 1]." }, "blue": { "type": "number", "format": "float", "description": "The amount of blue in the color as a value in the interval [0, 1]." } } }, "CustomEmoji": { "description": "Represents a [custom emoji](https://support.google.com/chat/answer/12800149).", "properties": { "name": { "description": "Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`", "type": "string" }, "payload": { "$ref": "#/$defs/CustomEmojiPayload", "description": "Optional. Input only. Payload data. Required when the custom emoji is created." }, "emojiName": { "type": "string", "description": "Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`" }, "temporaryImageUri": { "description": "Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.", "readOnly": true, "type": "string" }, "uid": { "type": "string", "description": "Output only. Unique key for the custom emoji resource.", "readOnly": true } }, "type": "object" }, "CustomEmojiMetadata": { "type": "object", "description": "Annotation metadata for custom emoji.", "properties": { "customEmoji": { "$ref": "#/$defs/CustomEmoji", "description": "The custom emoji." } } }, "CustomEmojiPayload": { "description": "Payload data for the custom emoji.", "properties": { "filename": { "type": "string", "description": "Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`." }, "fileContent": { "format": "byte", "description": "Required. Input only. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.", "type": "string" } }, "type": "object" }, "DeletionMetadata": { "properties": { "deletionType": { "description": "Indicates who deleted the message.", "type": "string", "enum": [ "DELETION_TYPE_UNSPECIFIED", "CREATOR", "SPACE_OWNER", "ADMIN", "APP_MESSAGE_EXPIRY", "CREATOR_VIA_APP", "SPACE_OWNER_VIA_APP", "SPACE_MEMBER" ] } }, "description": "Information about a deleted message. A message is deleted when `delete_time` is set.", "type": "object" }, "Dialog": { "type": "object", "description": "Wrapper around the card body of the dialog.", "properties": { "body": { "$ref": "#/$defs/GoogleAppsCardV1Card", "description": "Input only. Body of the dialog, which is rendered in a modal." } } }, "DialogAction": { "description": "Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code.", "properties": { "actionStatus": { "$ref": "#/$defs/ActionStatus", "description": "Input only. Status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success." }, "dialog": { "$ref": "#/$defs/Dialog", "description": "Input only. [Dialog](https://developers.google.com/workspace/chat/dialogs) for the request." } }, "type": "object" }, "DriveDataRef": { "description": "A reference to the data of a drive attachment.", "properties": { "driveFileId": { "description": "The ID for the drive file. Use with the Drive API.", "type": "string" } }, "type": "object" }, "DriveLinkData": { "properties": { "driveDataRef": { "$ref": "#/$defs/DriveDataRef", "description": "A [DriveDataRef](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#drivedataref) which references a Google Drive file." }, "mimeType": { "description": "The mime type of the linked Google Drive resource.", "type": "string" } }, "type": "object", "description": "Data for Google Drive links." }, "Elements": { "type": "object", "properties": { "citedSources": { "items": { "$ref": "#/$defs/CitedSource" }, "type": "array", "description": "Optional. A list of sources to be displayed under the message as footer links. These are not referenced inline. For inline references, use `citations`." }, "citations": { "items": { "$ref": "#/$defs/Citation" }, "description": "Optional. A list of inline citations referenced within the message text (via `` tags) that render as interactive hover cards.", "type": "array" } }, "description": "Elements are additional message components, including inline `citations` (where each citation is associated with a specific portion of the message text) and `cited_sources` (which are general references used to generate the response and are not directly linked to specific segments of the text). Both `citations` and `cited_sources` can be provided as input when creating or updating a message and are populated on output when reading a message." }, "ElementsImage": { "properties": { "imageUri": { "type": "string", "description": "Required. The URI of the image. Must be a publicly accessible URI so that Chat can fetch and display it." } }, "type": "object", "description": "An object encapsulating different ways of representing an image. Currently supported representations: * An image fetched from a URI. Additional representations might be supported in the future." }, "Emoji": { "properties": { "unicode": { "type": "string", "description": "Optional. A basic emoji represented by a unicode string." }, "customEmoji": { "$ref": "#/$defs/CustomEmoji", "description": "A custom emoji." } }, "type": "object", "description": "An emoji that is used as a reaction to a message." }, "EmojiReactionSummary": { "description": "The number of people who reacted to a message with a specific emoji.", "type": "object", "properties": { "reactionCount": { "description": "Output only. The total number of reactions using the associated emoji.", "type": "integer", "format": "int32", "readOnly": true }, "emoji": { "$ref": "#/$defs/Emoji", "description": "Output only. Emoji associated with the reactions." } } }, "Footer": { "description": "A footer for a source, used for attribution.", "type": "object", "properties": { "text": { "description": "Optional. The plaintext to display in the footer. Does not support markdown format.", "type": "string" } } }, "FormAction": { "description": "A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.", "properties": { "parameters": { "description": "List of action parameters.", "type": "array", "items": { "$ref": "#/$defs/ActionParameter" } }, "actionMethodName": { "description": "The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.", "type": "string" } }, "type": "object" }, "ForwardedMetadata": { "properties": { "spaceDisplayName": { "readOnly": true, "description": "Output only. The display name of the source space or DM at the time of forwarding. For `SPACE`, this is the space name. For `DIRECT_MESSAGE`, this is the other participant's name (e.g., \"User A\"). For `GROUP_CHAT`, this is a generated name based on members' first names, limited to 5 including the creator (e.g., \"User A, User B\").", "type": "string" }, "space": { "type": "string", "description": "Output only. The resource name of the source space. Format: spaces/{space}", "readOnly": true } }, "type": "object", "description": "Metadata about the source space from which a message was forwarded." }, "GoogleAppsCardV1Action": { "type": "object", "description": "An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "loadIndicator": { "type": "string", "description": "Specifies the loading indicator that the action displays while making the call to the action.", "enum": [ "SPINNER", "NONE" ] }, "allWidgetsAreRequired": { "description": "Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "boolean" }, "persistValues": { "description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.", "type": "boolean" }, "parameters": { "description": "List of action parameters.", "items": { "$ref": "#/$defs/GoogleAppsCardV1ActionParameter" }, "type": "array" }, "function": { "type": "string", "description": "A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form-data)." }, "requiredWidgets": { "type": "array", "description": "Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "items": { "type": "string" } }, "interaction": { "type": "string", "enum": [ "INTERACTION_UNSPECIFIED", "OPEN_DIALOG" ], "description": "Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):" } } }, "GoogleAppsCardV1ActionParameter": { "description": "List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters. To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "value": { "description": "The value of the parameter.", "type": "string" }, "key": { "description": "The name of the parameter for the action script.", "type": "string" } }, "type": "object" }, "GoogleAppsCardV1BorderStyle": { "description": "The style options for the border of a card or widget, including the border type and color. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object", "properties": { "cornerRadius": { "type": "integer", "description": "The corner radius for the border.", "format": "int32" }, "strokeColor": { "$ref": "#/$defs/Color", "description": "The colors to use when the type is `BORDER_TYPE_STROKE`. To set the stroke color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` \"color\": { \"red\": 1, \"green\": 0, \"blue\": 0 } ``` The `alpha` field is unavailable for stroke color. If specified, this field is ignored." }, "type": { "enum": [ "BORDER_TYPE_UNSPECIFIED", "NO_BORDER", "STROKE" ], "description": "The border type.", "type": "string" } } }, "GoogleAppsCardV1Button": { "description": "A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object", "properties": { "text": { "description": "The text displayed inside the button.", "type": "string" }, "type": { "type": "string", "description": "Optional. The type of a button. If unset, button type defaults to `OUTLINED`. If the `color` field is set, the button type is forced to `FILLED` and any value set for this field is ignored.", "enum": [ "TYPE_UNSPECIFIED", "OUTLINED", "FILLED", "FILLED_TONAL", "BORDERLESS" ] }, "color": { "$ref": "#/$defs/Color", "description": "Optional. The color of the button. If set, the button `type` is set to `FILLED` and the color of `text` and `icon` fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white. To set the button color, specify a value for the `red`, `green`, and `blue` fields. The value must be a float number between 0 and 1 based on the RGB color value, where `0` (0/255) represents the absence of color and `1` (255/255) represents the maximum intensity of the color. For example, the following sets the color to red at its maximum intensity: ``` \"color\": { \"red\": 1, \"green\": 0, \"blue\": 0 } ``` The `alpha` field is unavailable for button color. If specified, this field is ignored." }, "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function." }, "icon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "An icon displayed inside the button. If both `icon` and `text` are set, then the icon appears before the text." }, "altText": { "type": "string", "description": "The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\"." }, "disabled": { "description": "If `true`, the button is displayed in an inactive state and doesn't respond to user actions.", "type": "boolean" } } }, "GoogleAppsCardV1ButtonList": { "type": "object", "properties": { "buttons": { "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1Button" }, "description": "An array of buttons." } }, "description": "A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1Card": { "properties": { "cardActions": { "type": "array", "description": "The card's actions. Actions are added to the card's toolbar menu. Supports up to 10 `CardAction` items. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` \"cardActions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```", "items": { "$ref": "#/$defs/GoogleAppsCardV1CardAction" } }, "name": { "type": "string", "description": "Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "header": { "$ref": "#/$defs/GoogleAppsCardV1CardHeader", "description": "The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card." }, "sections": { "description": "Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).", "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1Section" } }, "peekCardHeader": { "$ref": "#/$defs/GoogleAppsCardV1CardHeader", "description": "When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "fixedFooter": { "$ref": "#/$defs/GoogleAppsCardV1CardFixedFooter", "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "displayStyle": { "description": "In Google Workspace add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "type": "string", "enum": [ "DISPLAY_STYLE_UNSPECIFIED", "PEEK", "REPLACE" ] }, "expressionData": { "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1ExpressionData" }, "description": "The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "sectionDividerStyle": { "description": "The divider style between the header, sections and footer.", "enum": [ "DIVIDER_STYLE_UNSPECIFIED", "SOLID_DIVIDER", "NO_DIVIDER" ], "type": "string" } }, "description": "A card interface displayed in a Google Chat message or Google Workspace add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog). * For Google Workspace add-ons, see [Card-based interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards). Note: You can add up to 100 widgets per card. If a section's widgets push the total count above 100, that entire section and all following sections are ignored. This limit applies to both card messages and dialogs in Google Chat apps, and to cards in Google Workspace add-ons. **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { \"cardsV2\": [ { \"cardId\": \"unique-card-id\", \"card\": { \"header\": { \"title\": \"Sasha\", \"subtitle\": \"Software Engineer\", \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"imageType\": \"CIRCLE\", \"imageAltText\": \"Avatar for Sasha\" }, \"sections\": [ { \"header\": \"Contact Info\", \"collapsible\": true, \"uncollapsibleWidgetsCount\": 1, \"widgets\": [ { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"text\": \"sasha@example.com\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PERSON\" }, \"text\": \"Online\" } }, { \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"PHONE\" }, \"text\": \"+1 (555) 555-1234\" } }, { \"buttonList\": { \"buttons\": [ { \"text\": \"Share\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/share\" } } }, { \"text\": \"Edit\", \"onClick\": { \"action\": { \"function\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"EDIT\" } ] } } } ] } } ] } ] } } ] } ```", "type": "object" }, "GoogleAppsCardV1CardAction": { "type": "object", "properties": { "actionLabel": { "type": "string", "description": "The label that displays as the action menu item." }, "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "The `onClick` action for this action item." } }, "description": "A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "GoogleAppsCardV1CardFixedFooter": { "properties": { "secondaryButton": { "$ref": "#/$defs/GoogleAppsCardV1Button", "description": "The secondary button of the fixed footer. The button must be a text button with text and color set. If `secondaryButton` is set, you must also set `primaryButton`." }, "primaryButton": { "$ref": "#/$defs/GoogleAppsCardV1Button", "description": "The primary button of the fixed footer. The button must be a text button with text and color set." } }, "type": "object", "description": "A persistent (sticky) footer that that appears at the bottom of the card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1CardHeader": { "properties": { "subtitle": { "description": "The subtitle of the card header. If specified, appears on its own line below the `title`.", "type": "string" }, "title": { "description": "Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.", "type": "string" }, "imageAltText": { "description": "The alternative text of this image that's used for accessibility.", "type": "string" }, "imageType": { "type": "string", "description": "The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "enum": [ "SQUARE", "CIRCLE" ] }, "imageUrl": { "description": "The HTTPS URL of the image in the card header.", "type": "string" } }, "type": "object", "description": "Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1Carousel": { "description": "Rotates and displays a list of carousel cards in a slideshow format, with buttons navigating to the previous or next card. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\" } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\" } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\" } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", "properties": { "carouselCards": { "items": { "$ref": "#/$defs/GoogleAppsCardV1CarouselCard" }, "description": "A list of cards included in the carousel.", "type": "array" } }, "type": "object" }, "GoogleAppsCardV1CarouselCard": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1NestedWidget" }, "description": "A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified." }, "footerWidgets": { "description": "A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified.", "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1NestedWidget" } } }, "description": "A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):" }, "GoogleAppsCardV1Chip": { "type": "object", "properties": { "disabled": { "description": "Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.", "type": "boolean" }, "altText": { "type": "string", "description": "The alternative text that's used for accessibility. Set descriptive text that lets users know what the chip does. For example, if a chip opens a hyperlink, write: \"Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat\"." }, "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function." }, "enabled": { "description": "Deprecated: Use `disabled` instead. Whether the chip is in an active state and responds to user actions.", "type": "boolean", "deprecated": true }, "icon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "The icon image. If both `icon` and `label` are set, then the icon appears before the label." }, "label": { "type": "string", "description": "The text displayed inside the chip." } }, "description": "A text, icon, or text and icon chip that users can click. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1ChipList": { "type": "object", "description": "A list of chips layed out horizontally, which can either scroll horizontally or wrap to the next line. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "layout": { "enum": [ "LAYOUT_UNSPECIFIED", "WRAPPED", "HORIZONTAL_SCROLLABLE" ], "description": "Specified chip list layout.", "type": "string" }, "chips": { "description": "An array of chips.", "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1Chip" } } } }, "GoogleAppsCardV1CollapseControl": { "description": "Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "horizontalAlignment": { "enum": [ "HORIZONTAL_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ], "description": "The horizontal alignment of the expand and collapse button.", "type": "string" }, "collapseButton": { "$ref": "#/$defs/GoogleAppsCardV1Button", "description": "Optional. Define a customizable button to collapse the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used." }, "expandButton": { "$ref": "#/$defs/GoogleAppsCardV1Button", "description": "Optional. Define a customizable button to expand the section. Both expand_button and collapse_button field must be set. Only one field set will not take into effect. If this field isn't set, the default button is used." } }, "type": "object" }, "GoogleAppsCardV1Column": { "properties": { "widgets": { "items": { "$ref": "#/$defs/GoogleAppsCardV1Widgets" }, "description": "An array of widgets included in a column. Widgets appear in the order that they are specified.", "type": "array" }, "verticalAlignment": { "enum": [ "VERTICAL_ALIGNMENT_UNSPECIFIED", "CENTER", "TOP", "BOTTOM" ], "type": "string", "description": "Specifies whether widgets align to the top, bottom, or center of a column." }, "horizontalSizeStyle": { "type": "string", "enum": [ "HORIZONTAL_SIZE_STYLE_UNSPECIFIED", "FILL_AVAILABLE_SPACE", "FILL_MINIMUM_SPACE" ], "description": "Specifies how a column fills the width of the card." }, "horizontalAlignment": { "type": "string", "description": "Specifies whether widgets align to the left, right, or center of a column.", "enum": [ "HORIZONTAL_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ] } }, "type": "object", "description": "A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)" }, "GoogleAppsCardV1Columns": { "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.", "type": "object", "properties": { "columnItems": { "description": "An array of columns. You can include up to 2 columns in a card or dialog.", "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1Column" } } } }, "GoogleAppsCardV1CommonWidgetAction": { "properties": { "updateVisibilityAction": { "$ref": "#/$defs/GoogleAppsCardV1UpdateVisibilityAction", "description": "The action to update the visibility of a widget." } }, "description": "Represents an action that is not specific to a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "type": "object" }, "GoogleAppsCardV1Condition": { "description": "Represents a condition that can be used to trigger an action. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "properties": { "actionRuleId": { "description": "The unique identifier of the ActionRule.", "type": "string" }, "expressionDataCondition": { "$ref": "#/$defs/GoogleAppsCardV1ExpressionDataCondition", "description": "The condition that is determined by the expression data." } }, "type": "object" }, "GoogleAppsCardV1DataSourceConfig": { "properties": { "minCharactersTrigger": { "description": "The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).", "format": "int32", "type": "integer" }, "platformDataSource": { "$ref": "#/$defs/GoogleAppsCardV1PlatformDataSource", "description": "The data is from a Google Workspace application." }, "remoteDataSource": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "The data is from a remote data provider." } }, "description": "A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.", "type": "object" }, "GoogleAppsCardV1DateTimePicker": { "type": "object", "properties": { "timezoneOffsetDate": { "description": "The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. Note: This field is in minutes, whereas user interaction event payloads typically provide time zone offsets in milliseconds (divide by `60000` to convert).", "format": "int32", "type": "integer" }, "type": { "type": "string", "description": "Whether the widget supports inputting a date, a time, or the date and time.", "enum": [ "DATE_AND_TIME", "DATE_ONLY", "TIME_ONLY" ] }, "name": { "type": "string", "description": "The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data)." }, "hostAppDataSource": { "$ref": "#/$defs/HostAppDataSourceMarkup", "description": "A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "label": { "type": "string", "description": "The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as `Appointment date` or `Appointment date and time`." }, "valueMsEpoch": { "format": "int64", "description": "The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", "type": "string" }, "onChangeAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface." } }, "description": "Lets users input a date, a time, or both a date and a time. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time). Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1DecoratedText": { "properties": { "bottomLabelText": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "`TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" }, "wrapText": { "description": "The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.", "type": "boolean" }, "switchControl": { "$ref": "#/$defs/GoogleAppsCardV1SwitchControl", "description": "A switch widget that a user can click to change its state and trigger an action." }, "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "This action is triggered when users click anywhere on the `DecoratedText` widget (including `text`, `top_label`, `bottom_label`, and icons), except when clicking a separate interactive control (`button` or `switch_control`)." }, "topLabelText": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "`TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" }, "startIcon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "The icon displayed in front of the text." }, "bottomLabel": { "description": "The text that appears below `text`. Always wraps.", "type": "string" }, "text": { "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "button": { "$ref": "#/$defs/GoogleAppsCardV1Button", "description": "A button that a user can click to trigger an action." }, "icon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "Deprecated in favor of `startIcon`." }, "endIcon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons." }, "startIconVerticalAlignment": { "type": "string", "description": "Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):", "enum": [ "VERTICAL_ALIGNMENT_UNSPECIFIED", "TOP", "MIDDLE", "BOTTOM" ] }, "topLabel": { "description": "The text that appears above `text`. Always truncates.", "type": "string" }, "contentText": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "`TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):" } }, "type": "object", "description": "A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1Divider": { "description": "Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` \"divider\": {} ```", "properties": {}, "type": "object" }, "GoogleAppsCardV1EventAction": { "description": "Represents an actionthat can be performed on an ui element. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "type": "object", "properties": { "commonWidgetAction": { "$ref": "#/$defs/GoogleAppsCardV1CommonWidgetAction", "description": "Common widget action." }, "postEventTriggers": { "type": "array", "description": "The list of triggers that will be triggered after the EventAction is executed.", "items": { "$ref": "#/$defs/GoogleAppsCardV1Trigger" } }, "actionRuleId": { "description": "The unique identifier of the ActionRule.", "type": "string" } } }, "GoogleAppsCardV1ExpressionData": { "type": "object", "description": "Represents the data that is used to evaluate an expression. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "properties": { "id": { "type": "string", "description": "The unique identifier of the ExpressionData." }, "conditions": { "description": "The list of conditions that are determined by the expression evaluation result.", "items": { "$ref": "#/$defs/GoogleAppsCardV1Condition" }, "type": "array" }, "eventActions": { "items": { "$ref": "#/$defs/GoogleAppsCardV1EventAction" }, "type": "array", "description": "The list of actions that the ExpressionData can be used." }, "expression": { "description": "The uncompiled expression.", "type": "string" } } }, "GoogleAppsCardV1ExpressionDataCondition": { "description": "Represents a condition that is evaluated using CEL. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "type": "object", "properties": { "conditionType": { "enum": [ "CONDITION_TYPE_UNSPECIFIED", "EXPRESSION_EVALUATION_SUCCESS", "EXPRESSION_EVALUATION_FAILURE" ], "type": "string", "description": "The type of the condition." } } }, "GoogleAppsCardV1Grid": { "properties": { "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "This callback is reused by each individual grid item, but with the item's identifier added to the callback's parameters (under the key `\"grid_item_identifier\"`)." }, "items": { "items": { "$ref": "#/$defs/GoogleAppsCardV1GridItem" }, "type": "array", "description": "The items to display in the grid." }, "borderStyle": { "$ref": "#/$defs/GoogleAppsCardV1BorderStyle", "description": "The border style to apply to each grid item." }, "title": { "description": "The text that displays in the grid header.", "type": "string" }, "columnCount": { "format": "int32", "type": "integer", "description": "The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion)." } }, "type": "object", "description": "Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use `Columns`. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items). A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```" }, "GoogleAppsCardV1GridItem": { "properties": { "layout": { "enum": [ "GRID_ITEM_LAYOUT_UNSPECIFIED", "TEXT_BELOW", "TEXT_ABOVE" ], "type": "string", "description": "The layout to use for the grid item." }, "id": { "type": "string", "description": "A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters." }, "image": { "$ref": "#/$defs/GoogleAppsCardV1ImageComponent", "description": "The image that displays in the grid item." }, "title": { "description": "The grid item's title.", "type": "string" }, "subtitle": { "type": "string", "description": "The grid item's subtitle." } }, "description": "Represents an item in a grid layout. Items can contain text, an image, or both text and an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object" }, "GoogleAppsCardV1Icon": { "type": "object", "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "knownIcon": { "type": "string", "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format-messages#builtinicons)." }, "altText": { "type": "string", "description": "Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored." }, "materialIcon": { "$ref": "#/$defs/GoogleAppsCardV1MaterialIcon", "description": "Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` \"materialIcon\": { \"name\": \"check_box\" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):" }, "iconUrl": { "type": "string", "description": "Display a custom icon hosted at an HTTPS URL. For example: ``` \"iconUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\" ``` Supported file types include `.png` and `.jpg`." }, "imageType": { "type": "string", "description": "The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.", "enum": [ "SQUARE", "CIRCLE" ] } } }, "GoogleAppsCardV1Image": { "description": "An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "altText": { "description": "The alternative text of this image that's used for accessibility.", "type": "string" }, "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "When a user clicks the image, the click triggers this action." }, "imageUrl": { "description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```", "type": "string" } }, "type": "object" }, "GoogleAppsCardV1ImageComponent": { "description": "Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "borderStyle": { "$ref": "#/$defs/GoogleAppsCardV1BorderStyle", "description": "The border style to apply to the image." }, "imageUri": { "description": "The image URL.", "type": "string" }, "altText": { "description": "The accessibility label for the image.", "type": "string" }, "cropStyle": { "$ref": "#/$defs/GoogleAppsCardV1ImageCropStyle", "description": "The crop style to apply to the image." } }, "type": "object" }, "GoogleAppsCardV1ImageCropStyle": { "properties": { "aspectRatio": { "type": "number", "format": "double", "description": "The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```" }, "type": { "type": "string", "description": "The crop type.", "enum": [ "IMAGE_CROP_TYPE_UNSPECIFIED", "SQUARE", "CIRCLE", "RECTANGLE_CUSTOM", "RECTANGLE_4_3" ] } }, "type": "object", "description": "Represents the crop style applied to an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, here's how to apply a 16:9 aspect ratio: ``` cropStyle { \"type\": \"RECTANGLE_CUSTOM\", \"aspectRatio\": 16/9 } ```" }, "GoogleAppsCardV1MaterialIcon": { "description": "A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options. For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following: ``` { \"name\": \"check_box\", \"fill\": true, \"weight\": 300, \"grade\": -25 } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", "properties": { "grade": { "format": "int32", "description": "Weight and grade affect a symbol’s thickness. Adjustments to grade are more granular than adjustments to weight and have a small impact on the size of the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.", "type": "integer" }, "weight": { "format": "int32", "description": "The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**.", "type": "integer" }, "name": { "description": "The icon name defined in the [Google Material Icon](https://fonts.google.com/icons), for example, `check_box`. Any invalid names are abandoned and replaced with empty string and results in the icon failing to render.", "type": "string" }, "fill": { "type": "boolean", "description": "Whether the icon renders as filled. Default value is false. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**." } }, "type": "object" }, "GoogleAppsCardV1NestedWidget": { "description": "A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "object", "properties": { "buttonList": { "$ref": "#/$defs/GoogleAppsCardV1ButtonList", "description": "A button list widget." }, "textParagraph": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "A text paragraph widget." }, "image": { "$ref": "#/$defs/GoogleAppsCardV1Image", "description": "An image widget." } } }, "GoogleAppsCardV1OnClick": { "type": "object", "properties": { "card": { "$ref": "#/$defs/GoogleAppsCardV1Card", "description": "A new card is pushed to the card stack after clicking if specified. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "openLink": { "$ref": "#/$defs/GoogleAppsCardV1OpenLink", "description": "If specified, this `onClick` triggers an open link action." }, "overflowMenu": { "$ref": "#/$defs/GoogleAppsCardV1OverflowMenu", "description": "If specified, this `onClick` opens an overflow menu." }, "openDynamicLinkAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "action": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "If specified, an action is triggered by this `onClick`." } }, "description": "Represents how to respond when users click an interactive element on a card, such as a button. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1OpenLink": { "properties": { "url": { "description": "The URL to open. HTTP URLs are converted to HTTPS.", "type": "string" }, "onClose": { "enum": [ "NOTHING", "RELOAD" ], "type": "string", "description": "Whether the client forgets about a link after opening it, or observes it until the window closes. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "openAs": { "description": "How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):", "type": "string", "enum": [ "FULL_SIZE", "OVERLAY" ] } }, "description": "Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object" }, "GoogleAppsCardV1OverflowMenu": { "description": "A widget that presents a pop-up menu with one or more actions that users can invoke. For example, showing non-primary actions in a card. You can use this widget when actions don't fit in the available space. To use, specify this widget in the `OnClick` action of widgets that support it. For example, in a `Button`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1OverflowMenuItem" }, "description": "Required. The list of menu options." } }, "type": "object" }, "GoogleAppsCardV1OverflowMenuItem": { "properties": { "onClick": { "$ref": "#/$defs/GoogleAppsCardV1OnClick", "description": "Required. The action invoked when a menu option is selected. This `OnClick` cannot contain an `OverflowMenu`, any specified `OverflowMenu` is dropped and the menu item disabled." }, "startIcon": { "$ref": "#/$defs/GoogleAppsCardV1Icon", "description": "The icon displayed in front of the text." }, "text": { "type": "string", "description": "Required. The text that identifies or describes the item to users." }, "disabled": { "description": "Whether the menu option is disabled. Defaults to false.", "type": "boolean" } }, "description": "An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object" }, "GoogleAppsCardV1PlatformDataSource": { "type": "object", "properties": { "hostAppDataSource": { "$ref": "#/$defs/HostAppDataSourceMarkup", "description": "A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries)." }, "commonDataSource": { "type": "string", "description": "A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.", "enum": [ "UNKNOWN", "USER" ] } }, "description": "For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat):" }, "GoogleAppsCardV1Section": { "properties": { "collapsible": { "description": "Indicates whether this section is collapsible. Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking **Show more**. Users can hide the widgets again by clicking **Show less**. To determine which widgets are hidden, specify `uncollapsibleWidgetsCount`.", "type": "boolean" }, "id": { "type": "string", "description": "A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "header": { "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "widgets": { "description": "All the widgets in the section. Must contain at least one widget. A card supports up to 100 widgets across all sections.", "items": { "$ref": "#/$defs/GoogleAppsCardV1Widget" }, "type": "array" }, "uncollapsibleWidgetsCount": { "type": "integer", "description": "The number of uncollapsible widgets which remain visible even when a section is collapsed. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed by default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.", "format": "int32" }, "collapseControl": { "$ref": "#/$defs/GoogleAppsCardV1CollapseControl", "description": "Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used." } }, "type": "object", "description": "A section contains a collection of widgets that are rendered vertically in the order that they're specified. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1SelectionInput": { "properties": { "name": { "description": "Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", "type": "string" }, "type": { "enum": [ "CHECK_BOX", "RADIO_BUTTON", "SWITCH", "DROPDOWN", "MULTI_SELECT" ], "description": "The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.", "type": "string" }, "multiSelectMinQueryLength": { "format": "int32", "type": "integer", "description": "For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items." }, "items": { "description": "An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.", "type": "array", "items": { "$ref": "#/$defs/GoogleAppsCardV1SelectionItem" } }, "externalDataSource": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "An external data source, such as a relational database." }, "label": { "description": "The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be \"Urgency\" or \"Select urgency\".", "type": "string" }, "multiSelectMaxSelectedItems": { "type": "integer", "format": "int32", "description": "For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items." }, "onChangeAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data)." }, "dataSourceConfigs": { "description": "Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.", "items": { "$ref": "#/$defs/GoogleAppsCardV1DataSourceConfig" }, "type": "array" }, "hintText": { "description": "Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "type": "string" }, "platformDataSource": { "$ref": "#/$defs/GoogleAppsCardV1PlatformDataSource", "description": "A data source from Google Workspace." } }, "type": "object", "description": "A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1SelectionItem": { "description": "An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object", "properties": { "bottomText": { "description": "For multiselect menus, a text description or label that's displayed below the item's `text` field.", "type": "string" }, "text": { "description": "The text that identifies or describes the item to users.", "type": "string" }, "value": { "description": "The value associated with this item. The client should use this as a form input value. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", "type": "string" }, "selected": { "description": "Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.", "type": "boolean" }, "startIconUri": { "type": "string" } } }, "GoogleAppsCardV1SuggestionItem": { "type": "object", "properties": { "text": { "description": "The value of a suggested input to a text input field. This is equivalent to what users enter themselves.", "type": "string" } }, "description": "One suggested value that users can enter in a text input field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1Suggestions": { "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object", "properties": { "items": { "description": "A list of suggestions used for autocomplete recommendations in text input fields.", "items": { "$ref": "#/$defs/GoogleAppsCardV1SuggestionItem" }, "type": "array" } } }, "GoogleAppsCardV1SwitchControl": { "properties": { "selected": { "description": "When `true`, the switch is selected, and its `value` is included in `CommonEventObject.form_inputs[name].string_inputs.value`.", "type": "boolean" }, "onChangeAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "The action to perform when the switch state is changed, such as what function to run." }, "value": { "type": "string", "description": "The value returned in `CommonEventObject.form_inputs[name].string_inputs` when the switch is selected (`selected` is `true`). If `selected` is `true` and `value` is unset, an empty string (`\"\"`) is returned in `string_inputs.value`. When `selected` is `false`, this value is omitted from `string_inputs.value`. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data)." }, "controlType": { "description": "How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "enum": [ "SWITCH", "CHECKBOX", "CHECK_BOX" ], "type": "string" }, "name": { "description": "The name by which the switch widget is identified in a form input event (as the key in `CommonEventObject.form_inputs`). For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", "type": "string" } }, "type": "object", "description": "Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget." }, "GoogleAppsCardV1TextInput": { "type": "object", "properties": { "hintText": { "type": "string", "description": "Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if `label` is unspecified. Otherwise, optional." }, "autoCompleteAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "Optional. Specify what action to take when the text input field provides suggestions to users who interact with it. If unspecified, the suggestions are set by `initialSuggestions` and are processed by the client. If specified, the app takes the action specified here, such as running a custom function. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):" }, "label": { "description": "The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write `surname` instead of `name`. Required if `hintText` is unspecified. Otherwise, optional.", "type": "string" }, "type": { "description": "How a text input field appears in the user interface. For example, whether the field is single or multi-line.", "type": "string", "enum": [ "SINGLE_LINE", "MULTIPLE_LINE" ] }, "name": { "description": "The name by which the text input is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", "type": "string" }, "onChangeAction": { "$ref": "#/$defs/GoogleAppsCardV1Action", "description": "What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text. Examples of actions to take include running a custom function or opening a [dialog](https://developers.google.com/workspace/chat/dialogs) in Google Chat." }, "validation": { "$ref": "#/$defs/GoogleAppsCardV1Validation", "description": "Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "value": { "type": "string", "description": "The value entered by a user, returned as part of a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data)." }, "placeholderText": { "description": "Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, `Enter a number from 0 to 100`. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "string" }, "initialSuggestions": { "$ref": "#/$defs/GoogleAppsCardV1Suggestions", "description": "Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show just `Java` and `JavaScript`. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app. When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "hostAppDataSource": { "$ref": "#/$defs/HostAppDataSourceMarkup", "description": "A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." } }, "description": "A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" }, "GoogleAppsCardV1TextParagraph": { "type": "object", "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "properties": { "textSyntax": { "enum": [ "TEXT_SYNTAX_UNSPECIFIED", "HTML", "MARKDOWN" ], "description": "The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "string" }, "maxLines": { "format": "int32", "description": "The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored.", "type": "integer" }, "text": { "type": "string", "description": "The text that's shown in the widget." } } }, "GoogleAppsCardV1Trigger": { "properties": { "actionRuleId": { "type": "string", "description": "The unique identifier of the ActionRule." } }, "type": "object", "description": "Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "GoogleAppsCardV1UpdateVisibilityAction": { "properties": { "visibility": { "enum": [ "VISIBILITY_UNSPECIFIED", "VISIBLE", "HIDDEN" ], "description": "The new visibility.", "type": "string" } }, "type": "object", "description": "Represents an action that updates the visibility of a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "GoogleAppsCardV1Validation": { "description": "Represents the necessary data for validating the widget it's attached to. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "object", "properties": { "characterLimit": { "format": "int32", "description": "Specify the character limit for text input widgets. Note that this is only used for text input and is ignored for other widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):", "type": "integer" }, "inputType": { "enum": [ "INPUT_TYPE_UNSPECIFIED", "TEXT", "INTEGER", "FLOAT", "EMAIL", "EMOJI_PICKER" ], "type": "string", "description": "Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):" } } }, "GoogleAppsCardV1Widget": { "type": "object", "description": "Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.", "properties": { "selectionInput": { "$ref": "#/$defs/GoogleAppsCardV1SelectionInput", "description": "Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` \"selectionInput\": { \"name\": \"size\", \"label\": \"Size\", \"type\": \"DROPDOWN\", \"items\": [ { \"text\": \"S\", \"value\": \"small\", \"selected\": false }, { \"text\": \"M\", \"value\": \"medium\", \"selected\": true }, { \"text\": \"L\", \"value\": \"large\", \"selected\": false }, { \"text\": \"XL\", \"value\": \"extra_large\", \"selected\": false } ] } ```" }, "eventActions": { "items": { "$ref": "#/$defs/GoogleAppsCardV1EventAction" }, "type": "array", "description": "Specifies the event actions that can be performed on the widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps." }, "id": { "description": "A unique ID assigned to the widget that's used to identify the widget to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "type": "string" }, "textParagraph": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" }, "columns": { "$ref": "#/$defs/GoogleAppsCardV1Columns", "description": "Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` \"columns\": { \"columnItems\": [ { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"First column text paragraph\" } } ] }, { \"horizontalSizeStyle\": \"FILL_AVAILABLE_SPACE\", \"horizontalAlignment\": \"CENTER\", \"verticalAlignment\": \"CENTER\", \"widgets\": [ { \"textParagraph\": { \"text\": \"Second column text paragraph\" } } ] } ] } ```" }, "buttonList": { "$ref": "#/$defs/GoogleAppsCardV1ButtonList", "description": "A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` \"buttonList\": { \"buttons\": [ { \"text\": \"Edit\", \"color\": { \"red\": 0, \"green\": 0, \"blue\": 1 }, \"disabled\": true }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ```" }, "visibility": { "description": "Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", "enum": [ "VISIBILITY_UNSPECIFIED", "VISIBLE", "HIDDEN" ], "type": "string" }, "horizontalAlignment": { "description": "Specifies whether widgets align to the left, right, or center of a column.", "type": "string", "enum": [ "HORIZONTAL_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ] }, "decoratedText": { "$ref": "#/$defs/GoogleAppsCardV1DecoratedText", "description": "Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` \"decoratedText\": { \"startIcon\": { \"knownIcon\": \"EMAIL\" }, \"topLabel\": \"Email Address\", \"text\": \"sasha@example.com\", \"bottomLabel\": \"This is a new Email address!\", \"switchControl\": { \"name\": \"has_send_welcome_email_to_sasha\", \"selected\": false, \"controlType\": \"CHECK_BOX\" } } ```" }, "carousel": { "$ref": "#/$defs/GoogleAppsCardV1Carousel", "description": "Contains a collection of `CarouselCard` items, each of which contains nested widgets. For example, this is a JSON representation of a carousel that contains two carousel cards, each with a text paragraph: ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in the carousel.\" } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in the carousel.\" } } ] } ] } ```" }, "textInput": { "$ref": "#/$defs/GoogleAppsCardV1TextInput", "description": "Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` \"textInput\": { \"name\": \"mailing_address\", \"label\": \"Mailing Address\" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` \"textInput\": { \"name\": \"preferred_programing_language\", \"label\": \"Preferred Language\", \"initialSuggestions\": { \"items\": [ { \"text\": \"C++\" }, { \"text\": \"Java\" }, { \"text\": \"JavaScript\" }, { \"text\": \"Python\" } ] } } ```" }, "dateTimePicker": { "$ref": "#/$defs/GoogleAppsCardV1DateTimePicker", "description": "Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` \"dateTimePicker\": { \"name\": \"appointment_time\", \"label\": \"Book your appointment at:\", \"type\": \"DATE_AND_TIME\", \"valueMsEpoch\": 796435200000 } ```" }, "divider": { "$ref": "#/$defs/GoogleAppsCardV1Divider", "description": "Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` \"divider\": { } ```" }, "grid": { "$ref": "#/$defs/GoogleAppsCardV1Grid", "description": "Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` \"grid\": { \"title\": \"A fine collection of items\", \"columnCount\": 2, \"borderStyle\": { \"type\": \"STROKE\", \"cornerRadius\": 4 }, \"items\": [ { \"image\": { \"imageUri\": \"https://www.example.com/image.png\", \"cropStyle\": { \"type\": \"SQUARE\" }, \"borderStyle\": { \"type\": \"STROKE\" } }, \"title\": \"An item\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```" }, "chipList": { "$ref": "#/$defs/GoogleAppsCardV1ChipList", "description": "A list of chips. For example, the following JSON creates two chips. The first is a text chip and the second is an icon chip that opens a link: ``` \"chipList\": { \"chips\": [ { \"label\": \"Edit\", \"disabled\": true }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ```" }, "image": { "$ref": "#/$defs/GoogleAppsCardV1Image", "description": "Displays an image. For example, the following JSON creates an image with alternative text: ``` \"image\": { \"imageUrl\": \"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png\", \"altText\": \"Chat app avatar\" } ```" } } }, "GoogleAppsCardV1Widgets": { "type": "object", "properties": { "textInput": { "$ref": "#/$defs/GoogleAppsCardV1TextInput", "description": "TextInput widget." }, "selectionInput": { "$ref": "#/$defs/GoogleAppsCardV1SelectionInput", "description": "SelectionInput widget." }, "buttonList": { "$ref": "#/$defs/GoogleAppsCardV1ButtonList", "description": "ButtonList widget." }, "image": { "$ref": "#/$defs/GoogleAppsCardV1Image", "description": "Image widget." }, "chipList": { "$ref": "#/$defs/GoogleAppsCardV1ChipList", "description": "ChipList widget." }, "decoratedText": { "$ref": "#/$defs/GoogleAppsCardV1DecoratedText", "description": "DecoratedText widget." }, "textParagraph": { "$ref": "#/$defs/GoogleAppsCardV1TextParagraph", "description": "TextParagraph widget." }, "dateTimePicker": { "$ref": "#/$defs/GoogleAppsCardV1DateTimePicker", "description": "DateTimePicker widget." } }, "description": "The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)" }, "HostAppDataSourceMarkup": { "type": "object", "description": "A data source from a Google Workspace application. The data source populates available items for a widget.", "properties": { "chatDataSource": { "$ref": "#/$defs/ChatClientDataSourceMarkup", "description": "A data source from Google Chat." }, "workflowDataSource": { "$ref": "#/$defs/WorkflowDataSourceMarkup", "description": "A data source from Google Workflow." } } }, "Image": { "properties": { "onClick": { "$ref": "#/$defs/OnClick", "description": "The `onclick` action." }, "aspectRatio": { "type": "number", "description": "The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.", "format": "double" }, "imageUrl": { "type": "string", "description": "The URL of the image." } }, "description": "An image that's specified by a URL and can have an `onclick` action.", "type": "object" }, "ImageButton": { "properties": { "name": { "description": "The name of this `image_button` that's used for accessibility. Default value is provided if this name isn't specified.", "type": "string" }, "onClick": { "$ref": "#/$defs/OnClick", "description": "The `onclick` action." }, "iconUrl": { "description": "The icon specified by a URL.", "type": "string" }, "icon": { "description": "The icon specified by an `enum` that indices to an icon provided by Chat API.", "type": "string", "enum": [ "ICON_UNSPECIFIED", "AIRPLANE", "BOOKMARK", "BUS", "CAR", "CLOCK", "CONFIRMATION_NUMBER_ICON", "DOLLAR", "DESCRIPTION", "EMAIL", "EVENT_PERFORMER", "EVENT_SEAT", "FLIGHT_ARRIVAL", "FLIGHT_DEPARTURE", "HOTEL", "HOTEL_ROOM_TYPE", "INVITE", "MAP_PIN", "MEMBERSHIP", "MULTIPLE_PEOPLE", "OFFER", "PERSON", "PHONE", "RESTAURANT_ICON", "SHOPPING_CART", "STAR", "STORE", "TICKET", "TRAIN", "VIDEO_CAMERA", "VIDEO_PLAY" ] } }, "description": "An image button with an `onclick` action.", "type": "object" }, "KeyValue": { "description": "A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.", "type": "object", "properties": { "contentMultiline": { "description": "If the content should be multiline.", "type": "boolean" }, "content": { "type": "string", "description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting)." }, "button": { "$ref": "#/$defs/Button", "description": "A button that can be clicked to trigger an action." }, "bottomLabel": { "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "iconUrl": { "description": "The icon specified by a URL.", "type": "string" }, "topLabel": { "type": "string", "description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting)." }, "onClick": { "$ref": "#/$defs/OnClick", "description": "The `onclick` action. Only the top label, bottom label, and content region are clickable." }, "icon": { "enum": [ "ICON_UNSPECIFIED", "AIRPLANE", "BOOKMARK", "BUS", "CAR", "CLOCK", "CONFIRMATION_NUMBER_ICON", "DOLLAR", "DESCRIPTION", "EMAIL", "EVENT_PERFORMER", "EVENT_SEAT", "FLIGHT_ARRIVAL", "FLIGHT_DEPARTURE", "HOTEL", "HOTEL_ROOM_TYPE", "INVITE", "MAP_PIN", "MEMBERSHIP", "MULTIPLE_PEOPLE", "OFFER", "PERSON", "PHONE", "RESTAURANT_ICON", "SHOPPING_CART", "STAR", "STORE", "TICKET", "TRAIN", "VIDEO_CAMERA", "VIDEO_PLAY" ], "description": "An enum value that's replaced by the Chat API with the corresponding icon image.", "type": "string" } } }, "MatchedUrl": { "properties": { "url": { "type": "string", "description": "Output only. The URL that was matched.", "readOnly": true } }, "type": "object", "description": "A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links)." }, "MeetSpaceLinkData": { "description": "Data for Meet space links.", "properties": { "huddleStatus": { "readOnly": true, "description": "Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.", "type": "string", "enum": [ "HUDDLE_STATUS_UNSPECIFIED", "STARTED", "ENDED", "MISSED" ] }, "type": { "description": "Indicates the type of the Meet space.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "MEETING", "HUDDLE" ] }, "meetingCode": { "description": "Meeting code of the linked Meet space.", "type": "string" } }, "type": "object" }, "MembershipCount": { "properties": { "joinedDirectHumanUserCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group." }, "joinedGroupCount": { "readOnly": true, "description": "Output only. Count of all groups that have directly joined the space.", "format": "int32", "type": "integer" } }, "type": "object", "description": "Represents the count of memberships of a space, grouped into categories." }, "OnClick": { "description": "An `onclick` action (for example, open a link).", "type": "object", "properties": { "openLink": { "$ref": "#/$defs/OpenLink", "description": "This `onclick` action triggers an open link action if specified." }, "action": { "$ref": "#/$defs/FormAction", "description": "A form action is triggered by this `onclick` action if specified." } } }, "OpenLink": { "description": "A link that opens a new window.", "type": "object", "properties": { "url": { "description": "The URL to open.", "type": "string" } } }, "PermissionSetting": { "properties": { "membersAllowed": { "description": "Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.", "type": "boolean" }, "managersAllowed": { "type": "boolean", "description": "Optional. Whether space owners (`ROLE_MANAGER`) have this permission." }, "assistantManagersAllowed": { "description": "Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.", "type": "boolean" } }, "description": "Represents a space permission setting.", "type": "object" }, "PermissionSettings": { "properties": { "manageApps": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for managing apps in a space." }, "useAtMentionAll": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for using @all in a space." }, "manageWebhooks": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for managing webhooks in a space." }, "replyMessages": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for replying to messages in a space." }, "toggleHistory": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for toggling space history on and off." }, "manageMembersAndGroups": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for managing members and groups in a space." }, "postMessages": { "$ref": "#/$defs/PermissionSetting", "description": "Output only. Setting for posting messages in a space." }, "viewSpaceMembership": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for viewing space membership. Must be specified together with `AccessPermissionSettings.view_space_membership_setting` in the update mask and request body when updating who can view space membership. When restricting view access to specific roles (for example, space managers or assistant managers only), specify the desired role permissions here and provide an empty `AccessPermissionSettings.view_space_membership_setting` in the same request. If a target audience is configured in `AccessPermissionSettings.view_space_membership_setting`, this setting must be granted to all members." }, "modifySpaceDetails": { "$ref": "#/$defs/PermissionSetting", "description": "Optional. Setting for updating space name, avatar, description and guidelines." } }, "description": "[Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request.", "type": "object" }, "Principal": { "type": "object", "description": "A principal representing an entity granted access.", "properties": { "audience": { "$ref": "#/$defs/Audience", "description": "An audience." } } }, "QuotedMessageMetadata": { "properties": { "quotedMessageSnapshot": { "$ref": "#/$defs/QuotedMessageSnapshot", "description": "Output only. A snapshot of the quoted message's content." }, "lastUpdateTime": { "format": "google-datetime", "description": "Required. The timestamp when the quoted message was created or when the quoted message was last updated. If the message was edited, use this field, `last_update_time`. If the message was never edited, use `create_time`. If `last_update_time` doesn't match the latest version of the quoted message, the request fails.", "type": "string" }, "name": { "description": "Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`", "type": "string" }, "quoteType": { "enum": [ "QUOTE_TYPE_UNSPECIFIED", "REPLY", "FORWARD" ], "type": "string", "description": "Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility." }, "forwardedMetadata": { "$ref": "#/$defs/ForwardedMetadata", "description": "Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type." } }, "type": "object", "description": "Information about a message that another message quotes. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message)." }, "QuotedMessageSnapshot": { "type": "object", "properties": { "sender": { "readOnly": true, "description": "Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.", "type": "string" }, "annotations": { "readOnly": true, "type": "array", "description": "Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.", "items": { "$ref": "#/$defs/Annotation" } }, "attachments": { "readOnly": true, "type": "array", "description": "Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.", "items": { "$ref": "#/$defs/Attachment" } }, "text": { "readOnly": true, "type": "string", "description": "Output only. Snapshot of the quoted message's text content." }, "formattedText": { "type": "string", "readOnly": true, "description": "Output only. Contains the quoted message `text` with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type." } }, "description": "Provides a snapshot of the content of the quoted message at the time of quoting or forwarding" }, "RichLinkMetadata": { "description": "A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.", "properties": { "chatSpaceLinkData": { "$ref": "#/$defs/ChatSpaceLinkData", "description": "Data for a chat space link." }, "meetSpaceLinkData": { "$ref": "#/$defs/MeetSpaceLinkData", "description": "Data for a Meet space link." }, "uri": { "description": "The URI of this link.", "type": "string" }, "calendarEventLinkData": { "$ref": "#/$defs/CalendarEventLinkData", "description": "Data for a Calendar event link." }, "driveLinkData": { "$ref": "#/$defs/DriveLinkData", "description": "Data for a drive link." }, "richLinkType": { "description": "The rich link type.", "enum": [ "RICH_LINK_TYPE_UNSPECIFIED", "DRIVE_FILE", "CHAT_SPACE", "GMAIL_MESSAGE", "MEET_SPACE", "CALENDAR_EVENT" ], "type": "string" } }, "type": "object" }, "Section": { "properties": { "widgets": { "type": "array", "items": { "$ref": "#/$defs/WidgetMarkup" }, "description": "A section must contain at least one widget." }, "header": { "type": "string", "description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting)." } }, "type": "object", "description": "A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float)." }, "SelectionItems": { "properties": { "items": { "description": "An array of the SelectionItem objects.", "items": { "$ref": "#/$defs/GoogleAppsCardV1SelectionItem" }, "type": "array" } }, "type": "object", "description": "List of widget autocomplete results." }, "SlashCommand": { "type": "object", "description": "Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.", "properties": { "commandId": { "description": "The ID of the slash command.", "format": "int64", "type": "string" } } }, "SlashCommandMetadata": { "properties": { "bot": { "$ref": "#/$defs/User", "description": "The Chat app whose command was invoked." }, "commandId": { "description": "The command ID of the invoked slash command.", "format": "int64", "type": "string" }, "commandName": { "description": "The name of the invoked slash command.", "type": "string" }, "type": { "description": "The type of slash command.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "ADD", "INVOKE" ] }, "triggersDialog": { "description": "Indicates whether the slash command is for a dialog.", "type": "boolean" } }, "type": "object", "description": "Annotation metadata for slash commands (/)." }, "Snippet": { "description": "A snippet object representing an excerpt from a larger corpus.", "type": "object", "properties": { "imagePreview": { "$ref": "#/$defs/ElementsImage", "description": "Optional. Image preview of the snippet provided as an input when creating the citation." }, "text": { "description": "Optional. A short plaintext excerpt directly from the corpus that is rendered in the citation hover card or source preview. When footer sources are automatically populated from inline `citations` (because `Elements.cited_sources` is not set), snippets are omitted from the deduplicated footer sources. Does not support markdown format, and must not exceed 1,000 characters.", "type": "string" } } }, "Space": { "properties": { "singleUserBotDm": { "description": "Optional. Whether the space is a DM between a Chat app and a single human.", "type": "boolean" }, "type": { "type": "string", "description": "Output only. Deprecated: Use `space_type` instead. The type of a space.", "readOnly": true, "enum": [ "TYPE_UNSPECIFIED", "ROOM", "DM" ], "deprecated": true }, "spaceDetails": { "$ref": "#/$defs/SpaceDetails", "description": "Optional. Details about the space including description and rules." }, "customer": { "type": "string", "description": "Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users." }, "accessSettings": { "$ref": "#/$defs/AccessSettings", "description": "Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`." }, "spaceType": { "enum": [ "SPACE_TYPE_UNSPECIFIED", "SPACE", "GROUP_CHAT", "DIRECT_MESSAGE" ], "description": "Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.", "type": "string" }, "importMode": { "description": "Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "type": "boolean" }, "membershipCount": { "$ref": "#/$defs/MembershipCount", "description": "Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`." }, "lastActiveTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp of the last message in the space.", "readOnly": true }, "externalUserAllowed": { "type": "boolean", "description": "Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only." }, "adminInstalled": { "description": "Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.", "type": "boolean", "readOnly": true }, "spaceUri": { "type": "string", "readOnly": true, "description": "Output only. The URI for a user to access the space." }, "name": { "type": "string", "description": "Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`." }, "spaceThreadingState": { "enum": [ "SPACE_THREADING_STATE_UNSPECIFIED", "THREADED_MESSAGES", "GROUPED_MESSAGES", "UNTHREADED_MESSAGES" ], "readOnly": true, "description": "Output only. The threading state in the Chat space.", "type": "string" }, "permissionSettings": { "$ref": "#/$defs/PermissionSettings", "description": "Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)" }, "threaded": { "type": "boolean", "description": "Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.", "readOnly": true, "deprecated": true }, "displayName": { "description": "Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.", "type": "string" }, "spaceHistoryState": { "type": "string", "description": "Optional. The message history state for messages and threads in this space.", "enum": [ "HISTORY_STATE_UNSPECIFIED", "HISTORY_OFF", "HISTORY_ON" ] }, "predefinedPermissionSettings": { "description": "Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", "enum": [ "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED", "COLLABORATION_SPACE", "ANNOUNCEMENT_SPACE" ], "type": "string" }, "createTime": { "format": "google-datetime", "description": "Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.", "type": "string" }, "importModeExpireTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode." } }, "type": "object", "description": "A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app." }, "SpaceDataSource": { "description": "A data source that populates Google Chat spaces as selection items for a multiselect menu. Only populates spaces that the user is a member of. [Google Chat apps](https://developers.google.com/workspace/chat):", "type": "object", "properties": { "defaultToCurrentSpace": { "type": "boolean", "description": "If set to `true`, the multiselect menu selects the current Google Chat space as an item by default." } } }, "SpaceDetails": { "description": "Details about the space including description and rules.", "type": "object", "properties": { "description": { "type": "string", "description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters." }, "guidelines": { "description": "Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.", "type": "string" } } }, "TextButton": { "type": "object", "description": "A button with text and `onclick` action.", "properties": { "text": { "description": "The text of the button.", "type": "string" }, "onClick": { "$ref": "#/$defs/OnClick", "description": "The `onclick` action of the button." } } }, "TextParagraph": { "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "properties": { "text": { "type": "string" } }, "type": "object" }, "Thread": { "type": "object", "description": "A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found.", "properties": { "name": { "description": "Identifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", "type": "string" }, "threadKey": { "type": "string", "description": "Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead." } } }, "UpdatedWidget": { "properties": { "widget": { "description": "The ID of the updated widget. The ID must match the one for the widget that triggered the update request.", "type": "string" }, "suggestions": { "$ref": "#/$defs/SelectionItems", "description": "List of widget autocomplete results" } }, "description": "For `selectionInput` widgets, returns autocomplete suggestions for a multiselect menu.", "type": "object" }, "User": { "description": "If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource (such as in the Messages and Memberships APIs) only populates the `name` and `type` fields for both internal and external users, unless they are members of the space or have prior affinity with the calling user.", "properties": { "displayName": { "readOnly": true, "type": "string", "description": "Output only. The user's display name. Populated for both app authentication and user authentication. This field is always populated for requests made with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user." }, "type": { "enum": [ "TYPE_UNSPECIFIED", "HUMAN", "BOT" ], "type": "string", "description": "User type." }, "name": { "type": "string", "description": "Resource name for a Google Chat user. Format: `users/{user}`. `users/app` can be used as an alias for the calling app bot user. For human users, `{user}` is the same user identifier as: - the `id` for the [Person](https://developers.google.com/people/api/rest/v1/people) in the People API. For example, `users/123456789` in Chat API represents the same person as the `123456789` Person profile ID in People API. - the `id` for a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. - the user's email address can be used as an alias for `{user}` in API requests. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can use `users/user@example.com` as an alias to reference `users/123456789`. Only the canonical resource name (for example `users/123456789`) will be returned from the API." }, "avatarUrl": { "readOnly": true, "type": "string", "description": "Output only. The user's avatar image URL. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user." }, "email": { "type": "string", "description": "Output only. The user's email address. When calling the Messages and Memberships APIs with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), this field is populated for both internal and external users for the `sender` of a message, users within `annotations` (such as user mentions), and within `Membership` resources, provided the user is a member of the space or has prior affinity with the calling user.", "readOnly": true }, "domainId": { "description": "Unique identifier of the user's Google Workspace domain.", "type": "string" }, "isAnonymous": { "readOnly": true, "type": "boolean", "description": "Output only. When `true`, the user is deleted or their profile is not visible, such as when a user is mentioned in a space without being a member and without prior affinity with the calling user." } }, "type": "object" }, "UserMentionMetadata": { "properties": { "type": { "enum": [ "TYPE_UNSPECIFIED", "ADD", "MENTION" ], "description": "The type of user mention.", "type": "string" }, "user": { "$ref": "#/$defs/User", "description": "The user mentioned." } }, "type": "object", "description": "Annotation metadata for user mentions (@)." }, "WidgetMarkup": { "properties": { "buttons": { "items": { "$ref": "#/$defs/Button" }, "type": "array", "description": "A list of buttons. Buttons is also `oneof data` and only one of these fields should be set." }, "image": { "$ref": "#/$defs/Image", "description": "Display an image in this widget." }, "textParagraph": { "$ref": "#/$defs/TextParagraph", "description": "Display a text paragraph in this widget." }, "keyValue": { "$ref": "#/$defs/KeyValue", "description": "Display a key value item in this widget." } }, "description": "A widget is a UI element that presents text and images.", "type": "object" }, "WorkflowDataSourceMarkup": { "description": "* Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. In a `TextInput` or `SelectionInput` widget with MULTI_SELECT type or a `DateTimePicker`, provide data source from Google.", "properties": { "type": { "type": "string", "description": "The type of data source.", "enum": [ "UNKNOWN", "USER", "SPACE", "USER_WITH_FREE_FORM" ] }, "includeVariables": { "type": "boolean", "description": "Whether to include variables from the previous step in the data source." } }, "type": "object" } } }