{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/chat.admin.delete": {
"description": "Delete conversations and spaces owned by your organization and remove access to associated files in Google Chat"
},
"https://www.googleapis.com/auth/chat.admin.memberships": {
"description": "View, add, update and remove members and managers in conversations owned by your organization"
},
"https://www.googleapis.com/auth/chat.admin.memberships.readonly": {
"description": "View members and managers in conversations owned by your organization"
},
"https://www.googleapis.com/auth/chat.admin.spaces": {
"description": "View or edit display name, description, and other metadata for all Google Chat conversations owned by your organization"
},
"https://www.googleapis.com/auth/chat.admin.spaces.readonly": {
"description": "View display name, description, and other metadata for all Google Chat conversations owned by your organization"
},
"https://www.googleapis.com/auth/chat.app.delete": {
"description": "On their own behalf, apps in Google Chat can delete conversations and spaces and remove access to associated files"
},
"https://www.googleapis.com/auth/chat.app.memberships": {
"description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces"
},
"https://www.googleapis.com/auth/chat.app.memberships.readonly": {
"description": "On their own behalf, apps in Google Chat can see members of conversations and spaces"
},
"https://www.googleapis.com/auth/chat.app.messages.readonly": {
"description": "On their own behalf, apps in Google Chat can see all messages and their associated reactions and message content"
},
"https://www.googleapis.com/auth/chat.app.spaces": {
"description": "On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings)"
},
"https://www.googleapis.com/auth/chat.app.spaces.create": {
"description": "On their own behalf, apps in Google Chat can create conversations and spaces"
},
"https://www.googleapis.com/auth/chat.app.spaces.readonly": {
"description": "On their own behalf, apps in Google Chat can see conversations and spaces and their metadata (including history settings and access settings)"
},
"https://www.googleapis.com/auth/chat.bot": {
"description": "Private Service: https://www.googleapis.com/auth/chat.bot"
},
"https://www.googleapis.com/auth/chat.customemojis": {
"description": "View, create, and delete custom emoji in Google Chat"
},
"https://www.googleapis.com/auth/chat.customemojis.readonly": {
"description": "View custom emoji in Google Chat"
},
"https://www.googleapis.com/auth/chat.delete": {
"description": "Delete conversations and spaces and remove access to associated files in Google Chat"
},
"https://www.googleapis.com/auth/chat.import": {
"description": "Import spaces, messages, and memberships into Google Chat."
},
"https://www.googleapis.com/auth/chat.memberships": {
"description": "See, add, update, and remove members from conversations and spaces in Google Chat"
},
"https://www.googleapis.com/auth/chat.memberships.app": {
"description": "Add and remove itself from conversations and spaces in Google Chat"
},
"https://www.googleapis.com/auth/chat.memberships.readonly": {
"description": "View members in Google Chat conversations."
},
"https://www.googleapis.com/auth/chat.messages": {
"description": "See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages."
},
"https://www.googleapis.com/auth/chat.messages.create": {
"description": "Compose and send messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions": {
"description": "See, add, and delete reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions.create": {
"description": "Add reactions to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.reactions.readonly": {
"description": "View reactions as well as their reaction content to messages in Google Chat"
},
"https://www.googleapis.com/auth/chat.messages.readonly": {
"description": "See messages as well as their reactions and message content in Google Chat"
},
"https://www.googleapis.com/auth/chat.spaces": {
"description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat"
},
"https://www.googleapis.com/auth/chat.spaces.create": {
"description": "Create new conversations and spaces in Google Chat"
},
"https://www.googleapis.com/auth/chat.spaces.readonly": {
"description": "View chat and spaces in Google Chat"
},
"https://www.googleapis.com/auth/chat.users.readstate": {
"description": "View and modify last read time for Google Chat conversations"
},
"https://www.googleapis.com/auth/chat.users.readstate.readonly": {
"description": "View last read time for Google Chat conversations"
},
"https://www.googleapis.com/auth/chat.users.sections": {
"description": "View, create, update, and delete your sections in Google Chat; move and list your section items in Google Chat"
},
"https://www.googleapis.com/auth/chat.users.sections.readonly": {
"description": "View your sections and their section items in Google Chat"
},
"https://www.googleapis.com/auth/chat.users.spacesettings": {
"description": "Read and update your space settings"
}
}
}
},
"basePath": "",
"baseUrl": "https://chat.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Hangouts Chat",
"description": "The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/workspace/chat",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "chat:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://chat.mtls.googleapis.com/",
"name": "chat",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"customEmojis": {
"methods": {
"create": {
"description": "Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`",
"flatPath": "v1/customEmojis",
"httpMethod": "POST",
"id": "chat.customEmojis.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/customEmojis",
"request": {
"$ref": "CustomEmoji"
},
"response": {
"$ref": "CustomEmoji"
},
"scopes": [
"https://www.googleapis.com/auth/chat.customemojis"
]
},
"delete": {
"description": "Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`",
"flatPath": "v1/customEmojis/{customEmojisId}",
"httpMethod": "DELETE",
"id": "chat.customEmojis.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the custom emoji to delete. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.",
"location": "path",
"pattern": "^customEmojis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/chat.customemojis"
]
},
"get": {
"description": "Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`",
"flatPath": "v1/customEmojis/{customEmojisId}",
"httpMethod": "GET",
"id": "chat.customEmojis.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the custom emoji. Format: `customEmojis/{customEmoji}` You can use the emoji name as an alias for `{customEmoji}`. For example, `customEmojis/:example-emoji:` where `:example-emoji:` is the emoji name for a custom emoji.",
"location": "path",
"pattern": "^customEmojis/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "CustomEmoji"
},
"scopes": [
"https://www.googleapis.com/auth/chat.customemojis",
"https://www.googleapis.com/auth/chat.customemojis.readonly"
]
},
"list": {
"description": "Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`",
"flatPath": "v1/customEmojis",
"httpMethod": "GET",
"id": "chat.customEmojis.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: ``` creator(\"users/me\") ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.",
"location": "query",
"type": "string"
}
},
"path": "v1/customEmojis",
"response": {
"$ref": "ListCustomEmojisResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.customemojis",
"https://www.googleapis.com/auth/chat.customemojis.readonly"
]
}
}
},
"media": {
"methods": {
"download": {
"description": "Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.",
"flatPath": "v1/media/{mediaId}",
"httpMethod": "GET",
"id": "chat.media.download",
"parameterOrder": [
"resourceName"
],
"parameters": {
"resourceName": {
"description": "Name of the media that is being downloaded. See ReadRequest.resource_name.",
"location": "path",
"pattern": "^.*$",
"required": true,
"type": "string"
}
},
"path": "v1/media/{+resourceName}",
"response": {
"$ref": "Media"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.readonly"
],
"supportsMediaDownload": true
},
"upload": {
"description": "Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).",
"flatPath": "v1/spaces/{spacesId}/attachments:upload",
"httpMethod": "POST",
"id": "chat.media.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"maxSize": "209715200",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/v1/{+parent}/attachments:upload"
},
"simple": {
"multipart": true,
"path": "/upload/v1/{+parent}/attachments:upload"
}
}
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Resource name of the Chat space in which the attachment is uploaded. Format \"spaces/{space}\".",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/attachments:upload",
"request": {
"$ref": "UploadAttachmentRequest"
},
"response": {
"$ref": "UploadAttachmentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.create"
],
"supportsMediaUpload": true
}
}
},
"spaces": {
"methods": {
"completeImport": {
"description": "Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) and domain-wide delegation with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.import` For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import).",
"flatPath": "v1/spaces/{spacesId}:completeImport",
"httpMethod": "POST",
"id": "chat.spaces.completeImport",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the import mode space. Format: `spaces/{space}`",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:completeImport",
"request": {
"$ref": "CompleteImportSpaceRequest"
},
"response": {
"$ref": "CompleteImportSpaceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.import"
]
},
"create": {
"description": "Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. When authenticating as an app, the Chat app is added as a member of the space. However, unlike human authentication, the Chat app is not added as a space manager. By default, the Chat app can be removed from the space by all space members. To allow only space managers to remove the app from a space, set `space.permission_settings.manage_apps` to `managers_allowed`. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.",
"flatPath": "v1/spaces",
"httpMethod": "POST",
"id": "chat.spaces.create",
"parameterOrder": [],
"parameters": {
"requestId": {
"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.",
"location": "query",
"type": "string"
}
},
"path": "v1/spaces",
"request": {
"$ref": "Space"
},
"response": {
"$ref": "Space"
},
"scopes": [
"https://www.googleapis.com/auth/chat.app.spaces",
"https://www.googleapis.com/auth/chat.app.spaces.create",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.create"
]
},
"delete": {
"description": "Deletes a named space. Always performs a cascading delete, which means that the space's child resources\u2014like messages posted in the space and memberships in the space\u2014are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete`",
"flatPath": "v1/spaces/{spacesId}",
"httpMethod": "DELETE",
"id": "chat.spaces.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the space to delete. Format: `spaces/{space}`",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.delete",
"https://www.googleapis.com/auth/chat.app.delete",
"https://www.googleapis.com/auth/chat.delete",
"https://www.googleapis.com/auth/chat.import"
]
},
"findDirectMessage": {
"description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`",
"flatPath": "v1/spaces:findDirectMessage",
"httpMethod": "GET",
"id": "chat.spaces.findDirectMessage",
"parameterOrder": [],
"parameters": {
"name": {
"description": "Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.",
"location": "query",
"type": "string"
}
},
"path": "v1/spaces:findDirectMessage",
"response": {
"$ref": "Space"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
},
"findGroupChats": {
"description": "Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`",
"flatPath": "v1/spaces:findGroupChats",
"httpMethod": "GET",
"id": "chat.spaces.findGroupChats",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.",
"location": "query",
"type": "string"
},
"spaceView": {
"description": "Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.",
"enum": [
"SPACE_VIEW_UNSPECIFIED",
"SPACE_VIEW_RESOURCE_NAME_ONLY",
"SPACE_VIEW_EXPANDED"
],
"enumDescriptions": [
"The default / unset value.",
"Populates only the Space resource name.",
"Populates Space resource fields. Note: the `permissionSettings` field will not be populated. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly."
],
"location": "query",
"type": "string"
},
"users": {
"description": "Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "v1/spaces:findGroupChats",
"response": {
"$ref": "FindGroupChatsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.readonly"
]
},
"get": {
"description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.",
"flatPath": "v1/spaces/{spacesId}",
"httpMethod": "GET",
"id": "chat.spaces.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the space, in the form `spaces/{space}`. Format: `spaces/{space}`",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Space"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.spaces",
"https://www.googleapis.com/auth/chat.admin.spaces.readonly",
"https://www.googleapis.com/auth/chat.app.spaces",
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
},
"list": {
"description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.",
"flatPath": "v1/spaces",
"httpMethod": "GET",
"id": "chat.spaces.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. A query filter. You can filter spaces by the space type ([`space_type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype)). To filter by space type, you must specify valid enum value, such as `SPACE` or `GROUP_CHAT` (the `space_type` can't be `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR` operator. For example, the following queries are valid: ``` space_type = \"SPACE\" spaceType = \"GROUP_CHAT\" OR spaceType = \"DIRECT_MESSAGE\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.",
"location": "query",
"type": "string"
}
},
"path": "v1/spaces",
"response": {
"$ref": "ListSpacesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
},
"patch": {
"description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - To update either `space.predefined_permission_settings` or `space.permission_settings`, the app must be the space creator. - Updating the `space.access_settings.audience` is not supported for app authentication.",
"flatPath": "v1/spaces/{spacesId}",
"httpMethod": "PATCH",
"id": "chat.spaces.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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`.",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Space"
},
"response": {
"$ref": "Space"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.spaces",
"https://www.googleapis.com/auth/chat.app.spaces",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.spaces"
]
},
"search": {
"description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, set `use_admin_access` to `true`. For an example, see [Search for and manage spaces](https://developers.google.com/workspace/chat/search-manage-admin). Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`",
"flatPath": "v1/spaces:search",
"httpMethod": "GET",
"id": "chat.spaces.search",
"parameterOrder": [],
"parameters": {
"orderBy": {
"description": "Optional. How the list of spaces is ordered. Supported attributes to order by are: - `membership_count.joined_direct_human_user_count` \u2014 Denotes the count of human users that have directly joined a space. - `last_active_time` \u2014 Denotes the time when last eligible item is added to any topic of this space. - `create_time` \u2014 Denotes the time of the space creation. Valid ordering operation values are: - `ASC` for ascending. Default value. - `DESC` for descending. The supported syntax are: - `membership_count.joined_direct_human_user_count DESC` - `membership_count.joined_direct_human_user_count ASC` - `last_active_time DESC` - `last_active_time ASC` - `create_time DESC` - `create_time ASC`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"query": {
"description": "Required. A search query. You can search by using the following parameters : - `create_time` - `customer` - `display_name` - `external_user_allowed` - `last_active_time` - `space_history_state` - `space_type` `create_time` and `last_active_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and the supported comparison operators are: `=`, `<`, `>`, `<=`, `>=`. `customer` is required and is used to indicate which customer to fetch spaces from. `customers/my_customer` is the only supported value. `display_name` only accepts the `HAS` (`:`) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's `display_name`. For example, `Fun Eve` matches `Fun event` or `The evening was fun`, but not `notFun event` or `even`. `external_user_allowed` accepts either `true` or `false`. `space_history_state` only accepts values from the [`historyState`] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of a `space` resource. `space_type` is required and the only valid value is `SPACE`. Across different fields, only `AND` operators are supported. A valid example is `space_type = \"SPACE\" AND display_name:\"Hello\"` and an invalid example is `space_type = \"SPACE\" OR display_name:\"Hello\"`. Among the same field, `space_type` doesn't support `AND` or `OR` operators. `display_name`, 'space_history_state', and 'external_user_allowed' only support `OR` operators. `last_active_time` and `create_time` support both `AND` and `OR` operators. `AND` can only be used to represent an interval, such as `last_active_time < \"2022-01-01T00:00:00+00:00\" AND last_active_time > \"2023-01-01T00:00:00+00:00\"`. The following example queries are valid: ``` customer = \"customers/my_customer\" AND space_type = \"SPACE\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND display_name:\"Hello World\" customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (last_active_time < \"2020-01-01T00:00:00+00:00\" OR last_active_time > \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (display_name:\"Hello World\" OR display_name:\"Fun event\") AND (last_active_time > \"2020-01-01T00:00:00+00:00\" AND last_active_time < \"2022-01-01T00:00:00+00:00\") customer = \"customers/my_customer\" AND space_type = \"SPACE\" AND (create_time > \"2019-01-01T00:00:00+00:00\" AND create_time < \"2020-01-01T00:00:00+00:00\") AND (external_user_allowed = \"true\") AND (space_history_state = \"HISTORY_ON\" OR space_history_state = \"HISTORY_OFF\") ```",
"location": "query",
"type": "string"
},
"useAdminAccess": {
"description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.spaces.readonly` or `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). This method currently only supports admin access, thus only `true` is accepted for this field.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/spaces:search",
"response": {
"$ref": "SearchSpacesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.spaces",
"https://www.googleapis.com/auth/chat.admin.spaces.readonly",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
},
"setup": {
"description": "Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces`",
"flatPath": "v1/spaces:setup",
"httpMethod": "POST",
"id": "chat.spaces.setup",
"parameterOrder": [],
"parameters": {},
"path": "v1/spaces:setup",
"request": {
"$ref": "SetUpSpaceRequest"
},
"response": {
"$ref": "Space"
},
"scopes": [
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.create"
]
}
},
"resources": {
"members": {
"methods": {
"create": {
"description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Inviting users external to the Workspace organization that owns the space. - Adding a Google Group to a space. - Adding a Chat app to a space. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).",
"flatPath": "v1/spaces/{spacesId}/members",
"httpMethod": "POST",
"id": "chat.spaces.members.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the space for which to create the membership. Format: spaces/{space}",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/members",
"request": {
"$ref": "Membership"
},
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.memberships",
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.app"
]
},
"delete": {
"description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Removing a Google Group from a space. - Removing a Chat app from a space. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the Chat app must be the space creator.",
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
"httpMethod": "DELETE",
"id": "chat.spaces.members.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope with [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or the `chat.memberships.app` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and the `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.",
"location": "path",
"pattern": "^spaces/[^/]+/members/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.memberships",
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.app"
]
},
"get": {
"description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`",
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
"httpMethod": "GET",
"id": "chat.spaces.members.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.",
"location": "path",
"pattern": "^spaces/[^/]+/members/[^/]+$",
"required": true,
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.memberships",
"https://www.googleapis.com/auth/chat.admin.memberships.readonly",
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.readonly"
]
},
"list": {
"description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`",
"flatPath": "v1/spaces/{spacesId}/members",
"httpMethod": "GET",
"id": "chat.spaces.members.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"showGroups": {
"description": "Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.",
"location": "query",
"type": "boolean"
},
"showInvited": {
"description": "Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
"location": "query",
"type": "boolean"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/members",
"response": {
"$ref": "ListMembershipsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.memberships",
"https://www.googleapis.com/auth/chat.admin.memberships.readonly",
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.readonly"
]
},
"patch": {
"description": "Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships`",
"flatPath": "v1/spaces/{spacesId}/members/{membersId}",
"httpMethod": "PATCH",
"id": "chat.spaces.members.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`",
"location": "path",
"pattern": "^spaces/[^/]+/members/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `role`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"useAdminAccess": {
"description": "Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Membership"
},
"response": {
"$ref": "Membership"
},
"scopes": [
"https://www.googleapis.com/auth/chat.admin.memberships",
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.memberships"
]
}
}
},
"messages": {
"methods": {
"create": {
"description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.",
"flatPath": "v1/spaces/{spacesId}/messages",
"httpMethod": "POST",
"id": "chat.spaces.messages.create",
"parameterOrder": [
"parent"
],
"parameters": {
"createMessageNotificationOptions.notificationType": {
"description": "The notification type for the message.",
"enum": [
"NOTIFICATION_TYPE_NONE",
"NOTIFICATION_TYPE_FORCE_NOTIFY",
"NOTIFICATION_TYPE_SILENT"
],
"enumDescriptions": [
"Default behavior. Notification behavior is similar to when the human user sends the message using the Chat UI: no notification is sent to the human sender.",
"Force notify recipients. This bypasses users' space notification settings and [Chat Do Not Disturb settings](https://support.google.com/chat/answer/9093489). This option does not bypass device-level Do Not Disturb settings. Requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
"Silence the notification as if the recipients have [Chat Do Not Disturb](https://support.google.com/chat/answer/9093489) enabled or have muted the space. Requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app)."
],
"location": "query",
"type": "string"
},
"messageId": {
"description": "Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message `name` field). The value for this field must meet the following requirements: * Begins with `client-`. For example, `client-custom-name` is a valid custom ID, but `custom-name` is not. * Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
"location": "query",
"type": "string"
},
"messageReplyOption": {
"description": "Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When [responding to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions), this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.",
"enum": [
"MESSAGE_REPLY_OPTION_UNSPECIFIED",
"REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD",
"REPLY_MESSAGE_OR_FAIL"
],
"enumDescriptions": [
"Default. Starts a new thread. Using this option ignores any thread ID or `thread_key` that's included.",
"Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, the message starts a new thread instead.",
"Creates the message as a reply to the thread specified by thread ID or `thread_key`. If a new `thread_key` is used, a new thread is created. If the message creation fails, a `NOT_FOUND` error is returned instead."
],
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the space in which to create a message. Format: `spaces/{space}`",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.",
"location": "query",
"type": "string"
},
"threadKey": {
"deprecated": true,
"description": "Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread).",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/messages",
"request": {
"$ref": "Message"
},
"response": {
"$ref": "Message"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.create"
]
},
"delete": {
"description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
"httpMethod": "DELETE",
"id": "chat.spaces.messages.delete",
"parameterOrder": [
"name"
],
"parameters": {
"force": {
"description": "Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages"
]
},
"get": {
"description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
"httpMethod": "GET",
"id": "chat.spaces.messages.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message).",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Message"
},
"scopes": [
"https://www.googleapis.com/auth/chat.app.messages.readonly",
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.readonly"
]
},
"list": {
"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [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 authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)",
"flatPath": "v1/spaces/{spacesId}/messages",
"httpMethod": "GET",
"id": "chat.spaces.messages.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A query filter. You can filter messages by date (`create_time`) and thread (`thread.name`). To filter messages by the date they were created, specify the `create_time` with a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and double quotation marks. For example, `\"2023-04-21T11:30:00-04:00\"`. You can use the greater than operator `>` to list messages that were created after a timestamp, or the less than operator `<` to list messages that were created before a timestamp. To filter messages within a time interval, use the `AND` operator between two timestamps. To filter by thread, specify the `thread.name`, formatted as `spaces/{space}/threads/{thread}`. You can only specify one `thread.name` per query. To filter by both thread and date, use the `AND` operator in your query. For example, the following queries are valid: ``` create_time > \"2012-04-21T11:30:00-04:00\" create_time > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > \"2012-04-21T11:30:00+00:00\" AND create_time < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: - `ASC` for ascending. - `DESC` for descending. The default ordering is `create_time ASC`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the space to list messages from. Format: `spaces/{space}`",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/messages",
"response": {
"$ref": "ListMessagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.app.messages.readonly",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.readonly"
]
},
"patch": {
"description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
"httpMethod": "PATCH",
"id": "chat.spaces.messages.patch",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.",
"location": "query",
"type": "boolean"
},
"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).",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Message"
},
"response": {
"$ref": "Message"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages"
]
},
"update": {
"description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}",
"httpMethod": "PUT",
"id": "chat.spaces.messages.update",
"parameterOrder": [
"name"
],
"parameters": {
"allowMissing": {
"description": "Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client-assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.",
"location": "query",
"type": "boolean"
},
"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).",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Message"
},
"response": {
"$ref": "Message"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot",
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages"
]
}
},
"resources": {
"attachments": {
"methods": {
"get": {
"description": "Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.bot`",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/attachments/{attachmentsId}",
"httpMethod": "GET",
"id": "chat.spaces.messages.attachments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`.",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+/attachments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Attachment"
},
"scopes": [
"https://www.googleapis.com/auth/chat.bot"
]
}
}
},
"reactions": {
"methods": {
"create": {
"description": "Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
"httpMethod": "POST",
"id": "chat.spaces.messages.reactions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The message where the reaction is created. Format: `spaces/{space}/messages/{message}`",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reactions",
"request": {
"$ref": "Reaction"
},
"response": {
"$ref": "Reaction"
},
"scopes": [
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.reactions",
"https://www.googleapis.com/auth/chat.messages.reactions.create"
]
},
"delete": {
"description": "Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}",
"httpMethod": "DELETE",
"id": "chat.spaces.messages.reactions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the reaction to delete. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+/reactions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/chat.import",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.reactions"
]
},
"list": {
"description": "Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`",
"flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions",
"httpMethod": "GET",
"id": "chat.spaces.messages.reactions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A query filter. You can filter reactions by [emoji](https://developers.google.com/workspace/chat/api/reference/rest/v1/Emoji) (either `emoji.unicode` or `emoji.custom_emoji.uid`) and [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) (`user.name`). To filter reactions for multiple emojis or users, join similar fields with the `OR` operator, such as `emoji.unicode = \"\ud83d\ude42\" OR emoji.unicode = \"\ud83d\udc4d\"` and `user.name = \"users/AAAAAA\" OR user.name = \"users/BBBBBB\"`. To filter reactions by emoji and user, use the `AND` operator, such as `emoji.unicode = \"\ud83d\ude42\" AND user.name = \"users/AAAAAA\"`. If your query uses both `AND` and `OR`, group them with parentheses. For example, the following queries are valid: ``` user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.unicode = \"\ud83d\udc4d\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" AND user.name = \"users/{user}\" (emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\") AND user.name = \"users/{user}\" ``` The following queries are invalid: ``` emoji.unicode = \"\ud83d\ude42\" AND emoji.unicode = \"\ud83d\udc4d\" emoji.unicode = \"\ud83d\ude42\" AND emoji.custom_emoji.uid = \"{uid}\" emoji.unicode = \"\ud83d\ude42\" OR user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" OR user.name = \"users/{user}\" emoji.unicode = \"\ud83d\ude42\" OR emoji.custom_emoji.uid = \"{uid}\" AND user.name = \"users/{user}\" ``` Invalid queries are rejected with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`",
"location": "path",
"pattern": "^spaces/[^/]+/messages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reactions",
"response": {
"$ref": "ListReactionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.reactions",
"https://www.googleapis.com/auth/chat.messages.reactions.readonly",
"https://www.googleapis.com/auth/chat.messages.readonly"
]
}
}
}
}
},
"spaceEvents": {
"methods": {
"get": {
"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [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 one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).",
"flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}",
"httpMethod": "GET",
"id": "chat.spaces.spaceEvents.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`",
"location": "path",
"pattern": "^spaces/[^/]+/spaceEvents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "SpaceEvent"
},
"scopes": [
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.app.memberships.readonly",
"https://www.googleapis.com/auth/chat.app.messages.readonly",
"https://www.googleapis.com/auth/chat.app.spaces",
"https://www.googleapis.com/auth/chat.app.spaces.readonly",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.readonly",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.reactions",
"https://www.googleapis.com/auth/chat.messages.reactions.readonly",
"https://www.googleapis.com/auth/chat.messages.readonly",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
},
"list": {
"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [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 one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).",
"flatPath": "v1/spaces/{spacesId}/spaceEvents",
"httpMethod": "GET",
"id": "chat.spaces.spaceEvents.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.",
"location": "path",
"pattern": "^spaces/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/spaceEvents",
"response": {
"$ref": "ListSpaceEventsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.app.memberships",
"https://www.googleapis.com/auth/chat.app.memberships.readonly",
"https://www.googleapis.com/auth/chat.app.messages.readonly",
"https://www.googleapis.com/auth/chat.app.spaces",
"https://www.googleapis.com/auth/chat.app.spaces.readonly",
"https://www.googleapis.com/auth/chat.memberships",
"https://www.googleapis.com/auth/chat.memberships.readonly",
"https://www.googleapis.com/auth/chat.messages",
"https://www.googleapis.com/auth/chat.messages.reactions",
"https://www.googleapis.com/auth/chat.messages.reactions.readonly",
"https://www.googleapis.com/auth/chat.messages.readonly",
"https://www.googleapis.com/auth/chat.spaces",
"https://www.googleapis.com/auth/chat.spaces.readonly"
]
}
}
}
}
},
"users": {
"resources": {
"sections": {
"methods": {
"create": {
"description": "Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`",
"flatPath": "v1/users/{usersId}/sections",
"httpMethod": "POST",
"id": "chat.users.sections.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name where the section is created. Format: `users/{user}`",
"location": "path",
"pattern": "^users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/sections",
"request": {
"$ref": "GoogleChatV1Section"
},
"response": {
"$ref": "GoogleChatV1Section"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections"
]
},
"delete": {
"description": "Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`",
"flatPath": "v1/users/{usersId}/sections/{sectionsId}",
"httpMethod": "DELETE",
"id": "chat.users.sections.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the section to delete. Format: `users/{user}/sections/{section}`",
"location": "path",
"pattern": "^users/[^/]+/sections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections"
]
},
"list": {
"description": "Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`",
"flatPath": "v1/users/{usersId}/sections",
"httpMethod": "GET",
"id": "chat.users.sections.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of sections to return. The service may return fewer than this value. If unspecified, at most 10 sections will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}`",
"location": "path",
"pattern": "^users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/sections",
"response": {
"$ref": "ListSectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections",
"https://www.googleapis.com/auth/chat.users.sections.readonly"
]
},
"patch": {
"description": "Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`",
"flatPath": "v1/users/{usersId}/sections/{sectionsId}",
"httpMethod": "PATCH",
"id": "chat.users.sections.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`",
"location": "path",
"pattern": "^users/[^/]+/sections/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The mask to specify which fields to update. Currently supported field paths: - `display_name`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleChatV1Section"
},
"response": {
"$ref": "GoogleChatV1Section"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections"
]
},
"position": {
"description": "Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`",
"flatPath": "v1/users/{usersId}/sections/{sectionsId}:position",
"httpMethod": "POST",
"id": "chat.users.sections.position",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`",
"location": "path",
"pattern": "^users/[^/]+/sections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:position",
"request": {
"$ref": "PositionSectionRequest"
},
"response": {
"$ref": "PositionSectionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections"
]
}
},
"resources": {
"items": {
"methods": {
"list": {
"description": "Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`",
"flatPath": "v1/users/{usersId}/sections/{sectionsId}/items",
"httpMethod": "GET",
"id": "chat.users.sections.items.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}`. Invalid queries are rejected with an `INVALID_ARGUMENT` error.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Negative values return an `INVALID_ARGUMENT` error.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}`",
"location": "path",
"pattern": "^users/[^/]+/sections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/items",
"response": {
"$ref": "ListSectionItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections",
"https://www.googleapis.com/auth/chat.users.sections.readonly"
]
},
"move": {
"description": "Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`",
"flatPath": "v1/users/{usersId}/sections/{sectionsId}/items/{itemsId}:move",
"httpMethod": "POST",
"id": "chat.users.sections.items.move",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}`",
"location": "path",
"pattern": "^users/[^/]+/sections/[^/]+/items/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:move",
"request": {
"$ref": "MoveSectionItemRequest"
},
"response": {
"$ref": "MoveSectionItemResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.sections"
]
}
}
}
}
},
"spaces": {
"methods": {
"getSpaceReadState": {
"description": "Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`",
"flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceReadState",
"httpMethod": "GET",
"id": "chat.users.spaces.getSpaceReadState",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState",
"location": "path",
"pattern": "^users/[^/]+/spaces/[^/]+/spaceReadState$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "SpaceReadState"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.readstate",
"https://www.googleapis.com/auth/chat.users.readstate.readonly"
]
},
"updateSpaceReadState": {
"description": "Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`",
"flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceReadState",
"httpMethod": "PATCH",
"id": "chat.users.spaces.updateSpaceReadState",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`",
"location": "path",
"pattern": "^users/[^/]+/spaces/[^/]+/spaceReadState$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "SpaceReadState"
},
"response": {
"$ref": "SpaceReadState"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.readstate"
]
}
},
"resources": {
"spaceNotificationSetting": {
"methods": {
"get": {
"description": "Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`",
"flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting",
"httpMethod": "GET",
"id": "chat.users.spaces.spaceNotificationSetting.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting - `users/me/spaces/{space}/spaceNotificationSetting`, OR - `users/user@example.com/spaces/{space}/spaceNotificationSetting`, OR - `users/123456789/spaces/{space}/spaceNotificationSetting`. Note: Only the caller's user id or email is allowed in the path.",
"location": "path",
"pattern": "^users/[^/]+/spaces/[^/]+/spaceNotificationSetting$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "SpaceNotificationSetting"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.spacesettings"
]
},
"patch": {
"description": "Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`",
"flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting",
"httpMethod": "PATCH",
"id": "chat.users.spaces.spaceNotificationSetting.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.",
"location": "path",
"pattern": "^users/[^/]+/spaces/[^/]+/spaceNotificationSetting$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Supported field paths: - `notification_setting` - `mute_setting`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "SpaceNotificationSetting"
},
"response": {
"$ref": "SpaceNotificationSetting"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.spacesettings"
]
}
}
},
"threads": {
"methods": {
"getThreadReadState": {
"description": "Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`",
"flatPath": "v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState",
"httpMethod": "GET",
"id": "chat.users.spaces.threads.getThreadReadState",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState",
"location": "path",
"pattern": "^users/[^/]+/spaces/[^/]+/threads/[^/]+/threadReadState$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ThreadReadState"
},
"scopes": [
"https://www.googleapis.com/auth/chat.users.readstate",
"https://www.googleapis.com/auth/chat.users.readstate.readonly"
]
}
}
}
}
}
}
}
},
"revision": "20260510",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"AccessSettings": {
"description": "Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space.",
"id": "AccessSettings",
"properties": {
"accessState": {
"description": "Output only. Indicates the access state of the space.",
"enum": [
"ACCESS_STATE_UNSPECIFIED",
"PRIVATE",
"DISCOVERABLE"
],
"enumDescriptions": [
"Access state is unknown or not supported in this API.",
"Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.",
"A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). Creating discoverable spaces requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)."
],
"readOnly": true,
"type": "string"
},
"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"
}
},
"type": "object"
},
"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).",
"id": "AccessoryWidget",
"properties": {
"buttonList": {
"$ref": "GoogleAppsCardV1ButtonList",
"description": "A list of buttons."
}
},
"type": "object"
},
"ActionParameter": {
"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.",
"id": "ActionParameter",
"properties": {
"key": {
"description": "The name of the parameter for the action script.",
"type": "string"
},
"value": {
"description": "The value of the parameter.",
"type": "string"
}
},
"type": "object"
},
"ActionResponse": {
"description": "Parameters that a Chat app can use to configure how its response is posted.",
"id": "ActionResponse",
"properties": {
"dialogAction": {
"$ref": "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`."
},
"type": {
"description": "Input only. The type of Chat app response.",
"enum": [
"TYPE_UNSPECIFIED",
"NEW_MESSAGE",
"UPDATE_MESSAGE",
"UPDATE_USER_MESSAGE_CARDS",
"REQUEST_CONFIG",
"DIALOG",
"UPDATE_WIDGET"
],
"enumDescriptions": [
"Default type that's handled as `NEW_MESSAGE`.",
"Post as a new message in the topic.",
"Update the Chat app's message. This is only permitted on a `CARD_CLICKED` event where the message sender type is `BOT`.",
"Update the cards on a user's message. This is only permitted as a response to a `MESSAGE` event with a matched url, or a `CARD_CLICKED` event where the message sender type is `HUMAN`. Text is ignored.",
"Privately ask the user for additional authentication or configuration.",
"Presents a [dialog](https://developers.google.com/workspace/chat/dialogs).",
"Widget text autocomplete options query."
],
"type": "string"
},
"updatedWidget": {
"$ref": "UpdatedWidget",
"description": "Input only. The response of the updated widget."
},
"url": {
"description": "Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)",
"type": "string"
}
},
"type": "object"
},
"ActionStatus": {
"description": "Represents the status for a request to either invoke or submit a [dialog](https://developers.google.com/workspace/chat/dialogs).",
"id": "ActionStatus",
"properties": {
"statusCode": {
"description": "The status code.",
"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"
],
"enumDescriptions": [
"Not an error; returned on success. HTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
"Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
"The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
"The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
"Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
"The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
"Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
"The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
"Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"Annotation": {
"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. 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\" } }] ```",
"id": "Annotation",
"properties": {
"customEmojiMetadata": {
"$ref": "CustomEmojiMetadata",
"description": "The metadata for a custom emoji."
},
"length": {
"description": "Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.",
"format": "int32",
"type": "integer"
},
"richLinkMetadata": {
"$ref": "RichLinkMetadata",
"description": "The metadata for a rich link."
},
"slashCommand": {
"$ref": "SlashCommandMetadata",
"description": "The metadata for a slash command."
},
"startIndex": {
"description": "Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "The type of this annotation.",
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"USER_MENTION",
"SLASH_COMMAND",
"RICH_LINK",
"CUSTOM_EMOJI"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"A user is mentioned.",
"A slash command is invoked.",
"A rich link annotation.",
"A custom emoji annotation."
],
"type": "string"
},
"userMention": {
"$ref": "UserMentionMetadata",
"description": "The metadata of user mention."
}
},
"type": "object"
},
"AppCommandMetadata": {
"description": "Metadata about a [Chat app command](https://developers.google.com/workspace/chat/commands).",
"id": "AppCommandMetadata",
"properties": {
"appCommandId": {
"description": "The ID for the command specified in the Chat API configuration.",
"format": "int32",
"type": "integer"
},
"appCommandType": {
"description": "The type of Chat app command.",
"enum": [
"APP_COMMAND_TYPE_UNSPECIFIED",
"SLASH_COMMAND",
"QUICK_COMMAND"
],
"enumDescriptions": [
"Default value. Unspecified.",
"A slash command. The user sends the command in a Chat message.",
"A quick command. The user selects the command from the Chat menu in the message reply area."
],
"type": "string"
}
},
"type": "object"
},
"AttachedGif": {
"description": "A GIF image that's specified by a URL.",
"id": "AttachedGif",
"properties": {
"uri": {
"description": "Output only. The URL that hosts the GIF image.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Attachment": {
"description": "An attachment in Google Chat.",
"id": "Attachment",
"properties": {
"attachmentDataRef": {
"$ref": "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."
},
"contentName": {
"description": "Output only. The original file name for the content, not the full path.",
"readOnly": true,
"type": "string"
},
"contentType": {
"description": "Output only. The content type (MIME type) of the file.",
"readOnly": true,
"type": "string"
},
"downloadUri": {
"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.",
"readOnly": true,
"type": "string"
},
"driveDataRef": {
"$ref": "DriveDataRef",
"description": "Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.",
"readOnly": true
},
"name": {
"description": "Identifier. Resource name of the attachment. Format: `spaces/{space}/messages/{message}/attachments/{attachment}`.",
"type": "string"
},
"source": {
"description": "Output only. The source of the attachment.",
"enum": [
"SOURCE_UNSPECIFIED",
"DRIVE_FILE",
"UPLOADED_CONTENT"
],
"enumDescriptions": [
"Reserved.",
"The file is a Google Drive file.",
"The file is uploaded to Chat."
],
"readOnly": true,
"type": "string"
},
"thumbnailUri": {
"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.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AttachmentDataRef": {
"description": "A reference to the attachment data.",
"id": "AttachmentDataRef",
"properties": {
"attachmentUploadToken": {
"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.",
"type": "string"
},
"resourceName": {
"description": "Optional. The resource name of the attachment data. This field is used with the media API to download the attachment data.",
"type": "string"
}
},
"type": "object"
},
"Button": {
"description": "A button. Can be a text button or an image button.",
"id": "Button",
"properties": {
"imageButton": {
"$ref": "ImageButton",
"description": "A button with image and `onclick` action."
},
"textButton": {
"$ref": "TextButton",
"description": "A button with text and `onclick` action."
}
},
"type": "object"
},
"CalendarEventLinkData": {
"description": "Data for Calendar event links.",
"id": "CalendarEventLinkData",
"properties": {
"calendarId": {
"description": "The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.",
"type": "string"
},
"eventId": {
"description": "The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.",
"type": "string"
}
},
"type": "object"
},
"Card": {
"description": "A card is a UI element that can contain UI widgets such as text and images.",
"id": "Card",
"properties": {
"cardActions": {
"description": "The actions of this card.",
"items": {
"$ref": "CardAction"
},
"type": "array"
},
"header": {
"$ref": "CardHeader",
"description": "The header of the card. A header usually contains a title and an image."
},
"name": {
"description": "Name of the card.",
"type": "string"
},
"sections": {
"description": "Sections are separated by a line divider.",
"items": {
"$ref": "Section"
},
"type": "array"
}
},
"type": "object"
},
"CardAction": {
"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.",
"id": "CardAction",
"properties": {
"actionLabel": {
"description": "The label used to be displayed in the action menu item.",
"type": "string"
},
"onClick": {
"$ref": "OnClick",
"description": "The onclick action for this action item."
}
},
"type": "object"
},
"CardHeader": {
"id": "CardHeader",
"properties": {
"imageStyle": {
"description": "The image's type (for example, square border or circular border).",
"enum": [
"IMAGE_STYLE_UNSPECIFIED",
"IMAGE",
"AVATAR"
],
"enumDescriptions": [
"",
"Square border.",
"Circular border."
],
"type": "string"
},
"imageUrl": {
"description": "The URL of the image in the card header.",
"type": "string"
},
"subtitle": {
"description": "The subtitle of the card header.",
"type": "string"
},
"title": {
"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.",
"type": "string"
}
},
"type": "object"
},
"CardWithId": {
"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)",
"id": "CardWithId",
"properties": {
"card": {
"$ref": "GoogleAppsCardV1Card",
"description": "A card. Maximum size is 32 KB."
},
"cardId": {
"description": "Required if the message contains multiple cards. A unique identifier for a card in a message.",
"type": "string"
}
},
"type": "object"
},
"ChatAppLogEntry": {
"description": "JSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to [Google Cloud Logging](https://cloud.google.com/logging/docs).",
"id": "ChatAppLogEntry",
"properties": {
"deployment": {
"description": "The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script.",
"type": "string"
},
"deploymentFunction": {
"description": "The unencrypted `callback_method` name that was running when the error was encountered.",
"type": "string"
},
"error": {
"$ref": "Status",
"description": "The error code and message."
}
},
"type": "object"
},
"ChatClientDataSourceMarkup": {
"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):",
"id": "ChatClientDataSourceMarkup",
"properties": {
"spaceDataSource": {
"$ref": "SpaceDataSource",
"description": "Google Chat spaces that the user is a member of."
}
},
"type": "object"
},
"ChatSpaceLinkData": {
"description": "Data for Chat space links.",
"id": "ChatSpaceLinkData",
"properties": {
"message": {
"description": "The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`",
"type": "string"
},
"space": {
"description": "The space of the linked Chat space resource. Format: `spaces/{space}`",
"type": "string"
},
"thread": {
"description": "The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`",
"type": "string"
}
},
"type": "object"
},
"Color": {
"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\u2014for 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(''); }; // ...",
"id": "Color",
"properties": {
"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).",
"format": "float",
"type": "number"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CommonEventObject": {
"description": "The common event object is the portion of the overall event object that carries general, host-independent information to the add-on from the user's client. This information includes details such as the user's locale, host app, and platform. In addition to homepage and contextual triggers, add-ons construct and pass event objects to [action callback functions](https://developers.google.com/workspace/add-ons/concepts/actions#callback_functions) when the user interacts with widgets. Your add-on's callback function can query the common event object to determine the contents of open widgets in the user's client. For example, your add-on can locate the text a user has entered into a [TextInput](https://developers.google.com/apps-script/reference/card-service/text-input) widget in the `eventObject.commentEventObject.formInputs` object. For Chat apps, the name of the function that the user invoked when interacting with a widget.",
"id": "CommonEventObject",
"properties": {
"formInputs": {
"additionalProperties": {
"$ref": "Inputs"
},
"description": "A map containing the current values of the widgets in the displayed card. The map keys are the string IDs assigned with each widget. The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[\"\"]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[\"\"].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a text box): a list of strings (only one element). **Example**: for a text input widget with `employeeName` as its ID, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, checkbox groups): a list of strings. **Example**: for a multi-value widget with `participants` as its ID, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A date-time picker**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with an ID of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with an ID of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with an ID of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`.",
"type": "object"
},
"hostApp": {
"description": "Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT`",
"enum": [
"UNSPECIFIED_HOST_APP",
"GMAIL",
"CALENDAR",
"DRIVE",
"DEMO",
"DOCS",
"MEET",
"SHEETS",
"SLIDES",
"DRAWINGS",
"CHAT"
],
"enumDescriptions": [
"Google can't identify a host app.",
"The add-on launches from Gmail.",
"The add-on launches from Google Calendar.",
"The add-on launches from Google Drive.",
"Not used.",
"The add-on launches from Google Docs.",
"The add-on launches from Google Meet.",
"The add-on launches from Google Sheets.",
"The add-on launches from Google Slides.",
"The add-on launches from Google Drawings.",
"A Google Chat app."
],
"type": "string"
},
"invokedFunction": {
"description": "Name of the function to invoke. This field doesn't populate for Google Workspace Add-ons that extend Google Chat. Instead, to receive function data like identifiers, add-ons that extend Chat should use the `parameters` field. See [Build interactive interfaces for Chat apps](https://developers.google.com/workspace/add-ons/chat/build).",
"type": "string"
},
"parameters": {
"additionalProperties": {
"type": "string"
},
"description": "Any additional parameters you supply to an action using [`actionParameters`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter) or [`Action.setParameters()`](https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters). **Developer Preview:** For [add-ons that extend Google Chat](https://developers.google.com/workspace/add-ons/chat), to suggest items based on what the users type in multiselect menus, use the value of the `\"autocomplete_widget_query\"` key (`event.commonEventObject.parameters[\"autocomplete_widget_query\"]`). You can use this value to query a database and suggest selectable items to users as they type. For details, see [Collect and process information from Google Chat users](https://developers.google.com/workspace/add-ons/chat/collect-information).",
"type": "object"
},
"platform": {
"description": "The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.",
"enum": [
"UNKNOWN_PLATFORM",
"WEB",
"IOS",
"ANDROID"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"timeZone": {
"$ref": "TimeZone",
"description": "**Disabled by default.** The timezone ID and offset from Coordinated Universal Time (UTC). To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details. Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG)."
},
"userLocale": {
"description": "**Disabled by default.** The user's language and country/region identifier in the format of [ISO 639](https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-[ISO 3166](https://wikipedia.org/wiki/ISO_3166) country/region code. For example, `en-US`. To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details.",
"type": "string"
}
},
"type": "object"
},
"CompleteImportSpaceRequest": {
"description": "Request message for completing the import process for a space.",
"id": "CompleteImportSpaceRequest",
"properties": {},
"type": "object"
},
"CompleteImportSpaceResponse": {
"description": "Response message for completing the import process for a space.",
"id": "CompleteImportSpaceResponse",
"properties": {
"space": {
"$ref": "Space",
"description": "The import mode space."
}
},
"type": "object"
},
"CustomEmoji": {
"description": "Represents a [custom emoji](https://support.google.com/chat/answer/12800149).",
"id": "CustomEmoji",
"properties": {
"emojiName": {
"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:`",
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`",
"type": "string"
},
"payload": {
"$ref": "CustomEmojiPayload",
"description": "Optional. Input only. Payload data. Required when the custom emoji is created."
},
"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": {
"description": "Output only. Unique key for the custom emoji resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CustomEmojiMetadata": {
"description": "Annotation metadata for custom emoji.",
"id": "CustomEmojiMetadata",
"properties": {
"customEmoji": {
"$ref": "CustomEmoji",
"description": "The custom emoji."
}
},
"type": "object"
},
"CustomEmojiPayload": {
"description": "Payload data for the custom emoji.",
"id": "CustomEmojiPayload",
"properties": {
"fileContent": {
"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.",
"format": "byte",
"type": "string"
},
"filename": {
"description": "Required. Input only. The image file name. Supported file extensions: `.png`, `.jpg`, `.gif`.",
"type": "string"
}
},
"type": "object"
},
"DateInput": {
"description": "Date input values.",
"id": "DateInput",
"properties": {
"msSinceEpoch": {
"description": "Time since epoch time, in milliseconds.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DateTimeInput": {
"description": "Date and time input values.",
"id": "DateTimeInput",
"properties": {
"hasDate": {
"description": "Whether the `datetime` input includes a calendar date.",
"type": "boolean"
},
"hasTime": {
"description": "Whether the `datetime` input includes a timestamp.",
"type": "boolean"
},
"msSinceEpoch": {
"description": "Time since epoch time, in milliseconds.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DeletionMetadata": {
"description": "Information about a deleted message. A message is deleted when `delete_time` is set.",
"id": "DeletionMetadata",
"properties": {
"deletionType": {
"description": "Indicates who deleted the message.",
"enum": [
"DELETION_TYPE_UNSPECIFIED",
"CREATOR",
"SPACE_OWNER",
"ADMIN",
"APP_MESSAGE_EXPIRY",
"CREATOR_VIA_APP",
"SPACE_OWNER_VIA_APP",
"SPACE_MEMBER"
],
"enumDescriptions": [
"This value is unused.",
"User deleted their own message.",
"An owner or manager deleted the message.",
"A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.",
"A Chat app deleted its own message when it expired.",
"A Chat app deleted the message on behalf of the creator (using user authentication).",
"A Chat app deleted the message on behalf of a space manager (using user authentication).",
"A member of the space deleted the message. Users can delete messages sent by apps."
],
"type": "string"
}
},
"type": "object"
},
"DeprecatedEvent": {
"description": " A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). Note: This event is only used for [Chat interaction events](https://developers.google.com/workspace/chat/receive-respond-interactions). If your Chat app is built as a [Google Workspace add-on](https://developers.google.com/workspace/add-ons/chat/build), see [Chat event objects](https://developers.google.com/workspace/add-ons/concepts/event-objects#chat-event-object) in the add-ons documentation.",
"id": "DeprecatedEvent",
"properties": {
"action": {
"$ref": "FormAction",
"description": "For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data)."
},
"appCommandMetadata": {
"$ref": "AppCommandMetadata",
"description": "Metadata about a Chat app command."
},
"common": {
"$ref": "CommonEventObject",
"description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card."
},
"configCompleteRedirectUrl": {
"description": "This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).",
"type": "string"
},
"dialogEventType": {
"description": "The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.",
"enum": [
"TYPE_UNSPECIFIED",
"REQUEST_DIALOG",
"SUBMIT_DIALOG",
"CANCEL_DIALOG"
],
"enumDescriptions": [
"Default value. Unspecified.",
"A user opens a dialog.",
"A user clicks an interactive element of a dialog. For example, a user fills out information in a dialog and clicks a button to submit the information.",
"A user closes a dialog without submitting information. The Chat app only receives this interaction event when users click the close icon in the top right corner of the dialog. When the user closes the dialog by other means (such as refreshing the browser, clicking outside the dialog box, or pressing the escape key), no event is sent."
],
"type": "string"
},
"eventTime": {
"description": "The timestamp indicating when the interaction event occurred.",
"format": "google-datetime",
"type": "string"
},
"isDialogEvent": {
"description": "For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).",
"type": "boolean"
},
"message": {
"$ref": "Message",
"description": "For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable."
},
"space": {
"$ref": "Space",
"description": "The space in which the user interacted with the Chat app."
},
"thread": {
"$ref": "Thread",
"description": "The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread."
},
"threadKey": {
"description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.",
"type": "string"
},
"token": {
"description": "A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).",
"type": "string"
},
"type": {
"description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.",
"enum": [
"UNSPECIFIED",
"MESSAGE",
"ADDED_TO_SPACE",
"REMOVED_FROM_SPACE",
"CARD_CLICKED",
"WIDGET_UPDATED",
"APP_COMMAND"
],
"enumDescriptions": [
"Default value for the enum. DO NOT USE.",
"A user sends the Chat app a message, or invokes the Chat app in a space. Examples of message events include: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its [slash commands](https://developers.google.com/workspace/chat/commands#types). * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.",
"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).",
"A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.",
"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).",
"A user updates a widget in a card message or dialog. This event is triggered when a user interacts with a widget that has an associated action.",
"A user uses a Chat app [command](https://developers.google.com/workspace/chat/commands#types), including slash commands and quick commands."
],
"type": "string"
},
"user": {
"$ref": "User",
"description": "The user that interacted with the Chat app."
}
},
"type": "object"
},
"Dialog": {
"description": "Wrapper around the card body of the dialog.",
"id": "Dialog",
"properties": {
"body": {
"$ref": "GoogleAppsCardV1Card",
"description": "Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: `DateTimePicker`, `OnChangeAction`."
}
},
"type": "object"
},
"DialogAction": {
"description": "Contains a [dialog](https://developers.google.com/workspace/chat/dialogs) and request status code.",
"id": "DialogAction",
"properties": {
"actionStatus": {
"$ref": "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": "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.",
"id": "DriveDataRef",
"properties": {
"driveFileId": {
"description": "The ID for the drive file. Use with the Drive API.",
"type": "string"
}
},
"type": "object"
},
"DriveLinkData": {
"description": "Data for Google Drive links.",
"id": "DriveLinkData",
"properties": {
"driveDataRef": {
"$ref": "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"
},
"Emoji": {
"description": "An emoji that is used as a reaction to a message.",
"id": "Emoji",
"properties": {
"customEmoji": {
"$ref": "CustomEmoji",
"description": "A custom emoji."
},
"unicode": {
"description": "Optional. A basic emoji represented by a unicode string.",
"type": "string"
}
},
"type": "object"
},
"EmojiReactionSummary": {
"description": "The number of people who reacted to a message with a specific emoji.",
"id": "EmojiReactionSummary",
"properties": {
"emoji": {
"$ref": "Emoji",
"description": "Output only. Emoji associated with the reactions.",
"readOnly": true
},
"reactionCount": {
"description": "Output only. The total number of reactions using the associated emoji.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"FindGroupChatsResponse": {
"description": "A response containing group chat spaces with exactly the calling user and the requested users.",
"id": "FindGroupChatsResponse",
"properties": {
"nextPageToken": {
"description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
"type": "string"
},
"spaces": {
"description": "List of spaces in the requested (or first) page.",
"items": {
"$ref": "Space"
},
"type": "array"
}
},
"type": "object"
},
"FormAction": {
"description": "A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.",
"id": "FormAction",
"properties": {
"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"
},
"parameters": {
"description": "List of action parameters.",
"items": {
"$ref": "ActionParameter"
},
"type": "array"
}
},
"type": "object"
},
"ForwardedMetadata": {
"description": "Metadata about the source space from which a message was forwarded.",
"id": "ForwardedMetadata",
"properties": {
"space": {
"description": "Output only. The resource name of the source space. Format: spaces/{space}",
"readOnly": true,
"type": "string"
},
"spaceDisplayName": {
"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\").",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Action": {
"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):",
"id": "GoogleAppsCardV1Action",
"properties": {
"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"
},
"function": {
"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).",
"type": "string"
},
"interaction": {
"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`\u2014like opening a link or running a function\u2014as 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):",
"enum": [
"INTERACTION_UNSPECIFIED",
"OPEN_DIALOG"
],
"enumDescriptions": [
"Default value. The `action` executes as normal.",
"Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a windowed, card-based interface that Chat apps use to interact with users. Only supported by Chat apps in response to button-clicks on card messages. 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):"
],
"type": "string"
},
"loadIndicator": {
"description": "Specifies the loading indicator that the action displays while making the call to the action.",
"enum": [
"SPINNER",
"NONE"
],
"enumDescriptions": [
"Displays a spinner to indicate that content is loading.",
"Nothing is displayed."
],
"type": "string"
},
"parameters": {
"description": "List of action parameters.",
"items": {
"$ref": "GoogleAppsCardV1ActionParameter"
},
"type": "array"
},
"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"
},
"requiredWidgets": {
"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"
},
"type": "array"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1ActionParameter",
"properties": {
"key": {
"description": "The name of the parameter for the action script.",
"type": "string"
},
"value": {
"description": "The value of the parameter.",
"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):",
"id": "GoogleAppsCardV1BorderStyle",
"properties": {
"cornerRadius": {
"description": "The corner radius for the border.",
"format": "int32",
"type": "integer"
},
"strokeColor": {
"$ref": "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": {
"description": "The border type.",
"enum": [
"BORDER_TYPE_UNSPECIFIED",
"NO_BORDER",
"STROKE"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"No border.",
"Default value. Outline."
],
"type": "string"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1Button",
"properties": {
"altText": {
"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\".",
"type": "string"
},
"color": {
"$ref": "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."
},
"disabled": {
"description": "If `true`, the button is displayed in an inactive state and doesn't respond to user actions.",
"type": "boolean"
},
"icon": {
"$ref": "GoogleAppsCardV1Icon",
"description": "An icon displayed inside the button. If both `icon` and `text` are set, then the icon appears before the text."
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function."
},
"text": {
"description": "The text displayed inside the button.",
"type": "string"
},
"type": {
"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"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Outlined buttons are medium-emphasis buttons. They usually contain actions that are important, but aren\u2019t the primary action in a Chat app or an add-on.",
"A filled button has a container with a solid color. It has the most visual impact and is recommended for the important and primary action in a Chat app or an add-on.",
"A filled tonal button is an alternative middle ground between filled and outlined buttons. They\u2019re useful in contexts where a lower-priority button requires slightly more emphasis than an outline button would give.",
"A button does not have an invisible container in its default state. It is often used for the lowest priority actions, especially when presenting multiple options."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1ButtonList": {
"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):",
"id": "GoogleAppsCardV1ButtonList",
"properties": {
"buttons": {
"description": "An array of buttons.",
"items": {
"$ref": "GoogleAppsCardV1Button"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1Card": {
"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\" } ] } } } ] } } ] } ] } } ] } ```",
"id": "GoogleAppsCardV1Card",
"properties": {
"cardActions": {
"description": "The card's actions. Actions are added to the card's toolbar menu. [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: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```",
"items": {
"$ref": "GoogleAppsCardV1CardAction"
},
"type": "array"
},
"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):",
"enum": [
"DISPLAY_STYLE_UNSPECIFIED",
"PEEK",
"REPLACE"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.",
"Default value. The card is shown by replacing the view of the top card in the card stack."
],
"type": "string"
},
"expressionData": {
"description": "The expression data for the card. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.",
"items": {
"$ref": "GoogleAppsCardV1ExpressionData"
},
"type": "array"
},
"fixedFooter": {
"$ref": "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):"
},
"header": {
"$ref": "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."
},
"name": {
"description": "Name of the card. Used as a card identifier in card navigation. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):",
"type": "string"
},
"peekCardHeader": {
"$ref": "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):"
},
"sectionDividerStyle": {
"description": "The divider style between the header, sections and footer.",
"enum": [
"DIVIDER_STYLE_UNSPECIFIED",
"SOLID_DIVIDER",
"NO_DIVIDER"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default option. Render a solid divider.",
"If set, no divider is rendered. This style completely removes the divider from the layout. The result is equivalent to not adding a divider at all."
],
"type": "string"
},
"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).",
"items": {
"$ref": "GoogleAppsCardV1Section"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1CardAction": {
"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):",
"id": "GoogleAppsCardV1CardAction",
"properties": {
"actionLabel": {
"description": "The label that displays as the action menu item.",
"type": "string"
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "The `onClick` action for this action item."
}
},
"type": "object"
},
"GoogleAppsCardV1CardFixedFooter": {
"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):",
"id": "GoogleAppsCardV1CardFixedFooter",
"properties": {
"primaryButton": {
"$ref": "GoogleAppsCardV1Button",
"description": "The primary button of the fixed footer. The button must be a text button with text and color set."
},
"secondaryButton": {
"$ref": "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`."
}
},
"type": "object"
},
"GoogleAppsCardV1CardHeader": {
"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):",
"id": "GoogleAppsCardV1CardHeader",
"properties": {
"imageAltText": {
"description": "The alternative text of this image that's used for accessibility.",
"type": "string"
},
"imageType": {
"description": "The shape used to crop the image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"enum": [
"SQUARE",
"CIRCLE"
],
"enumDescriptions": [
"Default value. Applies a square mask to the image. For example, a 4x3 image becomes 3x3.",
"Applies a circular mask to the image. For example, a 4x3 image becomes a circle with a diameter of 3."
],
"type": "string"
},
"imageUrl": {
"description": "The HTTPS URL of the image in the card header.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleAppsCardV1Carousel": {
"description": "A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. 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):",
"id": "GoogleAppsCardV1Carousel",
"properties": {
"carouselCards": {
"description": "A list of cards included in the carousel.",
"items": {
"$ref": "GoogleAppsCardV1CarouselCard"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1CarouselCard": {
"description": "A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):",
"id": "GoogleAppsCardV1CarouselCard",
"properties": {
"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.",
"items": {
"$ref": "GoogleAppsCardV1NestedWidget"
},
"type": "array"
},
"widgets": {
"description": "A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified.",
"items": {
"$ref": "GoogleAppsCardV1NestedWidget"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1Chip": {
"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):",
"id": "GoogleAppsCardV1Chip",
"properties": {
"altText": {
"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\".",
"type": "string"
},
"disabled": {
"description": "Whether the chip is in an inactive state and ignores user actions. Defaults to `false`.",
"type": "boolean"
},
"enabled": {
"deprecated": true,
"description": "Whether the chip is in an active state and responds to user actions. Defaults to `true`. Deprecated. Use `disabled` instead.",
"type": "boolean"
},
"icon": {
"$ref": "GoogleAppsCardV1Icon",
"description": "The icon image. If both `icon` and `text` are set, then the icon appears before the text."
},
"label": {
"description": "The text displayed inside the chip.",
"type": "string"
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function."
}
},
"type": "object"
},
"GoogleAppsCardV1ChipList": {
"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):",
"id": "GoogleAppsCardV1ChipList",
"properties": {
"chips": {
"description": "An array of chips.",
"items": {
"$ref": "GoogleAppsCardV1Chip"
},
"type": "array"
},
"layout": {
"description": "Specified chip list layout.",
"enum": [
"LAYOUT_UNSPECIFIED",
"WRAPPED",
"HORIZONTAL_SCROLLABLE"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. The chip list wraps to the next line if there isn't enough horizontal space.",
"The chips scroll horizontally if they don't fit in the available space."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1CollapseControl": {
"description": "Represent an expand and collapse control. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"id": "GoogleAppsCardV1CollapseControl",
"properties": {
"collapseButton": {
"$ref": "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": "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."
},
"horizontalAlignment": {
"description": "The horizontal alignment of the expand and collapse button.",
"enum": [
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
"START",
"CENTER",
"END"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.",
"Aligns widgets to the center of the column.",
"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Column": {
"description": "A column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)",
"id": "GoogleAppsCardV1Column",
"properties": {
"horizontalAlignment": {
"description": "Specifies whether widgets align to the left, right, or center of a column.",
"enum": [
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
"START",
"CENTER",
"END"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.",
"Aligns widgets to the center of the column.",
"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left."
],
"type": "string"
},
"horizontalSizeStyle": {
"description": "Specifies how a column fills the width of the card.",
"enum": [
"HORIZONTAL_SIZE_STYLE_UNSPECIFIED",
"FILL_AVAILABLE_SPACE",
"FILL_MINIMUM_SPACE"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Column fills the available space, up to 70% of the card's width. If both columns are set to `FILL_AVAILABLE_SPACE`, each column fills 50% of the space.",
"Column fills the least amount of space possible and no more than 30% of the card's width."
],
"type": "string"
},
"verticalAlignment": {
"description": "Specifies whether widgets align to the top, bottom, or center of a column.",
"enum": [
"VERTICAL_ALIGNMENT_UNSPECIFIED",
"CENTER",
"TOP",
"BOTTOM"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Aligns widgets to the center of a column.",
"Aligns widgets to the top of a column.",
"Aligns widgets to the bottom of a column."
],
"type": "string"
},
"widgets": {
"description": "An array of widgets included in a column. Widgets appear in the order that they are specified.",
"items": {
"$ref": "GoogleAppsCardV1Widgets"
},
"type": "array"
}
},
"type": "object"
},
"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.",
"id": "GoogleAppsCardV1Columns",
"properties": {
"columnItems": {
"description": "An array of columns. You can include up to 2 columns in a card or dialog.",
"items": {
"$ref": "GoogleAppsCardV1Column"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1CommonWidgetAction": {
"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.",
"id": "GoogleAppsCardV1CommonWidgetAction",
"properties": {
"updateVisibilityAction": {
"$ref": "GoogleAppsCardV1UpdateVisibilityAction",
"description": "The action to update the visibility of a widget."
}
},
"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.",
"id": "GoogleAppsCardV1Condition",
"properties": {
"actionRuleId": {
"description": "The unique identifier of the ActionRule.",
"type": "string"
},
"expressionDataCondition": {
"$ref": "GoogleAppsCardV1ExpressionDataCondition",
"description": "The condition that is determined by the expression data."
}
},
"type": "object"
},
"GoogleAppsCardV1DataSourceConfig": {
"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.",
"id": "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": "GoogleAppsCardV1PlatformDataSource",
"description": "The data is from a Google Workspace application."
},
"remoteDataSource": {
"$ref": "GoogleAppsCardV1Action",
"description": "The data is from a remote data provider."
}
},
"type": "object"
},
"GoogleAppsCardV1DateTimePicker": {
"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):",
"id": "GoogleAppsCardV1DateTimePicker",
"properties": {
"hostAppDataSource": {
"$ref": "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": {
"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`.",
"type": "string"
},
"name": {
"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).",
"type": "string"
},
"onChangeAction": {
"$ref": "GoogleAppsCardV1Action",
"description": "Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface."
},
"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.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Whether the widget supports inputting a date, a time, or the date and time.",
"enum": [
"DATE_AND_TIME",
"DATE_ONLY",
"TIME_ONLY"
],
"enumDescriptions": [
"Users input a date and time.",
"Users input a date.",
"Users input a time."
],
"type": "string"
},
"valueMsEpoch": {
"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`).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1DecoratedText": {
"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):",
"id": "GoogleAppsCardV1DecoratedText",
"properties": {
"bottomLabel": {
"description": "The text that appears below `text`. Always wraps.",
"type": "string"
},
"bottomLabelText": {
"$ref": "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):"
},
"button": {
"$ref": "GoogleAppsCardV1Button",
"description": "A button that a user can click to trigger an action."
},
"contentText": {
"$ref": "GoogleAppsCardV1TextParagraph",
"description": "`TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):"
},
"endIcon": {
"$ref": "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."
},
"icon": {
"$ref": "GoogleAppsCardV1Icon",
"deprecated": true,
"description": "Deprecated in favor of `startIcon`."
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "This action is triggered when users click `topLabel` or `bottomLabel`."
},
"startIcon": {
"$ref": "GoogleAppsCardV1Icon",
"description": "The icon displayed in front of the text."
},
"startIconVerticalAlignment": {
"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"
],
"enumDescriptions": [
"Unspecified type. Do not use.",
"Alignment to the top position.",
"Alignment to the middle position.",
"Alignment to the bottom position."
],
"type": "string"
},
"switchControl": {
"$ref": "GoogleAppsCardV1SwitchControl",
"description": "A switch widget that a user can click to change its state and trigger an action."
},
"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"
},
"topLabel": {
"description": "The text that appears above `text`. Always truncates.",
"type": "string"
},
"topLabelText": {
"$ref": "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):"
},
"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"
}
},
"type": "object"
},
"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\": {} ```",
"id": "GoogleAppsCardV1Divider",
"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.",
"id": "GoogleAppsCardV1EventAction",
"properties": {
"actionRuleId": {
"description": "The unique identifier of the ActionRule.",
"type": "string"
},
"commonWidgetAction": {
"$ref": "GoogleAppsCardV1CommonWidgetAction",
"description": "Common widget action."
},
"postEventTriggers": {
"description": "The list of triggers that will be triggered after the EventAction is executed.",
"items": {
"$ref": "GoogleAppsCardV1Trigger"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1ExpressionData": {
"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.",
"id": "GoogleAppsCardV1ExpressionData",
"properties": {
"conditions": {
"description": "The list of conditions that are determined by the expression evaluation result.",
"items": {
"$ref": "GoogleAppsCardV1Condition"
},
"type": "array"
},
"eventActions": {
"description": "The list of actions that the ExpressionData can be used.",
"items": {
"$ref": "GoogleAppsCardV1EventAction"
},
"type": "array"
},
"expression": {
"description": "The uncompiled expression.",
"type": "string"
},
"id": {
"description": "The unique identifier of the ExpressionData.",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "GoogleAppsCardV1ExpressionDataCondition",
"properties": {
"conditionType": {
"description": "The type of the condition.",
"enum": [
"CONDITION_TYPE_UNSPECIFIED",
"EXPRESSION_EVALUATION_SUCCESS",
"EXPRESSION_EVALUATION_FAILURE"
],
"enumDescriptions": [
"Unspecified condition type.",
"The expression evaluation was successful.",
"The expression evaluation was unsuccessful."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Grid": {
"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\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```",
"id": "GoogleAppsCardV1Grid",
"properties": {
"borderStyle": {
"$ref": "GoogleAppsCardV1BorderStyle",
"description": "The border style to apply to each grid item."
},
"columnCount": {
"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).",
"format": "int32",
"type": "integer"
},
"items": {
"description": "The items to display in the grid.",
"items": {
"$ref": "GoogleAppsCardV1GridItem"
},
"type": "array"
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters."
},
"title": {
"description": "The text that displays in the grid header.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1GridItem": {
"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):",
"id": "GoogleAppsCardV1GridItem",
"properties": {
"id": {
"description": "A user-specified identifier for this grid item. This identifier is returned in the parent grid's `onClick` callback parameters.",
"type": "string"
},
"image": {
"$ref": "GoogleAppsCardV1ImageComponent",
"description": "The image that displays in the grid item."
},
"layout": {
"description": "The layout to use for the grid item.",
"enum": [
"GRID_ITEM_LAYOUT_UNSPECIFIED",
"TEXT_BELOW",
"TEXT_ABOVE"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"The title and subtitle are shown below the grid item's image.",
"The title and subtitle are shown above the grid item's image."
],
"type": "string"
},
"subtitle": {
"description": "The grid item's subtitle.",
"type": "string"
},
"title": {
"description": "The grid item's title.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Icon": {
"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):",
"id": "GoogleAppsCardV1Icon",
"properties": {
"altText": {
"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.",
"type": "string"
},
"iconUrl": {
"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`.",
"type": "string"
},
"imageType": {
"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"
],
"enumDescriptions": [
"Default value. Applies a square mask to the image. For example, a 4x3 image becomes 3x3.",
"Applies a circular mask to the image. For example, a 4x3 image becomes a circle with a diameter of 3."
],
"type": "string"
},
"knownIcon": {
"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).",
"type": "string"
},
"materialIcon": {
"$ref": "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 ``` \"material_icon\": { \"name\": \"check_box\" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1Image",
"properties": {
"altText": {
"description": "The alternative text of this image that's used for accessibility.",
"type": "string"
},
"imageUrl": {
"description": "The HTTPS URL that hosts the image. For example: ``` https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ```",
"type": "string"
},
"onClick": {
"$ref": "GoogleAppsCardV1OnClick",
"description": "When a user clicks the image, the click triggers this action."
}
},
"type": "object"
},
"GoogleAppsCardV1ImageComponent": {
"description": "Represents an image. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"id": "GoogleAppsCardV1ImageComponent",
"properties": {
"altText": {
"description": "The accessibility label for the image.",
"type": "string"
},
"borderStyle": {
"$ref": "GoogleAppsCardV1BorderStyle",
"description": "The border style to apply to the image."
},
"cropStyle": {
"$ref": "GoogleAppsCardV1ImageCropStyle",
"description": "The crop style to apply to the image."
},
"imageUri": {
"description": "The image URL.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1ImageCropStyle": {
"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 } ```",
"id": "GoogleAppsCardV1ImageCropStyle",
"properties": {
"aspectRatio": {
"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 } ```",
"format": "double",
"type": "number"
},
"type": {
"description": "The crop type.",
"enum": [
"IMAGE_CROP_TYPE_UNSPECIFIED",
"SQUARE",
"CIRCLE",
"RECTANGLE_CUSTOM",
"RECTANGLE_4_3"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Applies a square crop.",
"Applies a circular crop.",
"Applies a rectangular crop with a custom aspect ratio. Set the custom aspect ratio with `aspectRatio`.",
"Applies a rectangular crop with a 4:3 aspect ratio."
],
"type": "string"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1MaterialIcon",
"properties": {
"fill": {
"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": "boolean"
},
"grade": {
"description": "Weight and grade affect a symbol\u2019s 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**.",
"format": "int32",
"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"
},
"weight": {
"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**.",
"format": "int32",
"type": "integer"
}
},
"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):",
"id": "GoogleAppsCardV1NestedWidget",
"properties": {
"buttonList": {
"$ref": "GoogleAppsCardV1ButtonList",
"description": "A button list widget."
},
"image": {
"$ref": "GoogleAppsCardV1Image",
"description": "An image widget."
},
"textParagraph": {
"$ref": "GoogleAppsCardV1TextParagraph",
"description": "A text paragraph widget."
}
},
"type": "object"
},
"GoogleAppsCardV1OnClick": {
"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):",
"id": "GoogleAppsCardV1OnClick",
"properties": {
"action": {
"$ref": "GoogleAppsCardV1Action",
"description": "If specified, an action is triggered by this `onClick`."
},
"card": {
"$ref": "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):"
},
"openDynamicLinkAction": {
"$ref": "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):"
},
"openLink": {
"$ref": "GoogleAppsCardV1OpenLink",
"description": "If specified, this `onClick` triggers an open link action."
},
"overflowMenu": {
"$ref": "GoogleAppsCardV1OverflowMenu",
"description": "If specified, this `onClick` opens an overflow menu."
}
},
"type": "object"
},
"GoogleAppsCardV1OpenLink": {
"description": "Represents an `onClick` event that opens a hyperlink. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"id": "GoogleAppsCardV1OpenLink",
"properties": {
"onClose": {
"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):",
"enum": [
"NOTHING",
"RELOAD"
],
"enumDescriptions": [
"Default value. The card doesn't reload; nothing happens.",
"Reloads the card after the child window closes. If used in conjunction with [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and the parent card is blocked until the child window closes."
],
"type": "string"
},
"openAs": {
"description": "How to open a link. [Google Workspace add-ons](https://developers.google.com/workspace/add-ons):",
"enum": [
"FULL_SIZE",
"OVERLAY"
],
"enumDescriptions": [
"The link opens as a full-size window (if that's the frame used by the client).",
"The link opens as an overlay, such as a pop-up."
],
"type": "string"
},
"url": {
"description": "The URL to open. HTTP URLs are converted to HTTPS.",
"type": "string"
}
},
"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):",
"id": "GoogleAppsCardV1OverflowMenu",
"properties": {
"items": {
"description": "Required. The list of menu options.",
"items": {
"$ref": "GoogleAppsCardV1OverflowMenuItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1OverflowMenuItem": {
"description": "An option that users can invoke in an overflow menu. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"id": "GoogleAppsCardV1OverflowMenuItem",
"properties": {
"disabled": {
"description": "Whether the menu option is disabled. Defaults to false.",
"type": "boolean"
},
"onClick": {
"$ref": "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": "GoogleAppsCardV1Icon",
"description": "The icon displayed in front of the text."
},
"text": {
"description": "Required. The text that identifies or describes the item to users.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1PlatformDataSource": {
"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):",
"id": "GoogleAppsCardV1PlatformDataSource",
"properties": {
"commonDataSource": {
"description": "A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.",
"enum": [
"UNKNOWN",
"USER"
],
"enumDescriptions": [
"Default value. Don't use.",
"Google Workspace users. The user can only view and select users from their Google Workspace organization."
],
"type": "string"
},
"hostAppDataSource": {
"$ref": "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)."
}
},
"type": "object"
},
"GoogleAppsCardV1Section": {
"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):",
"id": "GoogleAppsCardV1Section",
"properties": {
"collapseControl": {
"$ref": "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."
},
"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"
},
"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"
},
"id": {
"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.",
"type": "string"
},
"uncollapsibleWidgetsCount": {
"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",
"type": "integer"
},
"widgets": {
"description": "All the widgets in the section. Must contain at least one widget.",
"items": {
"$ref": "GoogleAppsCardV1Widget"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1SelectionInput": {
"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):",
"id": "GoogleAppsCardV1SelectionInput",
"properties": {
"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": "GoogleAppsCardV1DataSourceConfig"
},
"type": "array"
},
"externalDataSource": {
"$ref": "GoogleAppsCardV1Action",
"description": "An external data source, such as a relational database."
},
"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"
},
"items": {
"description": "An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.",
"items": {
"$ref": "GoogleAppsCardV1SelectionItem"
},
"type": "array"
},
"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": {
"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.",
"format": "int32",
"type": "integer"
},
"multiSelectMinQueryLength": {
"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.",
"format": "int32",
"type": "integer"
},
"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"
},
"onChangeAction": {
"$ref": "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)."
},
"platformDataSource": {
"$ref": "GoogleAppsCardV1PlatformDataSource",
"description": "A data source from Google Workspace."
},
"type": {
"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.",
"enum": [
"CHECK_BOX",
"RADIO_BUTTON",
"SWITCH",
"DROPDOWN",
"MULTI_SELECT"
],
"enumDescriptions": [
"A set of checkboxes. Users can select one or more checkboxes.",
"A set of radio buttons. Users can select one radio button.",
"A set of switches. Users can turn on one or more switches.",
"A dropdown menu. Users can select one item from the menu. For Google Chat apps, you can populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a dropdown menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement dropdown menus for Chat apps, see [Add a dropdown menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dropdown-menu) and [Dynamically populate drop-down menus](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dynamic-dropdown-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"A menu with a text box. Users can type and select one or more items. For Google Workspace add-ons, you must populate items using a static array of `SelectionItem` objects. For Google Chat apps, you can also populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a multiselect menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus for Chat apps, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):"
],
"type": "string"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1SelectionItem",
"properties": {
"bottomText": {
"description": "For multiselect menus, a text description or label that's displayed below the item's `text` field.",
"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"
},
"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"
}
},
"type": "object"
},
"GoogleAppsCardV1SuggestionItem": {
"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):",
"id": "GoogleAppsCardV1SuggestionItem",
"properties": {
"text": {
"description": "The value of a suggested input to a text input field. This is equivalent to what users enter themselves.",
"type": "string"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1Suggestions",
"properties": {
"items": {
"description": "A list of suggestions used for autocomplete recommendations in text input fields.",
"items": {
"$ref": "GoogleAppsCardV1SuggestionItem"
},
"type": "array"
}
},
"type": "object"
},
"GoogleAppsCardV1SwitchControl": {
"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.",
"id": "GoogleAppsCardV1SwitchControl",
"properties": {
"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"
],
"enumDescriptions": [
"A toggle-style switch.",
"Deprecated in favor of `CHECK_BOX`.",
"A checkbox."
],
"type": "string"
},
"name": {
"description": "The name by which the switch widget 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": "GoogleAppsCardV1Action",
"description": "The action to perform when the switch state is changed, such as what function to run."
},
"selected": {
"description": "When `true`, the switch is selected.",
"type": "boolean"
},
"value": {
"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).",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1TextInput": {
"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):",
"id": "GoogleAppsCardV1TextInput",
"properties": {
"autoCompleteAction": {
"$ref": "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):"
},
"hintText": {
"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.",
"type": "string"
},
"hostAppDataSource": {
"$ref": "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."
},
"initialSuggestions": {
"$ref": "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):"
},
"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"
},
"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": "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."
},
"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"
},
"type": {
"description": "How a text input field appears in the user interface. For example, whether the field is single or multi-line.",
"enum": [
"SINGLE_LINE",
"MULTIPLE_LINE"
],
"enumDescriptions": [
"The text input field has a fixed height of one line.",
"The text input field has a fixed height of multiple lines."
],
"type": "string"
},
"validation": {
"$ref": "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": {
"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).",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1TextParagraph": {
"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):",
"id": "GoogleAppsCardV1TextParagraph",
"properties": {
"maxLines": {
"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.",
"format": "int32",
"type": "integer"
},
"text": {
"description": "The text that's shown in the widget.",
"type": "string"
},
"textSyntax": {
"description": "The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):",
"enum": [
"TEXT_SYNTAX_UNSPECIFIED",
"HTML",
"MARKDOWN"
],
"enumDescriptions": [
"The text is rendered as HTML if unspecified.",
"The text is rendered as HTML. This is the default value.",
"The text is rendered as Markdown."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Trigger": {
"description": "Represents a trigger. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.",
"id": "GoogleAppsCardV1Trigger",
"properties": {
"actionRuleId": {
"description": "The unique identifier of the ActionRule.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1UpdateVisibilityAction": {
"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.",
"id": "GoogleAppsCardV1UpdateVisibilityAction",
"properties": {
"visibility": {
"description": "The new visibility.",
"enum": [
"VISIBILITY_UNSPECIFIED",
"VISIBLE",
"HIDDEN"
],
"enumDescriptions": [
"Unspecified visibility. Do not use.",
"The UI element is visible.",
"The UI element is hidden."
],
"type": "string"
}
},
"type": "object"
},
"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):",
"id": "GoogleAppsCardV1Validation",
"properties": {
"characterLimit": {
"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):",
"format": "int32",
"type": "integer"
},
"inputType": {
"description": "Specify the type of the input widgets. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"enum": [
"INPUT_TYPE_UNSPECIFIED",
"TEXT",
"INTEGER",
"FLOAT",
"EMAIL",
"EMOJI_PICKER"
],
"enumDescriptions": [
"Unspecified type. Do not use.",
"Regular text that accepts all characters.",
"An integer value.",
"A float value.",
"An email address.",
"A emoji selected from system-provided emoji picker."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Widget": {
"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.",
"id": "GoogleAppsCardV1Widget",
"properties": {
"buttonList": {
"$ref": "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\" } } } ] } ```"
},
"carousel": {
"$ref": "GoogleAppsCardV1Carousel",
"description": "A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in the carousel.\" } }, { \"textParagraph\": { \"text\": \"Second text paragraph in the carousel.\" } } ] } ```"
},
"chipList": {
"$ref": "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\": [ { \"text\": \"Edit\", \"disabled\": true, }, { \"icon\": { \"knownIcon\": \"INVITE\", \"altText\": \"check calendar\" }, \"onClick\": { \"openLink\": { \"url\": \"https://example.com/calendar\" } } } ] } ```"
},
"columns": {
"$ref": "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\" } } ] } ] } ```"
},
"dateTimePicker": {
"$ref": "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 } ```"
},
"decoratedText": {
"$ref": "GoogleAppsCardV1DecoratedText",
"description": "Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` \"decoratedText\": { \"icon\": { \"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\": \"CHECKBOX\" } } ```"
},
"divider": {
"$ref": "GoogleAppsCardV1Divider",
"description": "Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` \"divider\": { } ```"
},
"eventActions": {
"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.",
"items": {
"$ref": "GoogleAppsCardV1EventAction"
},
"type": "array"
},
"grid": {
"$ref": "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\", \"textAlignment\": \"CENTER\" } ], \"onClick\": { \"openLink\": { \"url\": \"https://www.example.com\" } } } ```"
},
"horizontalAlignment": {
"description": "Specifies whether widgets align to the left, right, or center of a column.",
"enum": [
"HORIZONTAL_ALIGNMENT_UNSPECIFIED",
"START",
"CENTER",
"END"
],
"enumDescriptions": [
"Don't use. Unspecified.",
"Default value. Aligns widgets to the start position of the column. For left-to-right layouts, aligns to the left. For right-to-left layouts, aligns to the right.",
"Aligns widgets to the center of the column.",
"Aligns widgets to the end position of the column. For left-to-right layouts, aligns widgets to the right. For right-to-left layouts, aligns widgets to the left."
],
"type": "string"
},
"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"
},
"image": {
"$ref": "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\" } ```"
},
"selectionInput": {
"$ref": "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 } ] } ```"
},
"textInput": {
"$ref": "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\" } ] } } ```"
},
"textParagraph": {
"$ref": "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*\" } ```"
},
"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"
],
"enumDescriptions": [
"Unspecified visibility. Do not use.",
"The UI element is visible.",
"The UI element is hidden."
],
"type": "string"
}
},
"type": "object"
},
"GoogleAppsCardV1Widgets": {
"description": "The supported widgets that you can include in a column. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend)",
"id": "GoogleAppsCardV1Widgets",
"properties": {
"buttonList": {
"$ref": "GoogleAppsCardV1ButtonList",
"description": "ButtonList widget."
},
"chipList": {
"$ref": "GoogleAppsCardV1ChipList",
"description": "ChipList widget."
},
"dateTimePicker": {
"$ref": "GoogleAppsCardV1DateTimePicker",
"description": "DateTimePicker widget."
},
"decoratedText": {
"$ref": "GoogleAppsCardV1DecoratedText",
"description": "DecoratedText widget."
},
"image": {
"$ref": "GoogleAppsCardV1Image",
"description": "Image widget."
},
"selectionInput": {
"$ref": "GoogleAppsCardV1SelectionInput",
"description": "SelectionInput widget."
},
"textInput": {
"$ref": "GoogleAppsCardV1TextInput",
"description": "TextInput widget."
},
"textParagraph": {
"$ref": "GoogleAppsCardV1TextParagraph",
"description": "TextParagraph widget."
}
},
"type": "object"
},
"GoogleChatV1Section": {
"description": "Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.",
"id": "GoogleChatV1Section",
"properties": {
"displayName": {
"description": "Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.",
"type": "string"
},
"name": {
"description": "Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`",
"type": "string"
},
"sortOrder": {
"description": "Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Required. The type of the section.",
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"CUSTOM_SECTION",
"DEFAULT_DIRECT_MESSAGES",
"DEFAULT_SPACES",
"DEFAULT_APPS"
],
"enumDescriptions": [
"Unspecified section type.",
"Custom section.",
"Default section containing [DIRECT_MESSAGE](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype) between two human users or [GROUP_CHAT](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#spacetype) spaces that don't belong to any custom section.",
"Default spaces that don't belong to any custom section.",
"Default section containing a user's installed apps."
],
"type": "string"
}
},
"type": "object"
},
"Group": {
"description": "A Google Group in Google Chat.",
"id": "Group",
"properties": {
"name": {
"description": "Resource name for a Google Group. Represents a [group](https://cloud.google.com/identity/docs/reference/rest/v1/groups) in Cloud Identity Groups API. Format: groups/{group}",
"type": "string"
}
},
"type": "object"
},
"HostAppDataSourceMarkup": {
"description": "A data source from a Google Workspace application. The data source populates available items for a widget.",
"id": "HostAppDataSourceMarkup",
"properties": {
"chatDataSource": {
"$ref": "ChatClientDataSourceMarkup",
"description": "A data source from Google Chat."
},
"workflowDataSource": {
"$ref": "WorkflowDataSourceMarkup",
"description": "A data source from Google Workflow."
}
},
"type": "object"
},
"Image": {
"description": "An image that's specified by a URL and can have an `onclick` action.",
"id": "Image",
"properties": {
"aspectRatio": {
"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",
"type": "number"
},
"imageUrl": {
"description": "The URL of the image.",
"type": "string"
},
"onClick": {
"$ref": "OnClick",
"description": "The `onclick` action."
}
},
"type": "object"
},
"ImageButton": {
"description": "An image button with an `onclick` action.",
"id": "ImageButton",
"properties": {
"icon": {
"description": "The icon specified by an `enum` that indices to an icon provided by Chat API.",
"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"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"iconUrl": {
"description": "The icon specified by a URL.",
"type": "string"
},
"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": "OnClick",
"description": "The `onclick` action."
}
},
"type": "object"
},
"Inputs": {
"description": "Types of data that users can [input on cards or dialogs](https://developers.google.com/chat/ui/read-form-data). The input type depends on the type of values that the widget accepts.",
"id": "Inputs",
"properties": {
"dateInput": {
"$ref": "DateInput",
"description": "Date input values from a [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker) widget that only accepts date values."
},
"dateTimeInput": {
"$ref": "DateTimeInput",
"description": "Date and time input values from a [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker) widget that accepts both a date and time."
},
"stringInputs": {
"$ref": "StringInputs",
"description": "A list of strings that represent the values that the user inputs in a widget. If the widget only accepts one value, such as a [`TextInput`](https://developers.google.com/chat/api/reference/rest/v1/cards#TextInput) widget, the list contains one string object. If the widget accepts multiple values, such as a [`SelectionInput`](https://developers.google.com/chat/api/reference/rest/v1/cards#selectioninput) widget of checkboxes, the list contains a string object for each value that the user inputs or selects."
},
"timeInput": {
"$ref": "TimeInput",
"description": "Time input values from a [`DateTimePicker`](https://developers.google.com/chat/api/reference/rest/v1/cards#DateTimePicker) widget that only accepts time values."
}
},
"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.",
"id": "KeyValue",
"properties": {
"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"
},
"button": {
"$ref": "Button",
"description": "A button that can be clicked to trigger an action."
},
"content": {
"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).",
"type": "string"
},
"contentMultiline": {
"description": "If the content should be multiline.",
"type": "boolean"
},
"icon": {
"description": "An enum value that's replaced by the Chat API with the corresponding icon image.",
"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"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"iconUrl": {
"description": "The icon specified by a URL.",
"type": "string"
},
"onClick": {
"$ref": "OnClick",
"description": "The `onclick` action. Only the top label, bottom label, and content region are clickable."
},
"topLabel": {
"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).",
"type": "string"
}
},
"type": "object"
},
"ListCustomEmojisResponse": {
"description": "A response to list custom emojis.",
"id": "ListCustomEmojisResponse",
"properties": {
"customEmojis": {
"description": "Unordered list. List of custom emojis.",
"items": {
"$ref": "CustomEmoji"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListMembershipsResponse": {
"description": "Response to list memberships of the space.",
"id": "ListMembershipsResponse",
"properties": {
"memberships": {
"description": "Unordered list. List of memberships in the requested (or first) page.",
"items": {
"$ref": "Membership"
},
"type": "array"
},
"nextPageToken": {
"description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListMessagesResponse": {
"description": "Response message for listing messages.",
"id": "ListMessagesResponse",
"properties": {
"messages": {
"description": "List of messages.",
"items": {
"$ref": "Message"
},
"type": "array"
},
"nextPageToken": {
"description": "You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"ListReactionsResponse": {
"description": "Response to a list reactions request.",
"id": "ListReactionsResponse",
"properties": {
"nextPageToken": {
"description": "Continuation token to retrieve the next page of results. It's empty for the last page of results.",
"type": "string"
},
"reactions": {
"description": "List of reactions in the requested (or first) page.",
"items": {
"$ref": "Reaction"
},
"type": "array"
}
},
"type": "object"
},
"ListSectionItemsResponse": {
"description": "Response message for listing section items.",
"id": "ListSectionItemsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"sectionItems": {
"description": "The section items from the specified section.",
"items": {
"$ref": "SectionItem"
},
"type": "array"
}
},
"type": "object"
},
"ListSectionsResponse": {
"description": "Response message for listing sections.",
"id": "ListSectionsResponse",
"properties": {
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"sections": {
"description": "The sections from the specified user.",
"items": {
"$ref": "GoogleChatV1Section"
},
"type": "array"
}
},
"type": "object"
},
"ListSpaceEventsResponse": {
"description": "Response message for listing space events.",
"id": "ListSpaceEventsResponse",
"properties": {
"nextPageToken": {
"description": "Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"spaceEvents": {
"description": "Results are returned in chronological order (oldest event first). Note: The `permissionSettings` field is not returned in the Space object for list requests.",
"items": {
"$ref": "SpaceEvent"
},
"type": "array"
}
},
"type": "object"
},
"ListSpacesResponse": {
"description": "The response for a list spaces request.",
"id": "ListSpacesResponse",
"properties": {
"nextPageToken": {
"description": "You can send a token as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.",
"type": "string"
},
"spaces": {
"description": "List of spaces in the requested (or first) page. Note: The `permissionSettings` field is not returned in the Space object for list requests.",
"items": {
"$ref": "Space"
},
"type": "array"
}
},
"type": "object"
},
"MatchedUrl": {
"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).",
"id": "MatchedUrl",
"properties": {
"url": {
"description": "Output only. The URL that was matched.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Media": {
"description": "Media resource.",
"id": "Media",
"properties": {
"resourceName": {
"description": "Name of the media resource.",
"type": "string"
}
},
"type": "object"
},
"MeetSpaceLinkData": {
"description": "Data for Meet space links.",
"id": "MeetSpaceLinkData",
"properties": {
"huddleStatus": {
"description": "Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.",
"enum": [
"HUDDLE_STATUS_UNSPECIFIED",
"STARTED",
"ENDED",
"MISSED"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"The huddle has started.",
"The huddle has ended. In this case the Meet space URI and identifiers will no longer be valid.",
"The huddle has been missed. In this case the Meet space URI and identifiers will no longer be valid."
],
"readOnly": true,
"type": "string"
},
"meetingCode": {
"description": "Meeting code of the linked Meet space.",
"type": "string"
},
"type": {
"description": "Indicates the type of the Meet space.",
"enum": [
"TYPE_UNSPECIFIED",
"MEETING",
"HUDDLE"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"The Meet space is a meeting.",
"The Meet space is a huddle."
],
"type": "string"
}
},
"type": "object"
},
"Membership": {
"description": "Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.",
"id": "Membership",
"properties": {
"createTime": {
"description": "Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.",
"format": "google-datetime",
"type": "string"
},
"deleteTime": {
"description": "Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.",
"format": "google-datetime",
"type": "string"
},
"groupMember": {
"$ref": "Group",
"description": "Optional. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)."
},
"member": {
"$ref": "User",
"description": "Optional. The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`."
},
"name": {
"description": "Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`",
"type": "string"
},
"role": {
"description": "Optional. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in `UpdateMembership`.",
"enum": [
"MEMBERSHIP_ROLE_UNSPECIFIED",
"ROLE_MEMBER",
"ROLE_MANAGER",
"ROLE_ASSISTANT_MANAGER"
],
"enumDescriptions": [
"Default value. For users: they aren't a member of the space, but can be invited. For Google Groups: they're always assigned this role (other enum values might be used in the future).",
"A member of the space. In the Chat UI, this role is called Member. The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including: - Add or remove members. - Modify space details. - Turn history on or off. - Mention everyone in the space with `@all`. - Manage Chat apps and webhooks installed in the space. In direct messages and unnamed group conversations, everyone has this role.",
"A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441).",
"A space manager. In the Chat UI, this role is called Manager. The user has all basic permissions of `ROLE_MEMBER`, and can be granted a subset of administrative permissions by an owner. By default, managers have all the permissions of an owner except for the ability to: - Delete the space. - Make another space member an owner. - Change an owner's role. By default, managers permissions include but aren't limited to: - Make another member a manager. - Delete messages in the space. - Manage space permissions. - Receive notifications for requests to join the space if the manager has the \"manage members\" permission in the space settings. - Make a space discoverable. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Manage space settings](https://support.google.com/chat/answer/13340792)."
],
"type": "string"
},
"state": {
"description": "Output only. State of the membership.",
"enum": [
"MEMBERSHIP_STATE_UNSPECIFIED",
"JOINED",
"INVITED",
"NOT_A_MEMBER"
],
"enumDescriptions": [
"Default value. Don't use.",
"The user is added to the space, and can participate in the space.",
"The user is invited to join the space, but hasn't joined it.",
"The user doesn't belong to the space and doesn't have a pending invitation to join the space."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"MembershipBatchCreatedEventData": {
"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`",
"id": "MembershipBatchCreatedEventData",
"properties": {
"memberships": {
"description": "A list of new memberships.",
"items": {
"$ref": "MembershipCreatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MembershipBatchDeletedEventData": {
"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`",
"id": "MembershipBatchDeletedEventData",
"properties": {
"memberships": {
"description": "A list of deleted memberships.",
"items": {
"$ref": "MembershipDeletedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MembershipBatchUpdatedEventData": {
"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`",
"id": "MembershipBatchUpdatedEventData",
"properties": {
"memberships": {
"description": "A list of updated memberships.",
"items": {
"$ref": "MembershipUpdatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MembershipCount": {
"description": "Represents the count of memberships of a space, grouped into categories.",
"id": "MembershipCount",
"properties": {
"joinedDirectHumanUserCount": {
"description": "Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"joinedGroupCount": {
"description": "Output only. Count of all groups that have directly joined the space.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"MembershipCreatedEventData": {
"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.",
"id": "MembershipCreatedEventData",
"properties": {
"membership": {
"$ref": "Membership",
"description": "The new membership."
}
},
"type": "object"
},
"MembershipDeletedEventData": {
"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`",
"id": "MembershipDeletedEventData",
"properties": {
"membership": {
"$ref": "Membership",
"description": "The deleted membership. Only the `name` and `state` fields are populated."
}
},
"type": "object"
},
"MembershipUpdatedEventData": {
"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`",
"id": "MembershipUpdatedEventData",
"properties": {
"membership": {
"$ref": "Membership",
"description": "The updated membership."
}
},
"type": "object"
},
"Message": {
"description": "A message in a Google Chat space.",
"id": "Message",
"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).",
"items": {
"$ref": "AccessoryWidget"
},
"type": "array"
},
"actionResponse": {
"$ref": "ActionResponse",
"description": "Input only. Parameters that a Chat app can use to configure how its response is posted."
},
"annotations": {
"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.",
"items": {
"$ref": "Annotation"
},
"readOnly": true,
"type": "array"
},
"argumentText": {
"description": "Output only. Plain-text body of the message with all Chat app mentions stripped out.",
"readOnly": true,
"type": "string"
},
"attachedGifs": {
"description": "Output only. GIF images that are attached to the message.",
"items": {
"$ref": "AttachedGif"
},
"readOnly": true,
"type": "array"
},
"attachment": {
"description": "Optional. User-uploaded attachment.",
"items": {
"$ref": "Attachment"
},
"type": "array"
},
"cards": {
"deprecated": true,
"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": "Card"
},
"type": "array"
},
"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": "CardWithId"
},
"type": "array"
},
"clientAssignedMessageId": {
"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).",
"type": "string"
},
"createTime": {
"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",
"type": "string"
},
"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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deletionMetadata": {
"$ref": "DeletionMetadata",
"description": "Output only. Information about a deleted message. A message is deleted when `delete_time` is set.",
"readOnly": true
},
"emojiReactionSummaries": {
"description": "Output only. The list of emoji reaction summaries on the message.",
"items": {
"$ref": "EmojiReactionSummary"
},
"readOnly": true,
"type": "array"
},
"fallbackText": {
"description": "Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed\u2014for example, mobile notifications.",
"type": "string"
},
"formattedText": {
"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\u2014for example, ``. * Custom emoji using the format `:{emoji_name}:`\u2014for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. * Bullet list items using asterisks (`*`)\u2014for 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,
"type": "string"
},
"lastUpdateTime": {
"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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"matchedUrl": {
"$ref": "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).",
"readOnly": true
},
"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"
},
"privateMessageViewer": {
"$ref": "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)."
},
"quotedMessageMetadata": {
"$ref": "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)."
},
"sender": {
"$ref": "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 populates the [user](https://developers.google.com/workspace/chat/api/reference/rest/v1/User) `name` and `type`.",
"readOnly": true
},
"silent": {
"description": "Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients.",
"readOnly": true,
"type": "boolean"
},
"slashCommand": {
"$ref": "SlashCommand",
"description": "Output only. Slash command information, if applicable.",
"readOnly": true
},
"space": {
"$ref": "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`.",
"readOnly": true
},
"text": {
"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).",
"type": "string"
},
"thread": {
"$ref": "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)."
},
"threadReply": {
"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`.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"MessageBatchCreatedEventData": {
"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`",
"id": "MessageBatchCreatedEventData",
"properties": {
"messages": {
"description": "A list of new messages.",
"items": {
"$ref": "MessageCreatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MessageBatchDeletedEventData": {
"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`",
"id": "MessageBatchDeletedEventData",
"properties": {
"messages": {
"description": "A list of deleted messages.",
"items": {
"$ref": "MessageDeletedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MessageBatchUpdatedEventData": {
"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`",
"id": "MessageBatchUpdatedEventData",
"properties": {
"messages": {
"description": "A list of updated messages.",
"items": {
"$ref": "MessageUpdatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"MessageCreatedEventData": {
"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`",
"id": "MessageCreatedEventData",
"properties": {
"message": {
"$ref": "Message",
"description": "The new message."
}
},
"type": "object"
},
"MessageDeletedEventData": {
"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`",
"id": "MessageDeletedEventData",
"properties": {
"message": {
"$ref": "Message",
"description": "The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated."
}
},
"type": "object"
},
"MessageUpdatedEventData": {
"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`",
"id": "MessageUpdatedEventData",
"properties": {
"message": {
"$ref": "Message",
"description": "The updated message."
}
},
"type": "object"
},
"MoveSectionItemRequest": {
"description": "Request message for moving a section item across sections.",
"id": "MoveSectionItemRequest",
"properties": {
"targetSection": {
"description": "Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}`",
"type": "string"
}
},
"type": "object"
},
"MoveSectionItemResponse": {
"description": "Response message for moving a section item.",
"id": "MoveSectionItemResponse",
"properties": {
"sectionItem": {
"$ref": "SectionItem",
"description": "The updated section item."
}
},
"type": "object"
},
"OnClick": {
"description": "An `onclick` action (for example, open a link).",
"id": "OnClick",
"properties": {
"action": {
"$ref": "FormAction",
"description": "A form action is triggered by this `onclick` action if specified."
},
"openLink": {
"$ref": "OpenLink",
"description": "This `onclick` action triggers an open link action if specified."
}
},
"type": "object"
},
"OpenLink": {
"description": "A link that opens a new window.",
"id": "OpenLink",
"properties": {
"url": {
"description": "The URL to open.",
"type": "string"
}
},
"type": "object"
},
"PermissionSetting": {
"description": "Represents a space permission setting.",
"id": "PermissionSetting",
"properties": {
"assistantManagersAllowed": {
"description": "Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.",
"type": "boolean"
},
"managersAllowed": {
"description": "Optional. Whether space owners (`ROLE_MANAGER`) have this permission.",
"type": "boolean"
},
"membersAllowed": {
"description": "Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.",
"type": "boolean"
}
},
"type": "object"
},
"PermissionSettings": {
"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.",
"id": "PermissionSettings",
"properties": {
"manageApps": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for managing apps in a space."
},
"manageMembersAndGroups": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for managing members and groups in a space."
},
"manageWebhooks": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for managing webhooks in a space."
},
"modifySpaceDetails": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for updating space name, avatar, description and guidelines."
},
"postMessages": {
"$ref": "PermissionSetting",
"description": "Output only. Setting for posting messages in a space.",
"readOnly": true
},
"replyMessages": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for replying to messages in a space."
},
"toggleHistory": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for toggling space history on and off."
},
"useAtMentionAll": {
"$ref": "PermissionSetting",
"description": "Optional. Setting for using @all in a space."
}
},
"type": "object"
},
"PositionSectionRequest": {
"description": "Request message for positioning a section.",
"id": "PositionSectionRequest",
"properties": {
"relativePosition": {
"description": "Optional. The relative position of the section in the list of sections.",
"enum": [
"POSITION_UNSPECIFIED",
"START",
"END"
],
"enumDescriptions": [
"Unspecified position.",
"Start of the list of sections.",
"End of the list of sections."
],
"type": "string"
},
"sortOrder": {
"description": "Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PositionSectionResponse": {
"description": "Response message for positioning a section.",
"id": "PositionSectionResponse",
"properties": {
"section": {
"$ref": "GoogleChatV1Section",
"description": "The updated section."
}
},
"type": "object"
},
"QuotedMessageMetadata": {
"description": "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).",
"id": "QuotedMessageMetadata",
"properties": {
"forwardedMetadata": {
"$ref": "ForwardedMetadata",
"description": "Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type.",
"readOnly": true
},
"lastUpdateTime": {
"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.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`",
"type": "string"
},
"quoteType": {
"description": "Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.",
"enum": [
"QUOTE_TYPE_UNSPECIFIED",
"REPLY"
],
"enumDescriptions": [
"Reserved. This value is unused.",
"If quote_type is `REPLY`, you can do the following: * If you're replying in a thread, you can quote another message in that thread. * If you're creating a root message, you can quote another root message in that space. You can't quote a message reply from a different thread."
],
"type": "string"
},
"quotedMessageSnapshot": {
"$ref": "QuotedMessageSnapshot",
"description": "Output only. A snapshot of the quoted message's content.",
"readOnly": true
}
},
"type": "object"
},
"QuotedMessageSnapshot": {
"description": "Provides a snapshot of the content of the quoted message at the time of quoting or forwarding",
"id": "QuotedMessageSnapshot",
"properties": {
"annotations": {
"description": "Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.",
"items": {
"$ref": "Annotation"
},
"readOnly": true,
"type": "array"
},
"attachments": {
"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": "Attachment"
},
"readOnly": true,
"type": "array"
},
"formattedText": {
"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.",
"readOnly": true,
"type": "string"
},
"sender": {
"description": "Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.",
"readOnly": true,
"type": "string"
},
"text": {
"description": "Output only. Snapshot of the quoted message's text content.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Reaction": {
"description": "A reaction to a message.",
"id": "Reaction",
"properties": {
"emoji": {
"$ref": "Emoji",
"description": "Required. The emoji used in the reaction."
},
"name": {
"description": "Identifier. The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`",
"type": "string"
},
"user": {
"$ref": "User",
"description": "Output only. The user who created the reaction.",
"readOnly": true
}
},
"type": "object"
},
"ReactionBatchCreatedEventData": {
"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`",
"id": "ReactionBatchCreatedEventData",
"properties": {
"reactions": {
"description": "A list of new reactions.",
"items": {
"$ref": "ReactionCreatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"ReactionBatchDeletedEventData": {
"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`",
"id": "ReactionBatchDeletedEventData",
"properties": {
"reactions": {
"description": "A list of deleted reactions.",
"items": {
"$ref": "ReactionDeletedEventData"
},
"type": "array"
}
},
"type": "object"
},
"ReactionCreatedEventData": {
"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`",
"id": "ReactionCreatedEventData",
"properties": {
"reaction": {
"$ref": "Reaction",
"description": "The new reaction."
}
},
"type": "object"
},
"ReactionDeletedEventData": {
"description": "Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted`",
"id": "ReactionDeletedEventData",
"properties": {
"reaction": {
"$ref": "Reaction",
"description": "The deleted reaction."
}
},
"type": "object"
},
"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.",
"id": "RichLinkMetadata",
"properties": {
"calendarEventLinkData": {
"$ref": "CalendarEventLinkData",
"description": "Data for a Calendar event link."
},
"chatSpaceLinkData": {
"$ref": "ChatSpaceLinkData",
"description": "Data for a chat space link."
},
"driveLinkData": {
"$ref": "DriveLinkData",
"description": "Data for a drive link."
},
"meetSpaceLinkData": {
"$ref": "MeetSpaceLinkData",
"description": "Data for a Meet space link."
},
"richLinkType": {
"description": "The rich link type.",
"enum": [
"RICH_LINK_TYPE_UNSPECIFIED",
"DRIVE_FILE",
"CHAT_SPACE",
"GMAIL_MESSAGE",
"MEET_SPACE",
"CALENDAR_EVENT"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"A Google Drive rich link type.",
"A Chat space rich link type. For example, a space smart chip.",
"A Gmail message rich link type. Specifically, a Gmail chip from [Share to Chat](https://support.google.com/chat?p=chat_gmail). The API only supports reading messages with GMAIL_MESSAGE rich links.",
"A Meet message rich link type. For example, a Meet chip.",
"A Calendar message rich link type. For example, a Calendar chip."
],
"type": "string"
},
"uri": {
"description": "The URI of this link.",
"type": "string"
}
},
"type": "object"
},
"SearchSpacesResponse": {
"description": "Response with a list of spaces corresponding to the search spaces request.",
"id": "SearchSpacesResponse",
"properties": {
"nextPageToken": {
"description": "A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.",
"type": "string"
},
"spaces": {
"description": "A page of the requested spaces.",
"items": {
"$ref": "Space"
},
"type": "array"
},
"totalSize": {
"description": "The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Section": {
"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).",
"id": "Section",
"properties": {
"header": {
"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": "string"
},
"widgets": {
"description": "A section must contain at least one widget.",
"items": {
"$ref": "WidgetMarkup"
},
"type": "array"
}
},
"type": "object"
},
"SectionItem": {
"description": "A user's defined section item. This is used to represent section items, such as spaces, grouped under a section.",
"id": "SectionItem",
"properties": {
"name": {
"description": "Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}`",
"type": "string"
},
"space": {
"description": "Optional. The space resource name. Format: `spaces/{space}`",
"type": "string"
}
},
"type": "object"
},
"SelectionItems": {
"description": "List of widget autocomplete results.",
"id": "SelectionItems",
"properties": {
"items": {
"description": "An array of the SelectionItem objects.",
"items": {
"$ref": "GoogleAppsCardV1SelectionItem"
},
"type": "array"
}
},
"type": "object"
},
"SetUpSpaceRequest": {
"description": "Request to create a space and add specified users to it.",
"id": "SetUpSpaceRequest",
"properties": {
"memberships": {
"description": "Optional. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 49 memberships (in addition to the caller). For human membership, the `Membership.member` field must contain a `user` with `name` populated (format: `users/{user}`) and `type` set to `User.Type.HUMAN`. You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the `user.name` can be `users/example@gmail.com`. To invite Gmail users or users from external Google Workspace domains, user's email must be used for `{user}`. For Google group membership, the `Membership.group_member` field must contain a `group` with `name` populated (format `groups/{group}`). You can only add Google groups when setting `Space.spaceType` to `SPACE`. Optional when setting `Space.spaceType` to `SPACE`. Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at least two memberships. Required when setting `Space.spaceType` to `DIRECT_MESSAGE` with a human user, along with exactly one membership. Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`).",
"items": {
"$ref": "Membership"
},
"type": "array"
},
"requestId": {
"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.",
"type": "string"
},
"space": {
"$ref": "Space",
"description": "Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space."
}
},
"type": "object"
},
"SlashCommand": {
"description": "Metadata about a [slash command](https://developers.google.com/workspace/chat/commands) in Google Chat.",
"id": "SlashCommand",
"properties": {
"commandId": {
"description": "The ID of the slash command.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"SlashCommandMetadata": {
"description": "Annotation metadata for slash commands (/).",
"id": "SlashCommandMetadata",
"properties": {
"bot": {
"$ref": "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"
},
"triggersDialog": {
"description": "Indicates whether the slash command is for a dialog.",
"type": "boolean"
},
"type": {
"description": "The type of slash command.",
"enum": [
"TYPE_UNSPECIFIED",
"ADD",
"INVOKE"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"Add Chat app to space.",
"Invoke slash command in space."
],
"type": "string"
}
},
"type": "object"
},
"Space": {
"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.",
"id": "Space",
"properties": {
"accessSettings": {
"$ref": "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`."
},
"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.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"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`.",
"format": "google-datetime",
"type": "string"
},
"customer": {
"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.",
"type": "string"
},
"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"
},
"externalUserAllowed": {
"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.",
"type": "boolean"
},
"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"
},
"importModeExpireTime": {
"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.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"lastActiveTime": {
"description": "Output only. Timestamp of the last message in the space.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"membershipCount": {
"$ref": "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`.",
"readOnly": true
},
"name": {
"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`.",
"type": "string"
},
"permissionSettings": {
"$ref": "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)"
},
"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"
],
"enumDescriptions": [
"Unspecified. Don't use.",
"Setting to make the space a collaboration space where all members can post messages.",
"Setting to make the space an announcement space where only space managers can post messages."
],
"type": "string"
},
"singleUserBotDm": {
"description": "Optional. Whether the space is a DM between a Chat app and a single human.",
"type": "boolean"
},
"spaceDetails": {
"$ref": "SpaceDetails",
"description": "Optional. Details about the space including description and rules."
},
"spaceHistoryState": {
"description": "Optional. The message history state for messages and threads in this space.",
"enum": [
"HISTORY_STATE_UNSPECIFIED",
"HISTORY_OFF",
"HISTORY_ON"
],
"enumDescriptions": [
"Default value. Do not use.",
"History off. [Messages and threads are kept for 24 hours](https://support.google.com/chat/answer/7664687).",
"History on. The organization's [Vault retention rules](https://support.google.com/vault/answer/7657597) specify for how long messages and threads are kept."
],
"type": "string"
},
"spaceThreadingState": {
"description": "Output only. The threading state in the Chat space.",
"enum": [
"SPACE_THREADING_STATE_UNSPECIFIED",
"THREADED_MESSAGES",
"GROUPED_MESSAGES",
"UNTHREADED_MESSAGES"
],
"enumDescriptions": [
"Reserved.",
"Spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.",
"Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.",
"Spaces that don't support message threading. This space threading state is only used for special cases including: * Continuous meeting chat where threading is intentionally turned off. * Legacy group conversations that were created prior to 2022."
],
"readOnly": true,
"type": "string"
},
"spaceType": {
"description": "Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.",
"enum": [
"SPACE_TYPE_UNSPECIFIED",
"SPACE",
"GROUP_CHAT",
"DIRECT_MESSAGE"
],
"enumDescriptions": [
"Reserved.",
"A place where people send messages, share files, and collaborate. A `SPACE` can include Chat apps.",
"Group conversations between 3 or more people. A `GROUP_CHAT` can include Chat apps.",
"1:1 messages between two humans or a human and a Chat app."
],
"type": "string"
},
"spaceUri": {
"description": "Output only. The URI for a user to access the space.",
"readOnly": true,
"type": "string"
},
"threaded": {
"deprecated": true,
"description": "Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.",
"readOnly": true,
"type": "boolean"
},
"type": {
"deprecated": true,
"description": "Output only. Deprecated: Use `space_type` instead. The type of a space.",
"enum": [
"TYPE_UNSPECIFIED",
"ROOM",
"DM"
],
"enumDescriptions": [
"Reserved.",
"Conversations between two or more humans.",
"1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SpaceBatchUpdatedEventData": {
"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`",
"id": "SpaceBatchUpdatedEventData",
"properties": {
"spaces": {
"description": "A list of updated spaces.",
"items": {
"$ref": "SpaceUpdatedEventData"
},
"type": "array"
}
},
"type": "object"
},
"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):",
"id": "SpaceDataSource",
"properties": {
"defaultToCurrentSpace": {
"description": "If set to `true`, the multiselect menu selects the current Google Chat space as an item by default.",
"type": "boolean"
}
},
"type": "object"
},
"SpaceDetails": {
"description": "Details about the space including description and rules.",
"id": "SpaceDetails",
"properties": {
"description": {
"description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.",
"type": "string"
},
"guidelines": {
"description": "Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.",
"type": "string"
}
},
"type": "object"
},
"SpaceEvent": {
"description": "An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).",
"id": "SpaceEvent",
"properties": {
"eventTime": {
"description": "Time when the event occurred.",
"format": "google-datetime",
"type": "string"
},
"eventType": {
"description": "Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`",
"type": "string"
},
"membershipBatchCreatedEventData": {
"$ref": "MembershipBatchCreatedEventData",
"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`"
},
"membershipBatchDeletedEventData": {
"$ref": "MembershipBatchDeletedEventData",
"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`"
},
"membershipBatchUpdatedEventData": {
"$ref": "MembershipBatchUpdatedEventData",
"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`"
},
"membershipCreatedEventData": {
"$ref": "MembershipCreatedEventData",
"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`"
},
"membershipDeletedEventData": {
"$ref": "MembershipDeletedEventData",
"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`"
},
"membershipUpdatedEventData": {
"$ref": "MembershipUpdatedEventData",
"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`"
},
"messageBatchCreatedEventData": {
"$ref": "MessageBatchCreatedEventData",
"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`"
},
"messageBatchDeletedEventData": {
"$ref": "MessageBatchDeletedEventData",
"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`"
},
"messageBatchUpdatedEventData": {
"$ref": "MessageBatchUpdatedEventData",
"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`"
},
"messageCreatedEventData": {
"$ref": "MessageCreatedEventData",
"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`"
},
"messageDeletedEventData": {
"$ref": "MessageDeletedEventData",
"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`"
},
"messageUpdatedEventData": {
"$ref": "MessageUpdatedEventData",
"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`"
},
"name": {
"description": "Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`",
"type": "string"
},
"reactionBatchCreatedEventData": {
"$ref": "ReactionBatchCreatedEventData",
"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`"
},
"reactionBatchDeletedEventData": {
"$ref": "ReactionBatchDeletedEventData",
"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`"
},
"reactionCreatedEventData": {
"$ref": "ReactionCreatedEventData",
"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`"
},
"reactionDeletedEventData": {
"$ref": "ReactionDeletedEventData",
"description": "Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`"
},
"spaceBatchUpdatedEventData": {
"$ref": "SpaceBatchUpdatedEventData",
"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`"
},
"spaceUpdatedEventData": {
"$ref": "SpaceUpdatedEventData",
"description": "Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`"
}
},
"type": "object"
},
"SpaceNotificationSetting": {
"description": "The notification setting of a user in a space.",
"id": "SpaceNotificationSetting",
"properties": {
"muteSetting": {
"description": "The space notification mute setting.",
"enum": [
"MUTE_SETTING_UNSPECIFIED",
"UNMUTED",
"MUTED"
],
"enumDescriptions": [
"Reserved.",
"The user will receive notifications for the space based on the notification setting.",
"The user will not receive any notifications for the space, regardless of the notification setting."
],
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the space notification setting. Format: `users/{user}/spaces/{space}/spaceNotificationSetting`.",
"type": "string"
},
"notificationSetting": {
"description": "The notification setting.",
"enum": [
"NOTIFICATION_SETTING_UNSPECIFIED",
"ALL",
"MAIN_CONVERSATIONS",
"FOR_YOU",
"OFF"
],
"enumDescriptions": [
"Reserved.",
"Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.",
"The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.",
"The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.",
"Notification is off."
],
"type": "string"
}
},
"type": "object"
},
"SpaceReadState": {
"description": "A user's read state within a space, used to identify read and unread messages.",
"id": "SpaceReadState",
"properties": {
"lastReadTime": {
"description": "Optional. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`",
"type": "string"
}
},
"type": "object"
},
"SpaceUpdatedEventData": {
"description": "Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated`",
"id": "SpaceUpdatedEventData",
"properties": {
"space": {
"$ref": "Space",
"description": "The updated space."
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"StringInputs": {
"description": "Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented.",
"id": "StringInputs",
"properties": {
"value": {
"description": "An list of strings entered by the user.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TextButton": {
"description": "A button with text and `onclick` action.",
"id": "TextButton",
"properties": {
"onClick": {
"$ref": "OnClick",
"description": "The `onclick` action of the button."
},
"text": {
"description": "The text of the button.",
"type": "string"
}
},
"type": "object"
},
"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).",
"id": "TextParagraph",
"properties": {
"text": {
"type": "string"
}
},
"type": "object"
},
"Thread": {
"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.",
"id": "Thread",
"properties": {
"name": {
"description": "Identifier. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`",
"type": "string"
},
"threadKey": {
"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.",
"type": "string"
}
},
"type": "object"
},
"ThreadReadState": {
"description": "A user's read state within a thread, used to identify read and unread messages.",
"id": "ThreadReadState",
"properties": {
"lastReadTime": {
"description": "The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`",
"type": "string"
}
},
"type": "object"
},
"TimeInput": {
"description": "Time input values.",
"id": "TimeInput",
"properties": {
"hours": {
"description": "The hour on a 24-hour clock.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "The number of minutes past the hour. Valid values are 0 to 59.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"TimeZone": {
"description": "The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).",
"id": "TimeZone",
"properties": {
"id": {
"description": "The [IANA TZ](https://www.iana.org/time-zones) time zone database code, such as \"America/Toronto\".",
"type": "string"
},
"offset": {
"description": "The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"UpdatedWidget": {
"description": "For `selectionInput` widgets, returns autocomplete suggestions for a multiselect menu.",
"id": "UpdatedWidget",
"properties": {
"suggestions": {
"$ref": "SelectionItems",
"description": "List of widget autocomplete results"
},
"widget": {
"description": "The ID of the updated widget. The ID must match the one for the widget that triggered the update request.",
"type": "string"
}
},
"type": "object"
},
"UploadAttachmentRequest": {
"description": "Request to upload an attachment.",
"id": "UploadAttachmentRequest",
"properties": {
"filename": {
"description": "Required. The filename of the attachment, including the file extension.",
"type": "string"
}
},
"type": "object"
},
"UploadAttachmentResponse": {
"description": "Response of uploading an attachment.",
"id": "UploadAttachmentResponse",
"properties": {
"attachmentDataRef": {
"$ref": "AttachmentDataRef",
"description": "Reference to the uploaded attachment."
}
},
"type": "object"
},
"User": {
"description": "A user in Google Chat. When returned as an output from a request, if your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output for a `User` resource only populates the user's `name` and `type`.",
"id": "User",
"properties": {
"displayName": {
"description": "Output only. The user's display name.",
"readOnly": true,
"type": "string"
},
"domainId": {
"description": "Unique identifier of the user's Google Workspace domain.",
"type": "string"
},
"isAnonymous": {
"description": "Output only. When `true`, the user is deleted or their profile is not visible.",
"readOnly": true,
"type": "boolean"
},
"name": {
"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.",
"type": "string"
},
"type": {
"description": "User type.",
"enum": [
"TYPE_UNSPECIFIED",
"HUMAN",
"BOT"
],
"enumDescriptions": [
"Default value for the enum. DO NOT USE.",
"Human user.",
"Chat app user."
],
"type": "string"
}
},
"type": "object"
},
"UserMentionMetadata": {
"description": "Annotation metadata for user mentions (@).",
"id": "UserMentionMetadata",
"properties": {
"type": {
"description": "The type of user mention.",
"enum": [
"TYPE_UNSPECIFIED",
"ADD",
"MENTION"
],
"enumDescriptions": [
"Default value for the enum. Don't use.",
"Add user to space.",
"Mention user in space."
],
"type": "string"
},
"user": {
"$ref": "User",
"description": "The user mentioned."
}
},
"type": "object"
},
"WidgetMarkup": {
"description": "A widget is a UI element that presents text and images.",
"id": "WidgetMarkup",
"properties": {
"buttons": {
"description": "A list of buttons. Buttons is also `oneof data` and only one of these fields should be set.",
"items": {
"$ref": "Button"
},
"type": "array"
},
"image": {
"$ref": "Image",
"description": "Display an image in this widget."
},
"keyValue": {
"$ref": "KeyValue",
"description": "Display a key value item in this widget."
},
"textParagraph": {
"$ref": "TextParagraph",
"description": "Display a text paragraph in this widget."
}
},
"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.",
"id": "WorkflowDataSourceMarkup",
"properties": {
"includeVariables": {
"description": "Whether to include variables from the previous step in the data source.",
"type": "boolean"
},
"type": {
"description": "The type of data source.",
"enum": [
"UNKNOWN",
"USER",
"SPACE",
"USER_WITH_FREE_FORM"
],
"enumDescriptions": [
"Default value. Don't use.",
"Google Workspace users. The user can only view and select users from their Google Workspace organization.",
"Google Chat spaces that the user is a member of.",
"Users can choose to view and select existing members from their Google Workspace organization or manually enter an email address or a valid domain."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Google Chat API",
"version": "v1",
"version_module": true
}