Package google.chat.v1

The import mode space.

ContextualAddOnMarkup

Этот тип не содержит полей.

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

Карта

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

Поля
`header`	`CardHeader` The header of the card. A header usually contains a title and an image.
`sections[]`	`Section` Sections are separated by a line divider.
`card_actions[]`	`CardAction` The actions of this card.
`name`	`string` Name of the card.

CardAction

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

string

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

on_click

OnClick

The onclick action for this action item.

CardHeader

Поля
`title`	`string` 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.
`subtitle`	`string` The subtitle of the card header.
`image_style`	`ImageStyle` The image's type (for example, square border or circular border).
`image_url`	`string` The URL of the image in the card header.

ImageStyle

Перечисления
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Square border.
`AVATAR`	Circular border.

Раздел

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

string

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 .

widgets[]

WidgetMarkup

A section must contain at least one widget.

CreateCustomEmojiRequest

A request to create a custom emoji.

Поля

custom_emoji

Required. The custom emoji to create.

CreateMembershipRequest

Request message for creating a membership.

Поля

parent

string

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

Формат: пробелы/{пробел}

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 certain authorization scopes and set specific values for certain fields:

When authenticating as a user , the chat.memberships authorization scope is required.
When authenticating as an app , the chat.app.memberships authorization scope is required.
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 .

Inviting users external to the Workspace organization that owns the space requires user authentication .

When a Chat app creates a membership relation for itself, it must authenticate as a user and use the chat.memberships.app scope, set user.type to BOT , and set user.name to users/app .

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

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.

CreateMessageRequest

Creates a message.

Поля
`parent`	`string` Required. The resource name of the space in which to create a message. Формат: `spaces/{space}`
`message`	`Message` Required. Message body.
`thread_key (deprecated)`	`string` Этот товар устарел! Optional. Deprecated: Use `thread.thread_key` instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the `thread.name` . For example usage, see Start or reply to a message thread .
`request_id`	`string` 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.
`message_reply_option`	`MessageReplyOption` Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When responding to user interactions , this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread.
`message_id`	`string` 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 .

MessageReplyOption

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

Перечисления
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	Default. Starts a new thread. Using this option ignores any `thread ID` or `thread_key` that's included.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Creates the message as a reply to the thread specified by `thread ID` or `thread_key` . If it fails, the message starts a new thread instead.
`REPLY_MESSAGE_OR_FAIL`	Creates the message as a reply to the thread specified by `thread ID` or `thread_key` . If a new `thread_key` is used, a new thread is created. If the message creation fails, a `NOT_FOUND` error is returned instead.

CreateReactionRequest

Creates a reaction to a message.

Поля

parent

string

Required. The message where the reaction is created.

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

reaction

Required. The reaction to create.

CreateSectionRequest

Request message for creating a section.

Поля

parent

string

Required. The parent resource name where the section is created.

Format: users/{user}

section

Required. The section to create.

CreateSpaceRequest

A request to create a named space with no members.

Поля

space

Required. The displayName and spaceType fields must be populated. Only SpaceType.SPACE and SpaceType.GROUP_CHAT are supported. SpaceType.GROUP_CHAT can only be used if importMode is set to true.

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.

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

request_id

string

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.

CustomEmoji

Represents a custom emoji .

Поля
`name`	`string` Identifier. The resource name of the custom emoji, assigned by the server. Format: `customEmojis/{customEmoji}`
`uid`	`string` Output only. Unique key for the custom emoji resource.
`emoji_name`	`string` Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
`temporary_image_uri`	`string` Output only. A temporary image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created.
`payload`	`CustomEmojiPayload` Optional. Input only. Payload data. Required when the custom emoji is created.

CustomEmojiPayload

Payload data for the custom emoji.

Поля

file_content

bytes

Required. Input only. The image used for the custom emoji.

The payload must be under 256 KB and the dimension of the image must be square and between 64 and 500 pixels. The restrictions are subject to change.

filename

string

Required. Input only. The image file name.

Supported file extensions: .png , .jpg , .gif .

CustomEmojiMetadata

Annotation metadata for custom emoji.

Поля

custom_emoji

The custom emoji.

DeleteCustomEmojiRequest

Request for deleting a custom emoji.

Поля

name

string

Required. Resource name of the custom emoji to delete.

Format: customEmojis/{customEmoji}

You can use the emoji name as an alias for {customEmoji} . For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

DeleteMembershipRequest

Request to delete a membership in a space.

Поля

name

string

Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships.

When deleting a human membership, requires the chat.memberships scope with user authentication or the chat.memberships.app scope with app authentication and the spaces/{space}/members/{member} format. You can use the email as an alias for {member} . For example, spaces/{space}/members/example@gmail.com where example@gmail.com is the email of the Google Chat user.

When deleting an app membership, requires the chat.memberships.app scope and spaces/{space}/members/app format.

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

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

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

DeleteMessageRequest

Request to delete a message.

Поля

name

string

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 .

force

bool

Optional. When true , deleting a message also deletes its threaded replies. When false , if a message has threaded replies, deletion fails.

Only applies when authenticating as a user . Has no effect when authenticating as a Chat app .

DeleteReactionRequest

Удаляет реакцию на сообщение.

Поля

name

string

Required. Name of the reaction to delete.

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

DeleteSectionRequest

Request message for deleting a section.

Поля

name

string

Required. The name of the section to delete.

Format: users/{user}/sections/{section}

DeleteSpaceRequest

Request for deleting a space.

Поля

name

string

Required. Resource name of the space to delete.

Формат: spaces/{space}

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.delete OAuth 2.0 scope .

DeletionMetadata

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

Поля

deletion_type

DeletionType

Indicates who deleted the message.

DeletionType

Who deleted the message and how it was deleted. More values may be added in the future. See Edit or delete a message in Google Chat for details on when messages can be deleted.

Перечисления
`DELETION_TYPE_UNSPECIFIED`	This value is unused.
`CREATOR`	User deleted their own message.
`SPACE_OWNER`	An owner or manager deleted the message.
`ADMIN`	A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.
`APP_MESSAGE_EXPIRY`	A Chat app deleted its own message when it expired.
`CREATOR_VIA_APP`	A Chat app deleted the message on behalf of the creator (using user authentication).
`SPACE_OWNER_VIA_APP`	A Chat app deleted the message on behalf of a space manager (using user authentication).
`SPACE_MEMBER`	A member of the space deleted the message. Users can delete messages sent by apps.

Диалог

Wrapper around the card body of the dialog.

Поля

body

Card

Input only. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: DateTimePicker , OnChangeAction .

DialogAction

Contains a dialog and request status code.

Поля

action_status

ActionStatus

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.

Union field action . Action to perform. action can be only one of the following:

dialog

Dialog

Input only. Dialog for the request.

DriveDataRef

A reference to the data of a drive attachment.

Поля

drive_file_id

string

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

DriveLinkData

Data for Google Drive links.

Поля

drive_data_ref

DriveDataRef

A DriveDataRef which references a Google Drive file.

mime_type

string

The mime type of the linked Google Drive resource.

Эмодзи

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

Поля

Union field content . Required. The content of the emoji. content can be only one of the following:

unicode

string

Optional. A basic emoji represented by a unicode string.

custom_emoji

A custom emoji.

EmojiReactionSummary

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

Поля

emoji

Emoji

Output only. Emoji associated with the reactions.

reaction_count

int32

Output only. The total number of reactions using the associated emoji.

FindDirectMessageRequest

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

Поля

name

string

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.

FindGroupChatsRequest

A request to get group chat spaces based on user resources.

Поля
`user[] (deprecated)`	`string` Этот товар устарел! Необязательно. Устарело: используйте вместо этого поле `users` . Имена ресурсов всех пользователей, участвующих в групповом чате с вызывающим пользователем. Приложения для чата не могут быть включены в запрос. Максимальное количество пользователей, которое можно указать в одном запросе, составляет `49` . Формат: `users/{user}` , где `{user}` — это либо `id` пользователя из People API, либо `id` пользователя в Directory API. Например, чтобы найти все групповые чаты с вызывающим пользователем и двумя другими пользователями, имеющими идентификаторы профилей People API `123456789` и `987654321` , можно использовать `users/123456789` и `users/987654321` . Вы также можете использовать адрес электронной почты в качестве псевдонима для `{user}` . Например, `users/example@gmail.com` , где `example@gmail.com` — это адрес электронной почты пользователя Google Chat.
`users[]`	`string` Необязательно. Имена ресурсов всех пользователей, участвующих в групповом чате с вызывающим пользователем. Приложения для чата в запрос не включаются. Максимальное количество пользователей, которое можно указать в одном запросе, составляет `49` . Формат: `users/{user}` , где `{user}` — это либо `id` пользователя из People API, либо `id` пользователя в Directory API. Например, чтобы найти все групповые чаты с вызывающим пользователем и двумя другими пользователями, имеющими идентификаторы профилей People API `123456789` и `987654321` , можно использовать `users/123456789` и `users/987654321` . Вы также можете использовать адрес электронной почты в качестве псевдонима для `{user}` . Например, `users/example@gmail.com` , где `example@gmail.com` — это адрес электронной почты пользователя Google Chat.
`page_size`	`int32` Необязательный параметр. Максимальное количество возвращаемых символов. Сервис может вернуть меньшее значение. Если параметр не указан, возвращается не более 100 символов. Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения приводят к ошибке `INVALID_ARGUMENT` .
`page_token`	`string` Необязательный параметр. Токен страницы, полученный из предыдущего запроса на поиск групповых чатов. Укажите этот параметр, чтобы получить следующую страницу. При использовании пагинации все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен. Передача других значений может привести к неожиданным результатам.
`space_view`	`SpaceView` Запрашиваемый тип представления пространства. Если не задано, по умолчанию используется `SPACE_VIEW_RESOURCE_NAME_ONLY` . Запросы, указывающие `SPACE_VIEW_EXPANDED` , должны включать области действия, разрешающие чтение данных пространства, например, https://www.googleapis.com/auth/chat.spaces или https://www.googleapis.com/auth/chat.spaces.readonly .

FindGroupChatsResponse

Ответ, содержащий разделы группового чата с указанием имени вызывающего пользователя и запрошенных пользователей.

Поля

spaces[]

Список пробелов на запрошенной (или первой) странице.

next_page_token

string

Токен, который можно отправить в качестве pageToken для получения следующей страницы результатов. Если он пуст, последующих страниц нет.

ForwardedMetadata

Metadata about the source space from which a message was forwarded.

Поля

space

string

Output only. The resource name of the source space. Format: spaces/{space}

space_display_name

string

Output only. The display name of the source space or DM at the time of forwarding. For SPACE , this is the space name. For DIRECT_MESSAGE , this is the other participant's name (eg, "User A"). For GROUP_CHAT , this is a generated name based on members' first names, limited to 5 including the creator (eg, "User A, User B").

GetAttachmentRequest

Request to get an attachment.

Поля

name

string

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

GetCustomEmojiRequest

A request to return a single custom emoji.

Поля

name

string

Required. Resource name of the custom emoji.

Format: customEmojis/{customEmoji}

You can use the emoji name as an alias for {customEmoji} . For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

GetMembershipRequest

Request to get a membership of a space.

Поля

name

string

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

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.

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

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.

GetMessageRequest

Request to get a message.

Поля

name

string

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 .

GetSpaceEventRequest

Request message for getting a space event.

Поля

name

string

Required. The resource name of the space event.

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

GetSpaceNotificationSettingRequest

Request message to get space notification setting. Only supports getting notification setting for the calling user.

Поля

name

string

Required. Format: users/{user}/spaces/{space}/spaceNotificationSetting

users/me/spaces/{space}/spaceNotificationSetting , OR
users/user@example.com/spaces/{space}/spaceNotificationSetting , OR
users/123456789/spaces/{space}/spaceNotificationSetting . Note: Only the caller's user id or email is allowed in the path.

GetSpaceReadStateRequest

Request message for GetSpaceReadState API.

Поля

name

string

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

GetSpaceRequest

A request to return a single space.

Поля

name

string

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

Формат: spaces/{space}

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

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

GetThreadReadStateRequest

Request message for GetThreadReadStateRequest API.

Поля

name

string

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

Группа

A Google Group in Google Chat.

Поля

name

string

Resource name for a Google Group.

Represents a group in Cloud Identity Groups API.

Format: groups/{group}

ИсторияШтата

История сообщений и пространств. Указывает, как долго сообщения и цепочки бесед сохраняются после создания.

Перечисления
`HISTORY_STATE_UNSPECIFIED`	Значение по умолчанию. Не использовать.
`HISTORY_OFF`	История сообщений отключена. Сообщения и ветки обсуждений сохраняются в течение 24 часов .
`HISTORY_ON`	История продолжается. Правила хранения данных в хранилище организации определяют, как долго хранятся сообщения и переписки.

ListCustomEmojisRequest

A request to return a list of custom emojis.

Поля

page_size

int32

Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

page_token

string

Optional. (If resuming from a previous query.)

A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

filter

string

Optional. A query filter.

Supports filtering by creator.

To filter by creator, you must specify a valid value. Currently only creator("users/me") and NOT creator("users/me") are accepted to filter custom emojis by whether they were created by the calling user or not.

For example, the following query returns custom emojis created by the caller:

creator("users/me")

Invalid queries are rejected with an INVALID_ARGUMENT error.

ListCustomEmojisResponse

A response to list custom emojis.

Поля

custom_emojis[]

Unordered list. List of custom emojis.

next_page_token

string

ListMembershipsRequest

Request message for listing memberships.

Поля
`parent`	`string` Required. The resource name of the space for which to fetch a membership list. Формат: пробелы/{пробел}
`page_size`	`int32` Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения приводят к ошибке `INVALID_ARGUMENT` .
`page_token`	`string` 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.
`filter`	`string` Optional. A query filter. You can filter memberships by a member's role ( `role` ) and type ( `member.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.
`show_groups`	`bool` Optional. When `true` , also returns memberships associated with a `Google Group` , in addition to other types of memberships. If a `filter` is set, `Google Group` memberships that don't match the filter criteria aren't returned.
`show_invited`	`bool` Optional. When `true` , also returns memberships associated with `invited` members, in addition to other types of memberships. If a filter is set, `invited` memberships that don't match the filter criteria aren't returned. Currently requires user authentication .
`use_admin_access`	`bool` Optional. When `true` , the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . 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.

ListMembershipsResponse

Response to list memberships of the space.

Поля

memberships[]

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

next_page_token

string

ListMessagesRequest

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

Поля
`parent`	`string` Required. The resource name of the space to list messages from. Формат: `spaces/{space}`
`page_size`	`int32` Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения приводят к ошибке `INVALID_ARGUMENT` .
`page_token`	`string` Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
`filter`	`string` Optional. A query filter. You can filter messages by date ( `create_time` ) and thread ( `thread.name` ). To filter messages by the date they were created, specify the `create_time` with a timestamp in RFC-3339 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.
`order_by`	`string` Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: `ASC` for ascending. `DESC` for descending. The default ordering is `create_time ASC` .
`show_deleted`	`bool` Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

ListMessagesResponse

Response message for listing messages.

Поля

messages[]

List of messages.

next_page_token

string

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

ListReactionsRequest

Содержит список реакций на сообщение.

Поля
`parent`	`string` Required. The message users reacted to. Format: `spaces/{space}/messages/{message}`
`page_size`	`int32` 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.
`page_token`	`string` 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.
`filter`	`string` 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 with an `INVALID_ARGUMENT` error.

ListReactionsResponse

Response to a list reactions request.

Поля

reactions[]

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

next_page_token

string

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

ListSectionItemsRequest

Request message for listing section items.

Поля
`parent`	`string` Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-` . Format: `users/{user}/sections/{section}`
`page_size`	`int32` Optional. The maximum number of section items to return. The service may return fewer than this value. If unspecified, at most 10 section items will be returned. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. Отрицательные значения приводят к ошибке `INVALID_ARGUMENT` .
`page_token`	`string` Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
`filter`	`string` Optional. A query filter. Currently only supports filtering by space. For example, `space = spaces/{space}` . Invalid queries are rejected with an `INVALID_ARGUMENT` error.

ListSectionItemsResponse

Response message for listing section items.

Поля

section_items[]

SectionItem

The section items from the specified section.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSectionsRequest

Request message for listing sections.

Поля

parent

string

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

The me alias. For example, users/me .
Their Workspace email address. For example, users/user@example.com .
Their user id. For example, users/123456789 .

Format: users/{user}

page_size

int32

Optional. The maximum number of sections to return. The service may return fewer than this value.

If unspecified, at most 10 sections will be returned.

The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.

Отрицательные значения приводят к ошибке INVALID_ARGUMENT .

page_token

string

Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

ListSectionsResponse

Response message for listing sections.

Поля

sections[]

The sections from the specified user.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSpaceEventsRequest

Request message for listing space events.

Поля
`parent`	`string` Required. Resource name of the Google Chat space where the events occurred. Format: `spaces/{space}` .
`page_size`	`int32` Optional. The maximum number of space events returned. The service might return fewer than this value. Отрицательные значения приводят к ошибке `INVALID_ARGUMENT` .
`page_token`	`string` Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
`filter`	`string` 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 . 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.

ListSpaceEventsResponse

Response message for listing space events.

Поля

space_events[]

SpaceEvent

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

next_page_token

string

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

ListSpacesRequest

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

Поля

page_size

int32

Необязательный параметр. Максимальное количество возвращаемых символов. Сервис может вернуть меньшее значение.

Если параметр не указан, возвращается не более 100 символов.

Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000.

Отрицательные значения приводят к ошибке INVALID_ARGUMENT .

page_token

string

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.

filter

string

Optional. A query filter.

You can filter spaces by the space type ( space_type ).

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.

ListSpacesResponse

The response for a list spaces request.

Поля

spaces[]

MembershipCreatedEventData

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

next_page_token

string

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

MatchedUrl

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

Поля

url

string

Output only. The URL that was matched.

MeetSpaceLinkData

Data for Meet space links.

Поля

meeting_code

string

Meeting code of the linked Meet space.

type

Type

Indicates the type of the Meet space.

huddle_status

HuddleStatus

Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.

HuddleStatus

The status of the huddle

Перечисления
`HUDDLE_STATUS_UNSPECIFIED`	Default value for the enum. Don't use.
`STARTED`	The huddle has started.
`ENDED`	The huddle has ended. In this case the Meet space URI and identifiers will no longer be valid.
`MISSED`	The huddle has been missed. In this case the Meet space URI and identifiers will no longer be valid.

Тип

The type of the Meet space.

Перечисления
`TYPE_UNSPECIFIED`	Default value for the enum. Don't use.
`MEETING`	The Meet space is a meeting.
`HUDDLE`	The Meet space is a huddle.

Членство

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.

Поля
`name`	`string` Identifier. Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
`state`	`MembershipState` Output only. State of the membership.
`role`	`MembershipRole` 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` .
`create_time`	`Timestamp` 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.
`delete_time`	`Timestamp` 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.
Union field `memberType` . Member associated with this membership. Other member types might be supported in the future. `memberType` can be only one of the following:
`member`	`User` Optional. 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` .
`group_member`	`Group` Optional. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication .

MembershipRole

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

Перечисления
`MEMBERSHIP_ROLE_UNSPECIFIED`	Default value. For `users` : they aren't a member of the space, but can be invited. For `Google Groups` : they're always assigned this role (other enum values might be used in the future).
`ROLE_MEMBER`	A member of the space. In the Chat UI, this role is called Member. The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including: Add or remove members. Modify space details. Turn history on or off. Mention everyone in the space with `@all` . Manage Chat apps and webhooks installed in the space. In direct messages and unnamed group conversations, everyone has this role.
`ROLE_MANAGER`	A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: Change the role of other members in the space to member, manager, or owner. Delete the space. Only supported in `SpaceType.SPACE` (named spaces). To learn more, see Learn more about your role as a space owner or manager .
`ROLE_ASSISTANT_MANAGER`	A space manager. In the Chat UI, this role is called Manager. The user has all basic permissions of `ROLE_MEMBER` , and can be granted a subset of administrative permissions by an owner. By default, managers have all the permissions of an owner except for the ability to: Delete the space. Make another space member an owner. Change an owner's role. By default, managers permissions include but aren't limited to: Make another member a manager. Delete messages in the space. Manage space permissions. Receive notifications for requests to join the space if the manager has the "manage members" permission in the space settings. Make a space discoverable. Only supported in `SpaceType.SPACE` (named spaces). To learn more, see Manage space settings .

MembershipState

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

Перечисления
`MEMBERSHIP_STATE_UNSPECIFIED`	Default value. Don't use.
`JOINED`	The user is added to the space, and can participate in the space.
`INVITED`	The user is invited to join the space, but hasn't joined it.
`NOT_A_MEMBER`	The user doesn't belong to the space and doesn't have a pending invitation to join the space.

MembershipBatchCreatedEventData

Event payload for multiple new memberships.

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

Поля

memberships[]

A list of new memberships.

MembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

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

Поля

memberships[]

MembershipDeletedEventData

A list of deleted memberships.

MembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

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

Поля

memberships[]

MembershipUpdatedEventData

A list of updated memberships.

MembershipCreatedEventData

Event payload for a new membership.

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

Поля

membership

The new membership.

MembershipDeletedEventData

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.

MembershipUpdatedEventData

Event payload for an updated membership.

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

Поля

membership

MessageCreatedEventData

The updated membership.

Сообщение

A message in a Google Chat space.

Поля
`name`	`string` Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name` . For details, see Name a message .
`sender`	`User` Output only. The user who created the message. If your Chat app authenticates as a user , the output populates the user `name` and `type` .
`create_time`	`Timestamp` 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.
`last_update_time`	`Timestamp` 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.
`delete_time`	`Timestamp` Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
`text`	`string` Optional. 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 .
`formatted_text`	`string` 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. Bullet list items using asterisks ( `` )—for example, ` item` . For more information, see View text formatting sent in a message
`cards[] (deprecated)`	`Card` Этот товар устарел! 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.
`cards_v2[]`	`CardWithId` Optional. 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 . Design and preview cards with the Card Builder. Open the Card Builder
`annotations[]`	`Annotation` Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0.
`thread`	`Thread` The thread the message belongs to. For example usage, see Start or reply to a message thread .
`space`	`Space` Output only. If your Chat app authenticates as a user , the output only populates the space `name` .
`fallback_text`	`string` Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
`action_response`	`ActionResponse` Input only. Parameters that a Chat app can use to configure how its response is posted.
`argument_text`	`string` Output only. Plain-text body of the message with all Chat app mentions stripped out.
`slash_command`	`SlashCommand` Output only. Slash command information, if applicable.
`attachment[]`	`Attachment` Optional. User-uploaded attachment.
`matched_url`	`MatchedUrl` Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see Preview links .
`thread_reply`	`bool` 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` .
`client_assigned_message_id`	`string` 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` field when you create the message. For details, see Name a message .
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Output only. The list of emoji reaction summaries on the message.
`private_message_viewer`	`User` Optional. Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following: Вложения Accessory widgets For details, see Send a message privately .
`deletion_metadata`	`DeletionMetadata` Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
`quoted_message_metadata`	`QuotedMessageMetadata` Optional. Information about a message that another message quotes. When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see Quote another message .
`attached_gifs[]`	`AttachedGif` Output only. GIF images that are attached to the message.
`accessory_widgets[]`	`AccessoryWidget` Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message . Creating a message with accessory widgets requires app authentication .

MessageBatchCreatedEventData

Event payload for multiple new messages.

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

Поля

messages[]

A list of new messages.

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

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

Поля

messages[]

MessageDeletedEventData

A list of deleted messages.

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

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

Поля

messages[]

MessageUpdatedEventData

A list of updated messages.

MessageCreatedEventData

Event payload for a new message.

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

Поля

message

The new message.

MessageDeletedEventData

Event payload for a deleted message.

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

Поля

message

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

MessageUpdatedEventData

Event payload for an updated message.

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

Поля

message

The updated message.

MoveSectionItemRequest

Request message for moving a section item across sections.

Поля

name

string

Required. The resource name of the section item to move.

Format: users/{user}/sections/{section}/items/{item}

target_section

string

Required. The resource name of the section to move the section item to.

Format: users/{user}/sections/{section}

MoveSectionItemResponse

Response message for moving a section item.

Поля

section_item

SectionItem

The updated section item.

PositionSectionRequest

Request message for positioning a section.

Поля
`name`	`string` Required. The resource name of the section to position. Format: `users/{user}/sections/{section}`
Union field `position` . Required. The new position of the section. `position` can be only one of the following:
`sort_order`	`int32` Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.
`relative_position`	`Position` Optional. The relative position of the section in the list of sections.

Позиция

The position of the section.

Перечисления
`POSITION_UNSPECIFIED`	Unspecified position.
`START`	Start of the list of sections.
`END`	End of the list of sections.

PositionSectionResponse

Response message for positioning a section.

Поля

section

ReactionCreatedEventData

The updated section.

QuotedMessageMetadata

Information about a message that another message quotes.

When you create a message, you can quote messages within the same thread, or quote a root message to create a new root message. However, you can't quote a message reply from a different thread.

When you update a message, you can't add or replace the quotedMessageMetadata field, but you can remove it.

For example usage, see Quote another message .

Поля
`name`	`string` Required. Resource name of the message that is quoted. Format: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Required. The timestamp when the quoted message was created or when the quoted message was last updated. If the message was edited, use this field, `last_update_time` . If the message was never edited, use `create_time` . If `last_update_time` doesn't match the latest version of the quoted message, the request fails.
`quote_type`	`QuoteType` Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Output only. A snapshot of the quoted message's content.
`forwarded_metadata`	`ForwardedMetadata` Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type.

QuoteType

The quote type of the quoted message.

Перечисления

QUOTE_TYPE_UNSPECIFIED Reserved. This value is unused.

REPLY

If quote_type is REPLY , you can do the following:

If you're replying in a thread, you can quote another message in that thread.
If you're creating a root message, you can quote another root message in that space.

You can't quote a message reply from a different thread.

QuotedMessageSnapshot

Provides a snapshot of the content of the quoted message at the time of quoting or forwarding

Поля
`sender`	`string` Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.
`text`	`string` Output only. Snapshot of the quoted message's text content.
`formatted_text`	`string` Output only. Contains the quoted message `text` with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type.
`annotations[]`	`Annotation` Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.
`attachments[]`	`Attachment` Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.

Реакция

A reaction to a message.

Поля

name

string

Identifier. The resource name of the reaction.

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

user

User

Output only. The user who created the reaction.

emoji

Emoji

Required. The emoji used in the reaction.

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

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

Поля

reactions[]

A list of new reactions.

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

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

Поля

reactions[]

ReactionDeletedEventData

A list of deleted reactions.

ReactionCreatedEventData

Event payload for a new reaction.

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

Поля

reaction

The new reaction.

ReactionDeletedEventData

Event payload for a deleted reaction.

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

Поля

reaction

The deleted reaction.

RichLinkMetadata

A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with start_index and length of 0.

Поля
`uri`	`string` The URI of this link.
`rich_link_type`	`RichLinkType` The rich link type.
Union field `data` . Data for the linked resource. `data` can be only one of the following:
`drive_link_data`	`DriveLinkData` Data for a drive link.
`chat_space_link_data`	`ChatSpaceLinkData` Data for a chat space link.
`meet_space_link_data`	`MeetSpaceLinkData` Data for a Meet space link.
`calendar_event_link_data`	`CalendarEventLinkData` Data for a Calendar event link.

RichLinkType

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

Перечисления
`RICH_LINK_TYPE_UNSPECIFIED`	Default value for the enum. Don't use.
`DRIVE_FILE`	A Google Drive rich link type.
`CHAT_SPACE`	A Chat space rich link type. For example, a space smart chip.
`GMAIL_MESSAGE`	A Gmail message rich link type. Specifically, a Gmail chip from Share to Chat . The API only supports reading messages with GMAIL_MESSAGE rich links.
`MEET_SPACE`	A Meet message rich link type. For example, a Meet chip.
`CALENDAR_EVENT`	A Calendar message rich link type. For example, a Calendar chip.

SearchSpacesRequest

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

Поля
`use_admin_access`	`bool` 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.
`page_size`	`int32` The maximum number of spaces to return. The service may return fewer than this value. Если параметр не указан, возвращается не более 100 символов. Максимальное значение — 1000. Если вы укажете значение больше 1000, оно автоматически изменится на 1000.
`page_token`	`string` 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.
`query`	`string` 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` 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")
`order_by`	`string` 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`

SearchSpacesResponse

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

Поля

spaces[]

A page of the requested spaces.

next_page_token

string

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

total_size

int32

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.

Раздел

Represents a section in Google Chat. Sections help users organize their spaces. There are two types of sections:

System Sections: These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their display_name modified. Examples include:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
Custom Sections: These are sections created and managed by the user. Creating a custom section using CreateSection requires a display_name . Custom sections can be updated using UpdateSection and deleted using DeleteSection .
Предварительная версия для разработчиков: доступна в рамках программы предварительного просмотра Google Workspace для разработчиков , которая предоставляет ранний доступ к определенным функциям.

Поля
`name`	`string` Identifier. Resource name of the section. For system sections, the section ID is a constant string: DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` DEFAULT_SPACES: `users/{user}/sections/default-spaces` DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
`display_name`	`string` Required. The section's display name. Only populated for sections of type `CUSTOM_SECTION` . Supports up to 80 characters. Required when creating a `CUSTOM_SECTION` .
`sort_order`	`int32` Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.
`type`	`SectionType` Required. The type of the section.

SectionType

Section types.

Перечисления
`SECTION_TYPE_UNSPECIFIED`	Unspecified section type.
`CUSTOM_SECTION`	Custom section.
`DEFAULT_DIRECT_MESSAGES`	Default section containing DIRECT_MESSAGE between two human users or GROUP_CHAT spaces that don't belong to any custom section.
`DEFAULT_SPACES`	Default spaces that don't belong to any custom section.
`DEFAULT_APPS`	Default section containing a user's installed apps.

SectionItem

A user's defined section item. This is used to represent section items, such as spaces, grouped under a section.

Поля

name

string

Identifier. The resource name of the section item.

Format: users/{user}/sections/{section}/items/{item}

Union field item . Required. The section item. item can be only one of the following:

space

string

Optional. The space resource name.

Формат: spaces/{space}

SetUpSpaceRequest

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.

request_id

string

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 49 memberships (in addition to the caller).

For human membership, the Membership.member field must contain a user with name populated (format: users/{user} ) and type set to User.Type.HUMAN . You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the user.name can be users/example@gmail.com . To invite Gmail users or users from external Google Workspace domains, user's email must be used for {user} .

For Google group membership, the Membership.group_member field must contain a group with name populated (format groups/{group} ). You can only add Google groups when setting Space.spaceType to SPACE .

Optional when setting Space.spaceType to SPACE .

Required when setting Space.spaceType to GROUP_CHAT , along with at least two memberships.

Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true ).

SlashCommand

Metadata about a slash command in Google Chat.

Поля

command_id

int64

The ID of the slash command.

SlashCommandMetadata

Annotation metadata for slash commands (/).

Поля
`bot`	`User` The Chat app whose command was invoked.
`type`	`Type` The type of slash command.
`command_name`	`string` The name of the invoked slash command.
`command_id`	`int64` The command ID of the invoked slash command.
`triggers_dialog`	`bool` Indicates whether the slash command is for a dialog.

Тип

Перечисления
`TYPE_UNSPECIFIED`	Default value for the enum. Don't use.
`ADD`	Add Chat app to space.
`INVOKE`	Invoke slash command in space.

Космос

Пространство в Google Chat. Пространства — это беседы между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.

Поля
`name`	`string` Идентификатор. Название ресурса пространства. Формат: `spaces/{space}` Где `{space}` представляет собой системный идентификатор пространства. Вы можете получить идентификатор пространства, вызвав метод `spaces.list()` или из URL-адреса пространства. Например, если URL-адрес пространства — `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA` , то идентификатор пространства — `AAAAAAAAA` .
`type (deprecated)`	`Type` Этот товар устарел! Output only. Deprecated: Use `space_type` instead. The type of a space.
`space_type`	`SpaceType` Необязательный параметр. Тип пространства. Обязателен при создании пространства или изменении типа пространства. Выводится только для других целей.
`single_user_bot_dm`	`bool` Необязательно. Укажите, является ли это личным сообщением между приложением для чата и живым человеком.
`threaded (deprecated)`	`bool` Этот товар устарел! Только вывод. Устарело: используйте `spaceThreadingState` вместо этого. Определяет, объединены ли сообщения в потоки в этом пространстве.
`display_name`	`string` Необязательно. Отображаемое имя пространства. Обязательно при создании пространства с `spaceType` `SPACE` . Если при создании пространства или обновлении `displayName` вы получаете сообщение об ошибке `ALREADY_EXISTS` , попробуйте другое `displayName` . Возможно, в существующем пространстве в организации Google Workspace уже используется это отображаемое имя. В личных сообщениях это поле может быть пустым. Поддерживает до 128 символов.
`external_user_allowed`	`bool` Необязательно. Неизменяемо. Разрешает ли данное пространство участвовать любому пользователю Google Chat. Поле вводится при создании пространства в организации Google Workspace. Опустите это поле при создании пространств в следующих условиях: Аутентифицированный пользователь использует учетную запись потребителя (неуправляемую учетную запись пользователя). По умолчанию пространство, созданное учетной записью потребителя, разрешает доступ любому пользователю Google Chat. Для существующих помещений это поле предназначено только для вывода.
`space_threading_state`	`SpaceThreadingState` Только вывод. Состояние ветки обсуждения в чате.
`space_details`	`SpaceDetails` Необязательно. Подробная информация о помещении, включая описание и правила.
`space_history_state`	`HistoryState` Необязательно. История сообщений и веток обсуждений в этом пространстве.
`import_mode`	`bool` Необязательно. Указывает, будет ли это пространство создано в `Import Mode` в рамках миграции данных в Google Workspace. Во время импорта пространства не будут видны пользователям до завершения импорта. Для создания пространства в `Import Mode` требуется аутентификация пользователя .
`create_time`	`Timestamp` Необязательно. Неизменяемо. Для пространств, созданных в чате, указывается время создания пространства. Это поле предназначено только для вывода, за исключением случаев использования в пространствах режима импорта. Для пространств в режиме импорта установите в этом поле историческую метку времени, в которую пространство было создано в источнике, чтобы сохранить исходное время создания. Отображается в выходных данных только в том случае, если `spaceType` имеет значение `GROUP_CHAT` или `SPACE` .
`last_active_time`	`Timestamp` Только вывод. Временная метка последнего сообщения в этом пространстве.
`admin_installed`	`bool` Только вывод. Для пространств прямых сообщений (DM) с приложением чата, независимо от того, было ли пространство создано администратором Google Workspace. Администраторы могут устанавливать и настраивать прямые сообщения с приложением чата от имени пользователей в своей организации. Для поддержки установки администратором ваше приложение чата должно поддерживать прямую переписку.
`membership_count`	`MembershipCount` Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE` , `DIRECT_MESSAGE` or `GROUP_CHAT` .
`access_settings`	`AccessSettings` Optional. Specifies the access setting of the space. Only populated when the `space_type` is `SPACE` .
`space_uri`	`string` Только для вывода. URI для доступа пользователя к пространству.
`import_mode_expire_time`	`Timestamp` Только для вывода. Время, когда пространство будет автоматически удалено системой, если она останется в режиме импорта. Каждое пространство, созданное в режиме импорта, должно выйти из этого режима до истечения указанного времени с помощью `spaces.completeImport` . Это поле заполняется только для пространств, созданных в режиме импорта.
`customer`	`string` Необязательный параметр. Неизменяемый. Идентификатор клиента домена пространства. Требуется только при создании пространства с аутентификацией приложения , если `SpaceType` имеет значение `SPACE` ; в противном случае параметр задавать не следует. В формате `customers/{customer}` , где `customer` — это `id` из ресурса customer в Admin SDK . Частные приложения также могут использовать псевдоним `customers/my_customer` для создания пространства в той же организации Google Workspace, что и приложение. Это поле не заполняется для личных сообщений (DM) или при создании пространства пользователями, не являющимися пользователями Google Workspace.
Поле объединения `space_permission_settings` . Представляет собой настройки разрешений пространства. Заполняется только тогда, когда `space_type` имеет значение `SPACE` . `space_permission_settings` может принимать только одно из следующих значений:
`predefined_permission_settings`	`PredefinedPermissionSettings` Необязательно. Только для ввода. Предопределенные настройки разрешений пространства, вводятся только при создании пространства. Если поле не заполнено, создается пространство для совместной работы. После создания пространства настройки заполняются в поле `PermissionSettings` . Настройка предопределенных параметров разрешений поддерживает: Аутентификация приложения с подтверждением администратора с использованием областей действия `chat.app.spaces` или `chat.app.spaces.create` . Аутентификация пользователя
`permission_settings`	`PermissionSettings` Необязательно. Настройки разрешений для существующих пространств. Входные данные для обновления точных настроек разрешений пространства, где заменяются существующие настройки разрешений. Выходные данные содержат список текущих настроек разрешений. Чтение и обновление настроек прав доступа поддерживают: Аутентификация приложения с подтверждением администратора в рамках области действия `chat.app.spaces` . Заполняется и устанавливается только при создании пространства приложением чата. Аутентификация пользователя

Настройки доступа

Представляет собой настройки доступа к пространству.

Поля

access_state

AccessState

Только для вывода. Указывает состояние доступа к пространству.

audience

string

Необязательно. Название ресурса целевой аудитории , которая может найти пространство, присоединиться к нему и просмотреть сообщения в нем. Если не указано, доступ к пространству имеют только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробнее см. раздел «Как сделать пространство доступным для целевой аудитории» .

Формат: audiences/{audience}

Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение audiences/default .

Ознакомление с целевой аудиторией помогает:

Аутентификация пользователя
Аутентификация приложения с подтверждением администратора в рамках области действия chat.app.spaces .

Это поле не заполняется при использовании области действия chat.bot с аутентификацией приложения .

Для указания целевой аудитории требуется аутентификация пользователя .

AccessState

Отражает состояние доступа к пространству.

Перечисления

ACCESS_STATE_UNSPECIFIED Состояние доступа неизвестно или не поддерживается в этом API.

PRIVATE Доступ к пространству имеют только пользователи или группы Google, добавленные индивидуально или приглашенные другими пользователями или администраторами Google Workspace.

DISCOVERABLE

Администратор пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, добавленные или приглашенные в пространство, также могут найти и получить к нему доступ. Для получения дополнительной информации см. раздел «Как сделать пространство доступным для определенных пользователей» .

Для создания доступных для поиска пространств требуется аутентификация пользователя .

Количество участников

Представляет собой количество членов сообщества, сгруппированных по категориям.

Поля

joined_direct_human_user_count

int32

Только вывод. Количество пользователей, которые присоединились к пространству напрямую, без учета пользователей, присоединившихся через членство в группе.

joined_group_count

int32

Только вывод. Количество всех групп, которые напрямую присоединились к пространству.

Настройки разрешений

Представляет собой настройку разрешений доступа к пространству.

Поля

managers_allowed

bool

Необязательно. Указывает, имеют ли владельцы пространства ( ROLE_MANAGER ) это разрешение.

members_allowed

bool

Необязательно. Указывает, имеют ли базовые участники пространства ( ROLE_MEMBER ) это разрешение.

assistant_managers_allowed

bool

Необязательно. Указывается, имеют ли менеджеры пространства ROLE_ASSISTANT_MANAGER ) это разрешение.

Настройки разрешений

Параметры разрешений , которые можно указать при обновлении существующего именованного пространства.

Чтобы задать параметры разрешений при создании пространства, укажите поле PredefinedPermissionSettings в вашем запросе.

Поля
`manage_members_and_groups`	`PermissionSetting` Необязательный параметр. Настройка для управления участниками и группами в пространстве.
`modify_space_details`	`PermissionSetting` Необязательно. Настройка для обновления названия пространства, аватара, описания и правил.
`toggle_history`	`PermissionSetting` Необязательный параметр. Настройка для включения и выключения истории использования пространства.
`use_at_mention_all`	`PermissionSetting` Необязательный параметр. Настройка для использования @all в пробеле.
`manage_apps`	`PermissionSetting` Необязательный параметр. Настройка для управления приложениями в пространстве.
`manage_webhooks`	`PermissionSetting` Необязательный параметр. Настройка для управления веб-хуками в пространстве.
`post_messages`	`PermissionSetting` Только для вывода. Настройка для публикации сообщений в пространстве.
`reply_messages`	`PermissionSetting` Необязательный параметр. Настройка для ответа на сообщения в рабочем пространстве.

Предопределенные настройки разрешений

Предопределенные параметры разрешений, которые можно указать только при создании именованного пространства. В будущем могут быть добавлены и другие параметры. Подробную информацию о параметрах разрешений для именованных пространств см. в разделе «Узнайте больше о пространствах» .

Перечисления
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	Не указано. Не использовать.
`COLLABORATION_SPACE`	Настройка позволяет превратить это пространство в площадку для совместной работы, где все участники могут публиковать сообщения.
`ANNOUNCEMENT_SPACE`	Настройка, позволяющая сделать это пространство зоной объявлений, где публиковать сообщения могут только администраторы пространства.

SpaceDetails

Подробная информация о помещении, включая описание и правила.

Поля

description

string

Необязательно. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников мероприятия.

Поддерживает до 150 символов.

guidelines

string

Необязательно. Правила, ожидания и этикет этого места.

Поддерживает до 5000 символов.

SpaceThreadingState

Указывает тип состояния ветки обсуждения в пространстве чата.

Перечисления
`SPACE_THREADING_STATE_UNSPECIFIED`	Сдержанный.
`THREADED_MESSAGES`	Именованные пространства, поддерживающие цепочки сообщений. Когда пользователи отвечают на сообщение, они могут делать это в рамках цепочки сообщений, сохраняя свой ответ в контексте исходного сообщения.
`GROUPED_MESSAGES`	Названные пространства, где обсуждение организовано по темам. Темы и ответы на них сгруппированы вместе.
`UNTHREADED_MESSAGES`	Личные сообщения (DM) между двумя людьми и групповые беседы между тремя и более людьми.

Тип пространства

Тип пространства. Обязательно при создании или обновлении пространства. Выводится только для других целей.

Перечисления
`SPACE_TYPE_UNSPECIFIED`	Сдержанный.
`SPACE`	Место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. В `SPACE` могут находиться приложения для чата.
`GROUP_CHAT`	Групповые беседы между тремя и более людьми. В `GROUP_CHAT` могут входить приложения для чата.
`DIRECT_MESSAGE`	Сообщения один на один между двумя людьми или между человеком и приложением для чата.

Тип

Устарело: используйте SpaceType вместо этого.

Перечисления
`TYPE_UNSPECIFIED`	Сдержанный.
`ROOM`	Разговор между двумя или более людьми.
`DM`	Прямое общение 1:1 между человеком и приложением для чата, где все сообщения отображаются в плоском формате. Обратите внимание, что это не включает прямые сообщения между двумя людьми.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

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

Поля

spaces[]

SpaceUpdatedEventData

A list of updated spaces.

SpaceEvent

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

Поля
`name`	`string` Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` Time when the event occurred.
`event_type`	`string` 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`
Union field `payload` . `payload` can be only one of the following:
`message_created_event_data`	`MessageCreatedEventData` Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

The notification setting of a user in a space.

Поля

name

string

Identifier. The resource name of the space notification setting. Format: users/{user}/spaces/{space}/spaceNotificationSetting .

notification_setting

NotificationSetting

The notification setting.

mute_setting

MuteSetting

The space notification mute setting.

MuteSetting

The space notification mute setting types.

Перечисления
`MUTE_SETTING_UNSPECIFIED`	Сдержанный.
`UNMUTED`	The user will receive notifications for the space based on the notification setting.
`MUTED`	The user will not receive any notifications for the space, regardless of the notification setting.

NotificationSetting

The notification setting types. Other types might be supported in the future.

Перечисления
`NOTIFICATION_SETTING_UNSPECIFIED`	Сдержанный.
`ALL`	Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.
`MAIN_CONVERSATIONS`	The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.
`FOR_YOU`	The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.
`OFF`	Notification is off.

SpaceReadState

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

Поля

name

string

Resource name of the space read state.

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

last_read_time

Timestamp

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.

SpaceUpdatedEventData

Event payload for an updated space.

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

Поля

space

The updated space.

SpaceView

Представление, определяющее, какие поля должны быть заполнены в ресурсе Space . Для обеспечения совместимости с будущими версиями мы рекомендуем учитывать дополнительные значения в вашем коде.

Перечисления
`SPACE_VIEW_UNSPECIFIED`	Значение по умолчанию / не задано.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Заполняет только имя ресурса Space.
`SPACE_VIEW_EXPANDED`	Заполняет поля ресурса Space. Примечание: поле `permissionSettings` заполняться не будет. Запросы, указывающие SPACE_VIEW_EXPANDED, должны включать области действия, разрешающие чтение данных Space, например, https://www.googleapis.com/auth/chat.spaces или https://www.googleapis.com/auth/chat.spaces.readonly .

Нить

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 field to determine what happens if no matching thread is found.

Поля

name

string

Identifier. Resource name of the thread.

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

thread_key

string

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.

ThreadReadState

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

Поля

name

string

Resource name of the thread read state.

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

last_read_time

Timestamp

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.

UpdateMembershipRequest

Request message for updating a membership.

Поля

membership

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

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

use_admin_access

bool

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

UpdateMessageRequest

Request to update a message.

Поля

message

Required. Message with fields updated.

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 .)
quoted_message_metadata (Only allows removal of the quoted message.)

allow_missing

bool

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.

UpdateSectionRequest

Request message for updating a section.

Поля

section

Required. The section to update.

update_mask

SpaceNotificationSetting

Required. The mask to specify which fields to update.

Currently supported field paths:

display_name

UpdateSpaceNotificationSettingRequest

Request to update the space notification settings. Only supports updating notification setting for the calling user.

Поля

space_notification_setting

Required. The resource name for the space notification settings must be populated in the form of users/{user}/spaces/{space}/spaceNotificationSetting . Only fields specified by update_mask are updated.

update_mask

Required. Supported field paths:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

Поля

space_read_state

SpaceReadState

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

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.

UpdateSpaceRequest

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.

update_mask