As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Apps Chat v1 API

class google.apps.chat_v1.types.AccessoryWidget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

button_list

A list of buttons.

This field is a member of oneof action.

Type

google.apps.card_v1.types.ButtonList

class google.apps.chat_v1.types.ActionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Parameters that a Chat app can use to configure how its response is posted.

type_

Input only. The type of Chat app response.

Type

google.apps.chat_v1.types.ActionResponse.ResponseType

url

Input only. URL for users to authenticate or configure. (Only for REQUEST_CONFIG response types.)

Type

str

dialog_action

Input only. A response to an interaction event related to a dialog. Must be accompanied by ResponseType.Dialog.

Type

google.apps.chat_v1.types.DialogAction

updated_widget

Input only. The response of the updated widget.

Type

google.apps.chat_v1.types.ActionResponse.UpdatedWidget

class ResponseType(value)

Bases: proto.enums.Enum

The type of Chat app response.

Values:

TYPE_UNSPECIFIED (0):

Default type that’s handled as NEW_MESSAGE.

NEW_MESSAGE (1):

Post as a new message in the topic.

UPDATE_MESSAGE (2):

Update the Chat app’s message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT.

UPDATE_USER_MESSAGE_CARDS (6):

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.

REQUEST_CONFIG (3):

Privately ask the user for additional authentication or configuration.

DIALOG (4):

Presents a dialog.

UPDATE_WIDGET (7):

Widget text autocomplete options query.

class SelectionItems(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

List of widget autocomplete results.

items

An array of the SelectionItem objects.

Type

MutableSequence[google.apps.card_v1.types.SelectionInput.SelectionItem]

class UpdatedWidget(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response of the updated widget. Used to provide autocomplete options for a widget.

suggestions

List of widget autocomplete results

This field is a member of oneof updated_widget.

Type

google.apps.chat_v1.types.ActionResponse.SelectionItems

widget

The ID of the updated widget. The ID must match the one for the widget that triggered the update request.

Type

str

class google.apps.chat_v1.types.ActionStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the status for a request to either invoke or submit a dialog.

status_code

The status code.

Type

google.rpc.code_pb2.Code

user_facing_message

The message to send users about the status of their request. If unset, a generic message based on the status_code is sent.

Type

str

class google.apps.chat_v1.types.Annotation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see Format text 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"
   }
}]

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

type_

The type of this annotation.

Type

google.apps.chat_v1.types.AnnotationType

start_index

Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.

This field is a member of oneof _start_index.

Type

int

length

Length of the substring in the plain-text message body this annotation corresponds to.

Type

int

user_mention

The metadata of user mention.

This field is a member of oneof metadata.

Type

google.apps.chat_v1.types.UserMentionMetadata

slash_command

The metadata for a slash command.

This field is a member of oneof metadata.

Type

google.apps.chat_v1.types.SlashCommandMetadata

rich_link_metadata

The metadata for a rich link.

This field is a member of oneof metadata.

Type

google.apps.chat_v1.types.RichLinkMetadata

class google.apps.chat_v1.types.AnnotationType(value)

Bases: proto.enums.Enum

Type of the annotation.

Values:

ANNOTATION_TYPE_UNSPECIFIED (0):

Default value for the enum. Don’t use.

USER_MENTION (1):

A user is mentioned.

SLASH_COMMAND (2):

A slash command is invoked.

RICH_LINK (3):

A rich link annotation.

class google.apps.chat_v1.types.AttachedGif(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A GIF image that’s specified by a URL.

uri

Output only. The URL that hosts the GIF image.

Type

str

class google.apps.chat_v1.types.Attachment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An attachment in Google Chat.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment}.

Type

str

content_name

Output only. The original file name for the content, not the full path.

Type

str

content_type

Output only. The content type (MIME type) of the file.

Type

str

attachment_data_ref

A reference to the attachment data. This field is used with the media API to download the attachment data.

This field is a member of oneof data_ref.

Type

google.apps.chat_v1.types.AttachmentDataRef

drive_data_ref

Output only. A reference to the Google Drive attachment. This field is used with the Google Drive API.

This field is a member of oneof data_ref.

Type

google.apps.chat_v1.types.DriveDataRef

thumbnail_uri

Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn’t use this URL to download attachment content.

Type

str

download_uri

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.

Type

str

source

Output only. The source of the attachment.

Type

google.apps.chat_v1.types.Attachment.Source

class Source(value)

Bases: proto.enums.Enum

The source of the attachment.

Values:

SOURCE_UNSPECIFIED (0):

Reserved.

DRIVE_FILE (1):

The file is a Google Drive file.

UPLOADED_CONTENT (2):

The file is uploaded to Chat.

class google.apps.chat_v1.types.AttachmentDataRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A reference to the attachment data.

resource_name

The resource name of the attachment data. This field is used with the media API to download the attachment data.

Type

str

attachment_upload_token

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

str

class google.apps.chat_v1.types.CardWithId(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A card in a Google Chat message.

Only Chat apps can create cards. If your Chat app authenticates as a user, the message can’t contain cards.

Card builder

card_id

Required if the message contains multiple cards. A unique identifier for a card in a message.

Type

str

card

A card. Maximum size is 32 KB.

Type

google.apps.card_v1.types.Card

class google.apps.chat_v1.types.ChatSpaceLinkData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Data for Chat space links.

space

The space of the linked Chat space resource.

Format: spaces/{space}

Type

str

thread

The thread of the linked Chat space resource.

Format: spaces/{space}/threads/{thread}

Type

str

message

The message of the linked Chat space resource.

Format: spaces/{space}/messages/{message}

Type

str

class google.apps.chat_v1.types.CompleteImportSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for completing the import process for a space.

name

Required. Resource name of the import mode space.

Format: spaces/{space}

Type

str

class google.apps.chat_v1.types.CompleteImportSpaceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for completing the import process for a space.

space

The import mode space.

Type

google.apps.chat_v1.types.Space

class google.apps.chat_v1.types.ContextualAddOnMarkup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The markup for developers to specify the contents of a contextual AddOn.

class Card(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A card is a UI element that can contain UI widgets such as text and images.

header

The header of the card. A header usually contains a title and an image.

Type

google.apps.chat_v1.types.ContextualAddOnMarkup.Card.CardHeader

sections

Sections are separated by a line divider.

Type

MutableSequence[google.apps.chat_v1.types.ContextualAddOnMarkup.Card.Section]

card_actions

The actions of this card.

Type

MutableSequence[google.apps.chat_v1.types.ContextualAddOnMarkup.Card.CardAction]

name

Name of the card.

Type

str

class CardAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

action_label

The label used to be displayed in the action menu item.

Type

str

on_click

The onclick action for this action item.

Type

google.apps.chat_v1.types.WidgetMarkup.OnClick

class CardHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

title

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

str

subtitle

The subtitle of the card header.

Type

str

image_style

The image’s type (for example, square border or circular border).

Type

google.apps.chat_v1.types.ContextualAddOnMarkup.Card.CardHeader.ImageStyle

image_url

The URL of the image in the card header.

Type

str

class ImageStyle(value)

Bases: proto.enums.Enum

Values:

IMAGE_STYLE_UNSPECIFIED (0):

No description available.

IMAGE (1):

Square border.

AVATAR (2):

Circular border.

class Section(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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).

header

The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Type

str

widgets

A section must contain at least one widget.

Type

MutableSequence[google.apps.chat_v1.types.WidgetMarkup]

class google.apps.chat_v1.types.CreateMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for creating a membership.

parent

Required. The resource name of the space for which to create the membership.

Format: spaces/{space}

Type

str

membership

Required. The membership relation to create. The memberType field must contain a user with the user.name and user.type fields populated. The server will assign a resource name and overwrite anything specified. When a Chat app creates a membership relation for a human user, it must use the chat.memberships scope, set user.type to HUMAN, and set user.name with format 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 of 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. When a Chat app creates a membership relation for itself, it must use the chat.memberships.app scope, set user.type to BOT, and set user.name to users/app.

Type

google.apps.chat_v1.types.Membership

use_admin_access

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.

Requires the chat.admin.memberships OAuth 2.0 scope.

Creating app memberships or creating memberships for users outside the administrator’s Google Workspace organization isn’t supported using admin access.

Type

bool

class google.apps.chat_v1.types.CreateMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Creates a message.

parent

Required. The resource name of the space in which to create a message.

Format: spaces/{space}

Type

str

message

Required. Message body.

Type

google.apps.chat_v1.types.Message

thread_key

Optional. Deprecated: Use [thread.thread_key][google.chat.v1.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][google.chat.v1.Thread.name]. For example usage, see Start or reply to a message thread.

Type

str

request_id

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.

Type

str

message_reply_option

Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

Type

google.apps.chat_v1.types.CreateMessageRequest.MessageReplyOption

message_id

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.

Type

str

class MessageReplyOption(value)

Bases: proto.enums.Enum

Specifies how to reply to a message. More states might be added in the future.

Values:

MESSAGE_REPLY_OPTION_UNSPECIFIED (0):

Default. Starts a new thread. Using this option ignores any [thread ID][google.chat.v1.Thread.name] or [thread_key][google.chat.v1.Thread.thread_key] that’s included.

REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD (1):

Creates the message as a reply to the thread specified by [thread ID][google.chat.v1.Thread.name] or [thread_key][google.chat.v1.Thread.thread_key]. If it fails, the message starts a new thread instead.

REPLY_MESSAGE_OR_FAIL (2):

Creates the message as a reply to the thread specified by [thread ID][google.chat.v1.Thread.name] or [thread_key][google.chat.v1.Thread.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.

class google.apps.chat_v1.types.CreateReactionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Creates a reaction to a message.

parent

Required. The message where the reaction is created.

Format: spaces/{space}/messages/{message}

Type

str

reaction

Required. The reaction to create.

Type

google.apps.chat_v1.types.Reaction

class google.apps.chat_v1.types.CreateSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to create a named space with no members.

space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE is supported.

If you receive the error message ALREADY_EXISTS, try a different displayName. An existing space within the Google Workspace organization might already use this display name.

If you’re a member of the Developer Preview program, SpaceType.GROUP_CHAT can be used if importMode is set to true.

The space name is assigned on the server so anything specified in this field will be ignored.

Type

google.apps.chat_v1.types.Space

request_id

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

str

class google.apps.chat_v1.types.CustomEmoji(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a custom emoji.

uid

Output only. Unique key for the custom emoji resource.

Type

str

class google.apps.chat_v1.types.DeleteMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to delete a membership in a space.

name

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 and 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.

Type

str

use_admin_access

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.

Requires the chat.admin.memberships OAuth 2.0 scope.

Deleting app memberships in a space isn’t supported using admin access.

Type

bool

class google.apps.chat_v1.types.DeleteMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to delete a message.

name

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).

Type

str

force

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. Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).

Type

bool

class google.apps.chat_v1.types.DeleteReactionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Deletes a reaction to a message.

name

Required. Name of the reaction to delete.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

Type

str

class google.apps.chat_v1.types.DeleteSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for deleting a space.

name

Required. Resource name of the space to delete.

Format: spaces/{space}

Type

str

use_admin_access

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.

Requires the chat.admin.delete OAuth 2.0 scope.

Type

bool

class google.apps.chat_v1.types.DeletionMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about a deleted message. A message is deleted when delete_time is set.

deletion_type

Indicates who deleted the message.

Type

google.apps.chat_v1.types.DeletionMetadata.DeletionType

class DeletionType(value)

Bases: proto.enums.Enum

Who deleted the message and how it was deleted.

Values:

DELETION_TYPE_UNSPECIFIED (0):

This value is unused.

CREATOR (1):

User deleted their own message.

SPACE_OWNER (2):

The space owner deleted the message.

ADMIN (3):

A Google Workspace admin deleted the message.

APP_MESSAGE_EXPIRY (4):

A Chat app deleted its own message when it expired.

CREATOR_VIA_APP (5):

A Chat app deleted the message on behalf of the user.

SPACE_OWNER_VIA_APP (6):

A Chat app deleted the message on behalf of the space owner.

class google.apps.chat_v1.types.Dialog(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Wrapper around the card body of the dialog.

body

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

google.apps.card_v1.types.Card

class google.apps.chat_v1.types.DialogAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains a dialog and request status code.

dialog

Input only. Dialog for the request.

This field is a member of oneof action.

Type

google.apps.chat_v1.types.Dialog

action_status

Input only. Status for a request to either invoke or submit a dialog. Displays a status and message to users, if necessary. For example, in case of an error or success.

Type

google.apps.chat_v1.types.ActionStatus

class google.apps.chat_v1.types.DriveDataRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A reference to the data of a drive attachment.

drive_file_id

The ID for the drive file. Use with the Drive API.

Type

str

class google.apps.chat_v1.types.DriveLinkData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Data for Google Drive links.

drive_data_ref

A DriveDataRef which references a Google Drive file.

Type

google.apps.chat_v1.types.DriveDataRef

mime_type

The mime type of the linked Google Drive resource.

Type

str

class google.apps.chat_v1.types.Emoji(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An emoji that is used as a reaction to a message.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

unicode

A basic emoji represented by a unicode string.

This field is a member of oneof content.

Type

str

custom_emoji

Output only. A custom emoji.

This field is a member of oneof content.

Type

google.apps.chat_v1.types.CustomEmoji

class google.apps.chat_v1.types.EmojiReactionSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The number of people who reacted to a message with a specific emoji.

emoji

Emoji associated with the reactions.

Type

google.apps.chat_v1.types.Emoji

reaction_count

The total number of reactions using the associated emoji.

This field is a member of oneof _reaction_count.

Type

int

class google.apps.chat_v1.types.FindDirectMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to get direct message space based on the user resource.

name

Required. Resource name of the user to find direct message with.

Format: users/{user}, where {user} is either 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 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, 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.

Type

str

class google.apps.chat_v1.types.GetAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get an attachment.

name

Required. Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment}.

Type

str

class google.apps.chat_v1.types.GetMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a membership of a space.

name

Required. Resource name of the membership to retrieve.

To get the app’s own membership by using user authentication, you can optionally use spaces/{space}/members/app.

Format: spaces/{space}/members/{member} or spaces/{space}/members/app

When authenticated as a user, 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.

Type

str

use_admin_access

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.

Requires the chat.admin.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes.

Getting app memberships in a space isn’t supported when using admin access.

Type

bool

class google.apps.chat_v1.types.GetMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a message.

name

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).

Type

str

class google.apps.chat_v1.types.GetSpaceEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for getting a space event.

name

Required. The resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Type

str

class google.apps.chat_v1.types.GetSpaceReadStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetSpaceReadState API.

name

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

Type

str

class google.apps.chat_v1.types.GetSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to return a single space.

name

Required. Resource name of the space, in the form spaces/{space}.

Format: spaces/{space}

Type

str

use_admin_access

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.

Requires the chat.admin.spaces or chat.admin.spaces.readonly OAuth 2.0 scopes.

Type

bool

class google.apps.chat_v1.types.GetThreadReadStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetThreadReadStateRequest API.

name

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

Type

str

class google.apps.chat_v1.types.Group(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Google Group in Google Chat.

name

Resource name for a Google Group.

Represents a group in Cloud Identity Groups API.

Format: groups/{group}

Type

str

class google.apps.chat_v1.types.HistoryState(value)

Bases: proto.enums.Enum

The history state for messages and spaces. Specifies how long messages and conversation threads are kept after creation.

Values:

HISTORY_STATE_UNSPECIFIED (0):

Default value. Do not use.

HISTORY_OFF (1):

History off. Messages and threads are kept for 24 hours.

HISTORY_ON (2):

History on. The organization’s Vault retention rules specify for how long messages and threads are kept.

class google.apps.chat_v1.types.ListMembershipsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for listing memberships.

parent

Required. The resource name of the space for which to fetch a membership list.

Format: spaces/{space}

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

filter

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.

Type

str

show_groups

Optional. When true, also returns memberships associated with a [Google Group][google.chat.v1.Membership.group_member], in addition to other types of memberships. If a [filter][google.chat.v1.ListMembershipsRequest.filter] is set, [Google Group][google.chat.v1.Membership.group_member] memberships that don’t match the filter criteria aren’t returned.

Type

bool

show_invited

Optional. When true, also returns memberships associated with [invited][google.chat.v1.Membership.MembershipState.INVITED] members, in addition to other types of memberships. If a filter is set, [invited][google.chat.v1.Membership.MembershipState.INVITED] memberships that don’t match the filter criteria aren’t returned.

Currently requires user authentication.

Type

bool

use_admin_access

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.

Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope.

Listing app memberships in a space isn’t supported when using admin access.

Type

bool

class google.apps.chat_v1.types.ListMembershipsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to list memberships of the space.

memberships

Unordered list. List of memberships in the requested (or first) page.

Type

MutableSequence[google.apps.chat_v1.types.Membership]

next_page_token

A token that you can send as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Type

str

class google.apps.chat_v1.types.ListMessagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Lists messages in the specified space, that the user is a member of.

parent

Required. The resource name of the space to list messages from.

Format: spaces/{space}

Type

str

page_size

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.

Type

int

page_token

Optional, if resuming from a previous query.

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.

Type

str

filter

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 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.

Type

str

order_by

Optional, if resuming from a previous query.

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.

Type

str

show_deleted

Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

Type

bool

class google.apps.chat_v1.types.ListMessagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for listing messages.

messages

List of messages.

Type

MutableSequence[google.apps.chat_v1.types.Message]

next_page_token

You can send a token as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Type

str

class google.apps.chat_v1.types.ListReactionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Lists reactions to a message.

parent

Required. The message users reacted to.

Format: spaces/{space}/messages/{message}

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

filter

Optional. A query filter.

You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid) and user (user.name).

To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" 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 = "🙂" 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 = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

The following queries are invalid:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Type

str

class google.apps.chat_v1.types.ListReactionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to a list reactions request.

reactions

List of reactions in the requested (or first) page.

Type

MutableSequence[google.apps.chat_v1.types.Reaction]

next_page_token

Continuation token to retrieve the next page of results. It’s empty for the last page of results.

Type

str

class google.apps.chat_v1.types.ListSpaceEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for listing space events.

parent

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space}.

Type

str

page_size

Optional. The maximum number of space events returned. The service might return fewer than this value.

Negative values return an INVALID_ARGUMENT error.

Type

int

page_token

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.

Type

str

filter

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. 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.

Type

str

class google.apps.chat_v1.types.ListSpaceEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for listing space events.

space_events

Results are returned in chronological order (oldest event first). Note: The permissionSettings field is not returned in the Space object for list requests.

Type

MutableSequence[google.apps.chat_v1.types.SpaceEvent]

next_page_token

Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages.

Type

str

class google.apps.chat_v1.types.ListSpacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to list the spaces the caller is a member of.

page_size

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.

Type

int

page_token

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.

Type

str

filter

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.

Type

str

class google.apps.chat_v1.types.ListSpacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response for a list spaces request.

spaces

List of spaces in the requested (or first) page. Note: The permissionSettings field is not returned in the Space object for list requests.

Type

MutableSequence[google.apps.chat_v1.types.Space]

next_page_token

You can send a token as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Type

str

class google.apps.chat_v1.types.MatchedUrl(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links.

url

Output only. The URL that was matched.

Type

str

class google.apps.chat_v1.types.Membership(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Resource name of the membership, assigned by the server.

Format: spaces/{space}/members/{member}

Type

str

state

Output only. State of the membership.

Type

google.apps.chat_v1.types.Membership.MembershipState

role

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.

Type

google.apps.chat_v1.types.Membership.MembershipRole

member

The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user, the output populates the user name and type.

This field is a member of oneof memberType.

Type

google.apps.chat_v1.types.User

group_member

The Google Group the membership corresponds to.

This field is a member of oneof memberType.

Type

google.apps.chat_v1.types.Group

create_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

delete_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

class MembershipRole(value)

Bases: proto.enums.Enum

Represents a user’s permitted actions in a Chat space. More enum values might be added in the future.

Values:

MEMBERSHIP_ROLE_UNSPECIFIED (0):

Default value. For [users][google.chat.v1.Membership.member]: they aren’t a member of the space, but can be invited. For [Google Groups][google.chat.v1.Membership.group_member]: they’re always assigned this role (other enum values might be used in the future).

ROLE_MEMBER (1):

A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.

ROLE_MANAGER (2):

A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in [SpaceType.SPACE][google.chat.v1.Space.SpaceType].

class MembershipState(value)

Bases: proto.enums.Enum

Specifies the member’s relationship with a space. Other membership states might be supported in the future.

Values:

MEMBERSHIP_STATE_UNSPECIFIED (0):

Default value. Don’t use.

JOINED (1):

The user is added to the space, and can participate in the space.

INVITED (2):

The user is invited to join the space, but hasn’t joined it.

NOT_A_MEMBER (3):

The user doesn’t belong to the space and doesn’t have a pending invitation to join the space.

class google.apps.chat_v1.types.MembershipBatchCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

memberships

A list of new memberships.

Type

MutableSequence[google.apps.chat_v1.types.MembershipCreatedEventData]

class google.apps.chat_v1.types.MembershipBatchDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

memberships

A list of deleted memberships.

Type

MutableSequence[google.apps.chat_v1.types.MembershipDeletedEventData]

class google.apps.chat_v1.types.MembershipBatchUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

memberships

A list of updated memberships.

Type

MutableSequence[google.apps.chat_v1.types.MembershipUpdatedEventData]

class google.apps.chat_v1.types.MembershipCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created.

membership

The new membership.

Type

google.apps.chat_v1.types.Membership

class google.apps.chat_v1.types.MembershipDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

membership

The deleted membership. Only the name and state fields are populated.

Type

google.apps.chat_v1.types.Membership

class google.apps.chat_v1.types.MembershipUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

membership

The updated membership.

Type

google.apps.chat_v1.types.Membership

class google.apps.chat_v1.types.Message(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A message in a Google Chat space.

name

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.

Type

str

sender

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

Type

google.apps.chat_v1.types.User

create_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

last_update_time

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

Type

google.protobuf.timestamp_pb2.Timestamp

delete_time

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

Type

google.protobuf.timestamp_pb2.Timestamp

text

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a message.

Type

str

formatted_text

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 for bold, italic, strikethrough, monospace, monospace block, and bulleted list.

• User mentions using the format <users/{user}>.

• Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

• Custom emoji using the format :{emoji_name}:—for example, :smile:. This doesn’t apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

For more information, see View text formatting sent in a message

Type

str

cards

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.

Type

MutableSequence[google.apps.chat_v1.types.ContextualAddOnMarkup.Card]

cards_v2

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can’t contain cards.

To learn how to create a message that contains cards, see Send a message.

Card builder

Type

MutableSequence[google.apps.chat_v1.types.CardWithId]

annotations

Output only. Annotations associated with the text in this message.

Type

MutableSequence[google.apps.chat_v1.types.Annotation]

thread

The thread the message belongs to. For example usage, see Start or reply to a message thread.

Type

google.apps.chat_v1.types.Thread

space

If your Chat app authenticates as a user, the output populates the space name.

Type

google.apps.chat_v1.types.Space

fallback_text

A plain-text description of the message’s cards, used when the actual cards can’t be displayed—for example, mobile notifications.

Type

str

action_response

Input only. Parameters that a Chat app can use to configure how its response is posted.

Type

google.apps.chat_v1.types.ActionResponse

argument_text

Output only. Plain-text body of the message with all Chat app mentions stripped out.

Type

str

slash_command

Output only. Slash command information, if applicable.

Type

google.apps.chat_v1.types.SlashCommand

attachment

User-uploaded attachment.

Type

MutableSequence[google.apps.chat_v1.types.Attachment]

matched_url

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

Type

google.apps.chat_v1.types.MatchedUrl

thread_reply

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.

Type

bool

client_assigned_message_id

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.

Type

str

emoji_reaction_summaries

Output only. The list of emoji reaction summaries on the message.

Type

MutableSequence[google.apps.chat_v1.types.EmojiReactionSummary]

private_message_viewer

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 and omit the following:

• Attachments

• Accessory widgets

For details, see Send a message privately.

Type

google.apps.chat_v1.types.User

deletion_metadata

Output only. Information about a deleted message. A message is deleted when delete_time is set.

Type

google.apps.chat_v1.types.DeletionMetadata

quoted_message_metadata

Output only. Information about a message that’s quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

Type

google.apps.chat_v1.types.QuotedMessageMetadata

attached_gifs

Output only. GIF images that are attached to the message.

Type

MutableSequence[google.apps.chat_v1.types.AttachedGif]

accessory_widgets

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.

Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).

Type

MutableSequence[google.apps.chat_v1.types.AccessoryWidget]

class google.apps.chat_v1.types.MessageBatchCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

messages

A list of new messages.

Type

MutableSequence[google.apps.chat_v1.types.MessageCreatedEventData]

class google.apps.chat_v1.types.MessageBatchDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

messages

A list of deleted messages.

Type

MutableSequence[google.apps.chat_v1.types.MessageDeletedEventData]

class google.apps.chat_v1.types.MessageBatchUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

messages

A list of updated messages.

Type

MutableSequence[google.apps.chat_v1.types.MessageUpdatedEventData]

class google.apps.chat_v1.types.MessageCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

message

The new message.

Type

google.apps.chat_v1.types.Message

class google.apps.chat_v1.types.MessageDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

message

The deleted message. Only the name, createTime, deleteTime, and deletionMetadata fields are populated.

Type

google.apps.chat_v1.types.Message

class google.apps.chat_v1.types.MessageUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

message

The updated message.

Type

google.apps.chat_v1.types.Message

class google.apps.chat_v1.types.QuotedMessageMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about a quoted message.

name

Output only. Resource name of the quoted message.

Format: spaces/{space}/messages/{message}

Type

str

last_update_time

Output only. The timestamp when the quoted message was created or when the quoted message was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.chat_v1.types.Reaction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A reaction to a message.

name

The resource name of the reaction.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

Type

str

user

Output only. The user who created the reaction.

Type

google.apps.chat_v1.types.User

emoji

The emoji used in the reaction.

Type

google.apps.chat_v1.types.Emoji

class google.apps.chat_v1.types.ReactionBatchCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

reactions

A list of new reactions.

Type

MutableSequence[google.apps.chat_v1.types.ReactionCreatedEventData]

class google.apps.chat_v1.types.ReactionBatchDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

reactions

A list of deleted reactions.

Type

MutableSequence[google.apps.chat_v1.types.ReactionDeletedEventData]

class google.apps.chat_v1.types.ReactionCreatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

reaction

The new reaction.

Type

google.apps.chat_v1.types.Reaction

class google.apps.chat_v1.types.ReactionDeletedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for a deleted reaction.

Type: google.workspace.chat.reaction.v1.deleted

reaction

The deleted reaction.

Type

google.apps.chat_v1.types.Reaction

class google.apps.chat_v1.types.RichLinkMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A rich link to a resource.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

uri

The URI of this link.

Type

str

rich_link_type

The rich link type.

Type

google.apps.chat_v1.types.RichLinkMetadata.RichLinkType

drive_link_data

Data for a drive link.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.DriveLinkData

chat_space_link_data

Data for a chat space link.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.ChatSpaceLinkData

class RichLinkType(value)

Bases: proto.enums.Enum

The rich link type. More types might be added in the future.

Values:

RICH_LINK_TYPE_UNSPECIFIED (0):

Default value for the enum. Don’t use.

DRIVE_FILE (1):

A Google Drive rich link type.

CHAT_SPACE (2):

A Chat space rich link type. For example, a space smart chip.

class google.apps.chat_v1.types.SearchSpacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to search for a list of spaces based on a query.

use_admin_access

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.

Requires either the chat.admin.spaces.readonly or chat.admin.spaces OAuth 2.0 scope.

This method currently only supports admin access, thus only true is accepted for this field.

Type

bool

page_size

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.

Type

int

page_token

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.

Type

str

query

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 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")

Type

str

order_by

Optional. How the list of spaces is ordered.

Supported attributes to order by are:

• membership_count.joined_direct_human_user_count — Denotes the count of human users that have directly joined a space.

• last_active_time — Denotes the time when last eligible item is added to any topic of this space.

• create_time — 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

Type

str

class google.apps.chat_v1.types.SearchSpacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response with a list of spaces corresponding to the search spaces request.

spaces

A page of the requested spaces.

Type

MutableSequence[google.apps.chat_v1.types.Space]

next_page_token

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

Type

str

total_size

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.

Type

int

class google.apps.chat_v1.types.SetUpSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a space and add specified users to it.

space

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

google.apps.chat_v1.types.Space

request_id

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

str

memberships

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 20 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).

Type

MutableSequence[google.apps.chat_v1.types.Membership]

class google.apps.chat_v1.types.SlashCommand(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A slash command in Google Chat.

command_id

The ID of the slash command invoked.

Type

int

class google.apps.chat_v1.types.SlashCommandMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Annotation metadata for slash commands (/).

bot

The Chat app whose command was invoked.

Type

google.apps.chat_v1.types.User

type_

The type of slash command.

Type

google.apps.chat_v1.types.SlashCommandMetadata.Type

command_name

The name of the invoked slash command.

Type

str

command_id

The command ID of the invoked slash command.

Type

int

triggers_dialog

Indicates whether the slash command is for a dialog.

Type

bool

class Type(value)

Bases: proto.enums.Enum

Values:

TYPE_UNSPECIFIED (0):

Default value for the enum. Don’t use.

ADD (1):

Add Chat app to space.

INVOKE (2):

Invoke slash command in space.

class google.apps.chat_v1.types.Space(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

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

str

type_

Output only. Deprecated: Use space_type instead. The type of a space.

Type

google.apps.chat_v1.types.Space.Type

space_type

The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.

Type

google.apps.chat_v1.types.Space.SpaceType

single_user_bot_dm

Optional. Whether the space is a DM between a Chat app and a single human.

Type

bool

threaded

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

Type

bool

display_name

The space’s display name. Required when creating a space 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

str

external_user_allowed

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

bool

space_threading_state

Output only. The threading state in the Chat space.

Type

google.apps.chat_v1.types.Space.SpaceThreadingState

space_details

Details about the space including description and rules.

Type

google.apps.chat_v1.types.Space.SpaceDetails

space_history_state

The message history state for messages and threads in this space.

Type

google.apps.chat_v1.types.HistoryState

import_mode

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.

Type

bool

create_time

Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

Only populated in the output when spaceType is GROUP_CHAT or SPACE.

Type

google.protobuf.timestamp_pb2.Timestamp

last_active_time

Output only. Timestamp of the last message in the space.

Type

google.protobuf.timestamp_pb2.Timestamp

admin_installed

Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.

To support admin install, your Chat app must feature direct messaging.

Type

bool

membership_count

Output only. The count of joined memberships grouped by member type. Populated when the space_type is SPACE, DIRECT_MESSAGE or GROUP_CHAT.

Type

google.apps.chat_v1.types.Space.MembershipCount

access_settings

Optional. Specifies the access setting of the space. Only populated when the space_type is SPACE.

Type

google.apps.chat_v1.types.Space.AccessSettings

space_uri

Output only. The URI for a user to access the space.

Type

str

predefined_permission_settings

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.

This field is a member of oneof space_permission_settings.

Type

google.apps.chat_v1.types.Space.PredefinedPermissionSettings

permission_settings

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.

This field is a member of oneof space_permission_settings.

Type

google.apps.chat_v1.types.Space.PermissionSettings

class AccessSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the access setting of the space.

access_state

Output only. Indicates the access state of the space.

Type

google.apps.chat_v1.types.Space.AccessSettings.AccessState

audience

Optional. The resource name of the target audience 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.

Format: audiences/{audience}

To use the default target audience for the Google Workspace organization, set to audiences/default.

This field is not populated when using the chat.bot scope with app authentication.

Type

str

class AccessState(value)

Bases: proto.enums.Enum

Represents the access state of the space.

Values:

ACCESS_STATE_UNSPECIFIED (0):

Access state is unknown or not supported in this API.

PRIVATE (1):

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.

DISCOVERABLE (2):

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.

class MembershipCount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the count of memberships of a space, grouped into categories.

joined_direct_human_user_count

Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.

Type

int

joined_group_count

Count of all groups that have directly joined the space.

Type

int

class PermissionSetting(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a space permission setting.

managers_allowed

Whether spaces managers have this permission.

Type

bool

members_allowed

Whether non-manager members have this permission.

Type

bool

class PermissionSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Permission settings 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.

manage_members_and_groups

Setting for managing members and groups in a space.

This field is a member of oneof _manage_members_and_groups.

Type

google.apps.chat_v1.types.Space.PermissionSetting

modify_space_details

Setting for updating space name, avatar, description and guidelines.

This field is a member of oneof _modify_space_details.

Type

google.apps.chat_v1.types.Space.PermissionSetting

toggle_history

Setting for toggling space history on and off.

This field is a member of oneof _toggle_history.

Type

google.apps.chat_v1.types.Space.PermissionSetting

use_at_mention_all

Setting for using @all in a space.

This field is a member of oneof _use_at_mention_all.

Type

google.apps.chat_v1.types.Space.PermissionSetting

manage_apps

Setting for managing apps in a space.

This field is a member of oneof _manage_apps.

Type

google.apps.chat_v1.types.Space.PermissionSetting

manage_webhooks

Setting for managing webhooks in a space.

This field is a member of oneof _manage_webhooks.

Type

google.apps.chat_v1.types.Space.PermissionSetting

post_messages

Output only. Setting for posting messages in a space.

This field is a member of oneof _post_messages.

Type

google.apps.chat_v1.types.Space.PermissionSetting

reply_messages

Setting for replying to messages in a space.

This field is a member of oneof _reply_messages.

Type

google.apps.chat_v1.types.Space.PermissionSetting

class PredefinedPermissionSettings(value)

Bases: proto.enums.Enum

Predefined permission settings that you can only specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces.

Values:

PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED (0):

Unspecified. Don’t use.

COLLABORATION_SPACE (1):

Setting to make the space a collaboration space where all members can post messages.

ANNOUNCEMENT_SPACE (2):

Setting to make the space an announcement space where only space managers can post messages.

class SpaceDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Details about the space including description and rules.

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

str

guidelines

Optional. The space’s rules, expectations, and etiquette. Supports up to 5,000 characters.

Type

str

class SpaceThreadingState(value)

Bases: proto.enums.Enum

Specifies the type of threading state in the Chat space.

Values:

SPACE_THREADING_STATE_UNSPECIFIED (0):

Reserved.

THREADED_MESSAGES (2):

Named 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.

GROUPED_MESSAGES (3):

Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.

UNTHREADED_MESSAGES (4):

Direct messages (DMs) between two people and group conversations between 3 or more people.

class SpaceType(value)

Bases: proto.enums.Enum

The type of space. Required when creating or updating a space. Output only for other usage.

Values:

SPACE_TYPE_UNSPECIFIED (0):

Reserved.

SPACE (1):

A place where people send messages, share files, and collaborate. A SPACE can include Chat apps.

GROUP_CHAT (2):

Group conversations between 3 or more people. A GROUP_CHAT can include Chat apps.

DIRECT_MESSAGE (3):

1:1 messages between two humans or a human and a Chat app.

class Type(value)

Bases: proto.enums.Enum

Deprecated: Use SpaceType instead.

Values:

TYPE_UNSPECIFIED (0):

Reserved.

ROOM (1):

Conversations between two or more humans.

DM (2):

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.

class google.apps.chat_v1.types.SpaceBatchUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

spaces

A list of updated spaces.

Type

MutableSequence[google.apps.chat_v1.types.SpaceUpdatedEventData]

class google.apps.chat_v1.types.SpaceEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Type

str

event_time

Time when the event occurred.

Type

google.protobuf.timestamp_pb2.Timestamp

event_type

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:

* 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:

• 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:

• 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:

• Updated space: google.workspace.chat.space.v1.updated

• Multiple space updates: google.workspace.chat.space.v1.batchUpdated

Type

str

message_created_event_data

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageCreatedEventData

message_updated_event_data

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageUpdatedEventData

message_deleted_event_data

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageDeletedEventData

message_batch_created_event_data

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageBatchCreatedEventData

message_batch_updated_event_data

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageBatchUpdatedEventData

message_batch_deleted_event_data

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MessageBatchDeletedEventData

space_updated_event_data

Event payload for a space update.

Event type: google.workspace.chat.space.v1.updated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.SpaceUpdatedEventData

space_batch_updated_event_data

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.SpaceBatchUpdatedEventData

membership_created_event_data

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipCreatedEventData

membership_updated_event_data

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipUpdatedEventData

membership_deleted_event_data

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipDeletedEventData

membership_batch_created_event_data

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipBatchCreatedEventData

membership_batch_updated_event_data

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipBatchUpdatedEventData

membership_batch_deleted_event_data

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.MembershipBatchDeletedEventData

reaction_created_event_data

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.ReactionCreatedEventData

reaction_deleted_event_data

Event payload for a deleted reaction.

Event type: google.workspace.chat.reaction.v1.deleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.ReactionDeletedEventData

reaction_batch_created_event_data

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.ReactionBatchCreatedEventData

reaction_batch_deleted_event_data

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

This field is a member of oneof payload.

Type

google.apps.chat_v1.types.ReactionBatchDeletedEventData

class google.apps.chat_v1.types.SpaceReadState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user’s read state within a space, used to identify read and unread messages.

name

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

Type

str

last_read_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.chat_v1.types.SpaceUpdatedEventData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

space

The updated space.

Type

google.apps.chat_v1.types.Space

class google.apps.chat_v1.types.Thread(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A thread in a Google Chat space. For example usage, see Start or reply to a 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.

name

Resource name of the thread.

Example: spaces/{space}/threads/{thread}

Type

str

thread_key

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

str

class google.apps.chat_v1.types.ThreadReadState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user’s read state within a thread, used to identify read and unread messages.

name

Resource name of the thread read state.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Type

str

last_read_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.apps.chat_v1.types.UpdateMembershipRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for updating a membership.

membership

Required. The membership to update. Only fields specified by update_mask are updated.

Type

google.apps.chat_v1.types.Membership

update_mask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

• role

Type

google.protobuf.field_mask_pb2.FieldMask

use_admin_access

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.

Requires the chat.admin.memberships OAuth 2.0 scope.

Type

bool

class google.apps.chat_v1.types.UpdateMessageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a message.

message

Required. Message with fields updated.

Type

google.apps.chat_v1.types.Message

update_mask

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.)

• cards_v2 (Requires app authentication.)

• accessory_widgets (Requires app authentication.)

Type

google.protobuf.field_mask_pb2.FieldMask

allow_missing

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 or the request fails.

Type

bool

class google.apps.chat_v1.types.UpdateSpaceReadStateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateSpaceReadState API.

space_read_state

Required. The space read state and fields to update.

Only supports updating 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

Type

google.apps.chat_v1.types.SpaceReadState

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.apps.chat_v1.types.UpdateSpaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to update a single space.

space

Required. Space with fields to be updated. Space.name must be populated in the form of spaces/{space}. Only fields specified by update_mask are updated.

Type

google.apps.chat_v1.types.Space

update_mask

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. Supports up to 150 characters.

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 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 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. To learn more, see Make a space discoverable to specific users. access_settings.audience is not supported with useAdminAccess.

permission_settings: Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess. 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

Type

google.protobuf.field_mask_pb2.FieldMask

use_admin_access

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.

Requires the chat.admin.spaces OAuth 2.0 scope.

Some FieldMask values are not supported using admin access. For details, see the description of update_mask.

Type

bool

class google.apps.chat_v1.types.UploadAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to upload an attachment.

parent

Required. Resource name of the Chat space in which the attachment is uploaded. Format “spaces/{space}”.

Type

str

filename

Required. The filename of the attachment, including the file extension.

Type

str

class google.apps.chat_v1.types.UploadAttachmentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of uploading an attachment.

attachment_data_ref

Reference to the uploaded attachment.

Type

google.apps.chat_v1.types.AttachmentDataRef

class google.apps.chat_v1.types.User(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user, the output for a User resource only populates the user’s name and type.

name

Resource name for a Google Chat [user][google.chat.v1.User].

Format: users/{user}. users/app can be used as an alias for the calling app [bot][google.chat.v1.User.Type.BOT] user.

For [human users][google.chat.v1.User.Type.HUMAN], {user} is the same user identifier as:

• the id for the Person 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 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

str

display_name

Output only. The user’s display name.

Type

str

domain_id

Unique identifier of the user’s Google Workspace domain.

Type

str

type_

User type.

Type

google.apps.chat_v1.types.User.Type

is_anonymous

Output only. When true, the user is deleted or their profile is not visible.

Type

bool

class Type(value)

Bases: proto.enums.Enum

Values:

TYPE_UNSPECIFIED (0):

Default value for the enum. DO NOT USE.

HUMAN (1):

Human user.

BOT (2):

Chat app user.

class google.apps.chat_v1.types.UserMentionMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Annotation metadata for user mentions (@).

user

The user mentioned.

Type

google.apps.chat_v1.types.User

type_

The type of user mention.

Type

google.apps.chat_v1.types.UserMentionMetadata.Type

class Type(value)

Bases: proto.enums.Enum

Values:

TYPE_UNSPECIFIED (0):

Default value for the enum. Don’t use.

ADD (1):

Add user to space.

MENTION (2):

Mention user in space.

class google.apps.chat_v1.types.WidgetMarkup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A widget is a UI element that presents text and images.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text_paragraph

Display a text paragraph in this widget.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.WidgetMarkup.TextParagraph

image

Display an image in this widget.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.WidgetMarkup.Image

key_value

Display a key value item in this widget.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.WidgetMarkup.KeyValue

buttons

A list of buttons. Buttons is also oneof data and only one of these fields should be set.

Type

MutableSequence[google.apps.chat_v1.types.WidgetMarkup.Button]

class Button(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A button. Can be a text button or an image button.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text_button

A button with text and onclick action.

This field is a member of oneof type.

Type

google.apps.chat_v1.types.WidgetMarkup.TextButton

image_button

A button with image and onclick action.

This field is a member of oneof type.

Type

google.apps.chat_v1.types.WidgetMarkup.ImageButton

class FormAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

action_method_name

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

str

parameters

List of action parameters.

Type

MutableSequence[google.apps.chat_v1.types.WidgetMarkup.FormAction.ActionParameter]

class ActionParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

key

The name of the parameter for the action script.

Type

str

value

The value of the parameter.

Type

str

class Icon(value)

Bases: proto.enums.Enum

The set of supported icons.

Values:

ICON_UNSPECIFIED (0):

No description available.

AIRPLANE (1):

No description available.

BOOKMARK (26):

No description available.

BUS (25):

No description available.

CAR (9):

No description available.

CLOCK (2):

No description available.

CONFIRMATION_NUMBER_ICON (12):

No description available.

DOLLAR (14):

No description available.

DESCRIPTION (27):

No description available.

EMAIL (10):

No description available.

EVENT_PERFORMER (20):

No description available.

EVENT_SEAT (21):

No description available.

FLIGHT_ARRIVAL (16):

No description available.

FLIGHT_DEPARTURE (15):

No description available.

HOTEL (6):

No description available.

HOTEL_ROOM_TYPE (17):

No description available.

INVITE (19):

No description available.

MAP_PIN (3):

No description available.

MEMBERSHIP (24):

No description available.

MULTIPLE_PEOPLE (18):

No description available.

OFFER (30):

No description available.

PERSON (11):

No description available.

PHONE (13):

No description available.

RESTAURANT_ICON (7):

No description available.

SHOPPING_CART (8):

No description available.

STAR (5):

No description available.

STORE (22):

No description available.

TICKET (4):

No description available.

TRAIN (23):

No description available.

VIDEO_CAMERA (28):

No description available.

VIDEO_PLAY (29):

No description available.

class Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An image that’s specified by a URL and can have an onclick action.

image_url

The URL of the image.

Type

str

on_click

The onclick action.

Type

google.apps.chat_v1.types.WidgetMarkup.OnClick

aspect_ratio

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.

Type

float

class ImageButton(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An image button with an onclick action.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

icon

The icon specified by an enum that indices to an icon provided by Chat API.

This field is a member of oneof icons.

Type

google.apps.chat_v1.types.WidgetMarkup.Icon

icon_url

The icon specified by a URL.

This field is a member of oneof icons.

Type

str

on_click

The onclick action.

Type

google.apps.chat_v1.types.WidgetMarkup.OnClick

name

The name of this image_button that’s used for accessibility. Default value is provided if this name isn’t specified.

Type

str

class KeyValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

icon

An enum value that’s replaced by the Chat API with the corresponding icon image.

This field is a member of oneof icons.

Type

google.apps.chat_v1.types.WidgetMarkup.Icon

icon_url

The icon specified by a URL.

This field is a member of oneof icons.

Type

str

top_label

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Type

str

content

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Type

str

content_multiline

If the content should be multiline.

Type

bool

bottom_label

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Type

str

on_click

The onclick action. Only the top label, bottom label, and content region are clickable.

Type

google.apps.chat_v1.types.WidgetMarkup.OnClick

button

A button that can be clicked to trigger an action.

This field is a member of oneof control.

Type

google.apps.chat_v1.types.WidgetMarkup.Button

class OnClick(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An onclick action (for example, open a link).

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

action

A form action is triggered by this onclick action if specified.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.WidgetMarkup.FormAction

open_link

This onclick action triggers an open link action if specified.

This field is a member of oneof data.

Type

google.apps.chat_v1.types.WidgetMarkup.OpenLink

class OpenLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A link that opens a new window.

url

The URL to open.

Type

str

class TextButton(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A button with text and onclick action.

text

The text of the button.

Type

str

on_click

The onclick action of the button.

Type

google.apps.chat_v1.types.WidgetMarkup.OnClick

class TextParagraph(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

text

Type

str