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

CustomEmoji

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

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.

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

reaction

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

Метаданные аннотаций для пользовательских эмодзи.

Поля

custom_emoji

CustomEmoji

Пользовательские эмодзи.

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.

Формат: 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

Deletes a reaction to a message.

Поля

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 .

Метаданные удаления

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

Поля

deletion_type

DeletionType

Указывает, кто удалил сообщение.

Тип удаления

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

Перечисления
`DELETION_TYPE_UNSPECIFIED`	Это значение не используется.
`CREATOR`	Пользователь удалил собственное сообщение.
`SPACE_OWNER`	Сообщение удалил владелец или управляющий.
`ADMIN`	Администратор Google Workspace удалил сообщение. Администраторы могут удалять любые сообщения в пространстве, включая сообщения, отправленные любым участником пространства или приложением чата.
`APP_MESSAGE_EXPIRY`	Приложение для чата удаляло собственное сообщение по истечении срока его действия.
`CREATOR_VIA_APP`	Приложение для чата удалило сообщение от имени его автора (используя аутентификацию пользователя).
`SPACE_OWNER_VIA_APP`	Приложение для чата удалило сообщение от имени администратора помещения (используя аутентификацию пользователя).
`SPACE_MEMBER`	Один из участников сообщества удалил сообщение. Пользователи могут удалять сообщения, отправленные через приложения.

Диалог

Оболочка вокруг основного содержимого диалогового окна.

Поля

body

Card

Только ввод. Тело диалогового окна, которое отображается в модальном окне. Приложения Google Chat не поддерживают следующие сущности карточек: DateTimePicker , OnChangeAction .

DialogAction

Содержит диалоговое окно и код состояния запроса.

Поля

action_status

ActionStatus

Только ввод. Статус запроса на запуск или отправку диалогового окна . При необходимости отображает статус и сообщение для пользователей. Например, в случае ошибки или успеха.

Полевая action профсоюза. Действие по выполнению. action может быть только одним из следующих:

dialog

Dialog

Только ввод данных. Диалоговое окно для запроса.

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

Данные для ссылок Google Диска.

Поля

drive_data_ref

DriveDataRef

Объект DriveDataRef , который ссылается на файл в Google Диске.

mime_type

string

MIME-тип связанного ресурса Google Drive.

Эмодзи

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

CustomEmoji

A custom emoji.

EmojiReactionSummary

Количество людей, отреагировавших на сообщение определенным эмодзи.

Поля

emoji

Emoji

Только вывод. Эмодзи, связанные с реакциями.

reaction_count

int32

Только вывод. Общее количество реакций с использованием соответствующих эмодзи.

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.

Поля
`users[]`	`string` Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49` . Format: `users/{user}` , where `{user}` is either the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321` , you can use `users/123456789` and `users/987654321` . You can also use the email as an alias for `{user}` . For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.
`page_size`	`int32` Необязательный параметр. Максимальное количество возвращаемых символов. Сервис может вернуть меньшее значение. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.
`page_token`	`string` Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.
`space_view`	`SpaceView` Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY` . Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly .

FindGroupChatsResponse

A response containing group chat spaces with exactly the calling user and the requested users.

Поля

spaces[]

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

next_page_token

string

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

ForwardedMetadata

Метаданные об исходном пространстве, из которого было переслано сообщение.

Поля

space

string

Только вывод. Имя ресурса исходного пространства. Формат: spaces/{space}

space_display_name

string

Только для вывода. Отображаемое имя исходного пространства или личного сообщения на момент пересылки. Для SPACE это имя пространства. Для DIRECT_MESSAGE это имя другого участника (например, "Пользователь A"). Для GROUP_CHAT это сгенерированное имя на основе имен участников, ограниченное пятью, включая создателя (например, "Пользователь A, Пользователь 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.

Формат: 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}

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

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

Перечисления
`HISTORY_STATE_UNSPECIFIED`	Default value. Do not use.
`HISTORY_OFF`	History off. Messages and threads are kept for 24 hours .
`HISTORY_ON`	History on. The organization's Vault retention rules specify for how long messages and threads are kept.

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

Необязательно. Фильтр запроса.

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

Поля

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.

Negative values return an INVALID_ARGUMENT error.

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. Negative values return an `INVALID_ARGUMENT` error.
`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. Например, следующие запросы являются допустимыми: `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

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

If unspecified, at most 100 spaces are returned.

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

Negative values return an INVALID_ARGUMENT error.

page_token

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова списка пространств. Укажите этот параметр, чтобы получить следующую страницу.

При постраничной навигации значение фильтра должно соответствовать запросу, предоставившему токен страницы. Передача другого значения может привести к неожиданным результатам.

filter

string

Необязательно. Фильтр запроса.

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.

Например, следующие запросы являются допустимыми:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

ListSpacesResponse

Ответ на запрос списка пространств.

Поля

spaces[]

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

Совпадающий URL-адрес в сообщении чата. Приложения для чата могут предварительно просматривать совпадающие URL-адреса. Для получения дополнительной информации см. раздел «Предварительный просмотр ссылок» .

Поля

url

string

Только вывод. Совпадающий URL-адрес.

MeetSpaceLinkData

Данные для ссылок на пространство Meet.

Поля

meeting_code

string

Код встречи связанного пространства Meet.

type

Type

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

huddle_status

HuddleStatus

Необязательный параметр. Только для вывода. Если встреча является групповой, указывает статус групповой встречи. В противном случае этот параметр не задан.

Статус обсуждения

Состояние совещания

Перечисления
`HUDDLE_STATUS_UNSPECIFIED`	Значение по умолчанию для перечисления. Не использовать.
`STARTED`	Совещание началось.
`ENDED`	Встреча завершена. В этом случае URI и идентификаторы пространства Meet больше не будут действительны.
`MISSED`	Встреча была пропущена. В этом случае URI и идентификаторы пространства Meet больше не будут действительны.

Тип

Тип помещения для встреч.

Перечисления
`TYPE_UNSPECIFIED`	Значение по умолчанию для перечисления. Не использовать.
`MEETING`	Пространство Meet предназначено для проведения встреч.
`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.

Сообщение

Сообщение в чате Google.

Поля
`name`	`string` Идентификатор. Имя ресурса сообщения. Формат: `spaces/{space}/messages/{message}` Где `{space}` — это идентификатор пространства, куда отправлено сообщение, а `{message}` — это системный идентификатор сообщения. Например, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . Если вы зададите пользовательский идентификатор при создании сообщения, вы сможете использовать этот идентификатор для указания сообщения в запросе, заменив `{message}` значением из поля `clientAssignedMessageId` . Например, `spaces/AAAAAAAAAAA/messages/client-custom-name` . Подробнее см. раздел «Назвать сообщение» .
`sender`	`User` Только вывод. Пользователь, создавший сообщение. Если ваше приложение чата аутентифицируется как пользователь , в выводе отображаются `name` пользователя и `type` .
`create_time`	`Timestamp` Необязательно. Неизменяемо. Для пространств, созданных в чате, указывается время создания сообщения. Это поле предназначено только для вывода, за исключением случаев использования в пространствах в режиме импорта. Для пространств в режиме импорта установите в этом поле историческую метку времени, в которую сообщение было создано в источнике, чтобы сохранить исходное время создания.
`last_update_time`	`Timestamp` Только для вывода. Время последнего редактирования сообщения пользователем. Если сообщение никогда не редактировалось, это поле пустое.
`delete_time`	`Timestamp` Только вывод. Время удаления сообщения в Google Chat. Если сообщение никогда не удалялось, это поле пустое.
`text`	`string` Необязательно. Текст сообщения в обычном формате. Первая ссылка на изображение, видео или веб-страницу генерирует фрагмент предварительного просмотра . Вы также можете упомянуть пользователя Google Chat с помощью символа @ или всех участников сообщества. Чтобы узнать о создании текстовых сообщений, см. раздел «Отправить сообщение» .
`formatted_text`	`string` Только для вывода. Содержит `text` сообщения с добавленными разметками для отображения форматирования. Это поле может не содержать всего форматирования, видимого в пользовательском интерфейсе, но включает следующее: Синтаксис разметки для жирного, курсивного, зачеркнутого, моноширинного, моноширинного блочного, маркированного списка и цитаты в блочном формате. Пользователь упоминает использование формата `<users/{user}>` . Пользовательские гиперссылки, использующие формат `<{url}\|{rendered_text}>` где первая строка — это URL-адрес, а вторая — отображаемый текст, например, `<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. Для маркировки элементов используйте звездочки ( `` ) — например, ` item` . Для получения дополнительной информации см. раздел «Просмотр форматирования текста, отправленного в сообщении».
`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` Необязательно. Массив карт . Приложения для чата могут создавать карточки с аутентификацией приложения . В рамках программы предварительного просмотра для разработчиков , если ваше приложение для чата проходит аутентификацию как пользователь , оно может создавать сообщения в виде карточек. Если ваше приложение для чата не участвует в программе предварительного просмотра для разработчиков, оно не может создавать карточки с аутентификацией пользователя. Чтобы узнать, как создать сообщение, содержащее карточки, см. раздел «Отправить сообщение» . Создавайте и просматривайте карточки с помощью конструктора карточек. Откройте конструктор карточек.
`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` Тема обсуждения, к которой относится сообщение. Примеры использования см. в разделе «Начать или ответить на сообщение в теме обсуждения» .
`space`	`Space` Только вывод. Если ваше приложение чата аутентифицируется как пользователь , в выводе будет отображаться только `name` пространства .
`fallback_text`	`string` Необязательно. Текстовое описание карточек сообщения, используемое, когда сами карточки не могут быть отображены — например, для уведомлений на мобильных устройствах.
`action_response`	`ActionResponse` Только для ввода. Параметры, которые приложение чата может использовать для настройки способа отправки ответа.
`argument_text`	`string` Только вывод. Текст сообщения в обычном формате, без упоминания каких-либо приложений для чата.
`slash_command`	`SlashCommand` Только вывод. Информация о команде слэша, если применимо.
`attachment[]`	`Attachment` Необязательно. Вложение, загруженное пользователем.
`matched_url`	`MatchedUrl` Только для вывода. URL-адрес в `spaces.messages.text` , соответствующий шаблону предварительного просмотра ссылки. Для получения дополнительной информации см. раздел «Предварительный просмотр ссылок» .
`thread_reply`	`bool` Только для вывода. Если `true` , сообщение является ответом в ветке ответов. Если `false` , сообщение отображается в основной беседе пространства либо как первое сообщение ветки, либо как сообщение без ответов в ветке. Если пространство не поддерживает ответы в ветках обсуждений, это поле всегда будет `false` .
`client_assigned_message_id`	`string` Необязательно. Пользовательский идентификатор для сообщения. Вы можете использовать это поле для идентификации сообщения, а также для получения, удаления или обновления сообщения. Чтобы задать пользовательский идентификатор, укажите поле `messageId` при создании сообщения. Подробнее см. раздел «Присвоение имени сообщению» .
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Только вывод. Список кратких описаний реакций в виде эмодзи к сообщению.
`private_message_viewer`	`User` Необязательно. Неизменяемое. Поле для создания сообщения, в противном случае только для вывода. Пользователь, который может просмотреть сообщение. Если задано, сообщение является приватным и видно только указанному пользователю и приложению «Чат». Чтобы включить это поле в ваш запрос, необходимо вызвать API чата с использованием аутентификации приложения и опустить следующее: Вложения Дополнительные виджеты Подробности см. в разделе «Отправить личное сообщение» .
`deletion_metadata`	`DeletionMetadata` Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
`quoted_message_metadata`	`QuotedMessageMetadata` Необязательно. Информация о сообщении, которое цитируется в другом сообщении. При создании сообщения вы можете цитировать сообщения в рамках той же ветки обсуждения или цитировать основное сообщение, чтобы создать новое основное сообщение. Однако вы не можете цитировать ответ на сообщение из другой ветки обсуждения. При обновлении сообщения вы не можете добавить или заменить поле `quotedMessageMetadata` , но можете его удалить. Примеры использования см. в разделе «Цитировать другое сообщение» .
`attached_gifs[]`	`AttachedGif` Только для вывода. GIF-изображения, прикрепленные к сообщению.
`accessory_widgets[]`	`AccessoryWidget` Необязательно. Один или несколько интерактивных виджетов, которые отображаются внизу сообщения. Вы можете добавлять дополнительные виджеты к сообщениям, содержащим текст, карточки или и текст, и карточки. Не поддерживается для сообщений, содержащих диалоги. Подробнее см. раздел «Добавление интерактивных виджетов внизу сообщения» . Для создания сообщения с дополнительными виджетами требуется аутентификация приложения .

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

The updated section.

QuotedMessageMetadata

Информация о сообщении, которое цитируется в другом сообщении.

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

При обновлении сообщения вы не можете добавить или заменить поле quotedMessageMetadata , но можете его удалить.

Примеры использования см. в разделе «Цитировать другое сообщение» .

Поля
`name`	`string` Обязательно. Имя ресурса цитируемого сообщения. Формат: `spaces/{space}/messages/{message}`
`last_update_time`	`Timestamp` Обязательно. Отметка времени создания цитируемого сообщения или его последнего обновления. 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` Необязательный параметр. Указывает тип цитирования. Если не задан, по умолчанию используется параметр REPLY в пути чтения/записи сообщения для обеспечения обратной совместимости.
`quoted_message_snapshot`	`QuotedMessageSnapshot` Только вывод. Краткий обзор содержимого цитируемого сообщения.
`forwarded_metadata`	`ForwardedMetadata` Только для вывода. Метаданные об исходном пространстве цитируемого сообщения. Заполняется только для типа цитирования FORWARD.

Тип цитаты

Тип цитируемого сообщения.

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

QUOTE_TYPE_UNSPECIFIED Зарезервировано. Это значение не используется.

REPLY

If quote_type is REPLY , you can do the following:

Если вы отвечаете в ветке обсуждения, вы можете процитировать другое сообщение в этой ветке.
Если вы создаёте корневое сообщение, вы можете процитировать другое корневое сообщение в этом пространстве.

Нельзя цитировать ответ на сообщение из другой ветки обсуждения.

QuotedMessageSnapshot

Предоставляет моментальный снимок содержимого цитируемого сообщения на момент цитирования или пересылки.

Поля
`sender`	`string` Только вывод. Имя автора цитируемого сообщения. Заполняется как для типа цитирования «ОТВЕТ», так и для типа цитирования «ПЕРЕВЕДЕНИЕ».
`text`	`string` Только вывод. Снимок текстового содержимого цитируемого сообщения.
`formatted_text`	`string` Только для вывода. Содержит `text` цитируемого сообщения с добавленной разметкой для поддержки расширенного форматирования, такого как гиперссылки, пользовательские эмодзи, разметка и т. д. Заполняется только для типа цитаты «ПЕРЕВЕДЕНИЕ».
`annotations[]`	`Annotation` Только для вывода. Аннотации, извлеченные из текста цитируемого сообщения. Заполняется только для типа цитаты FORWARD.
`attachments[]`	`Attachment` Только для вывода. Вложения, являвшиеся частью цитируемого сообщения. Это копии метаданных вложений цитируемого сообщения. Заполняется только для типа цитирования «ПЕРЕВЕДЕНИЕ».

Реакция

A reaction to a message.

Поля

name

string

Identifier. The resource name of the reaction.

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

CardWithId

Optional. An array of cards to be included in the message. These cards will replace the existing cards of the message. If empty, the original cards included in the message will be cleared.

ReplaceMessageCardsResponse

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

Response message for ReplaceMessageCards API.

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` URI этой ссылки.
`rich_link_type`	`RichLinkType` Тип ссылок «расширенные ссылки».
`data` поля объединения. Данные для связанного ресурса. `data` могут быть только одним из следующих типов:
`drive_link_data`	`DriveLinkData` Данные для приводного звена.
`chat_space_link_data`	`ChatSpaceLinkData` Данные для ссылки на чат.
`meet_space_link_data`	`MeetSpaceLinkData` Данные для ссылки на пространство Meet.
`calendar_event_link_data`	`CalendarEventLinkData` Данные для ссылки на событие в календаре.

RichLinkType

Тип ссылок «расширенные ссылки». В будущем могут быть добавлены и другие типы.

Перечисления
`RICH_LINK_TYPE_UNSPECIFIED`	Значение по умолчанию для перечисления. Не использовать.
`DRIVE_FILE`	Тип ссылки, расширяющий возможности Google Drive.
`CHAT_SPACE`	Тип ссылки, расширяющий возможности чата. Например, интеллектуальный чип в пространстве.
`GMAIL_MESSAGE`	Тип ссылки, отображаемой в сообщениях Gmail. В частности, это фрагмент кода Gmail из функции «Поделиться в чат» . API поддерживает чтение только сообщений со ссылками типа GMAIL_MESSAGE.
`MEET_SPACE`	Тип ссылки, используемый в сообщениях Meet. Например, значок Meet.
`CALENDAR_EVENT`	Тип ссылки, используемый в календарных сообщениях. Например, «Краткий элемент календаря».

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. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.
`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[]

Membership

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

Метаданные о команде со слэшем в Google Chat.

Поля

command_id

int64

Идентификатор команды с косой чертой.

SlashCommandMetadata

Метаданные аннотаций для команд со слэшем (/).

Поля
`bot`	`User` Приложение чата, команда которого была вызвана.
`type`	`Type` Тип команды слэша.
`command_name`	`string` Название вызываемой команды с косой чертой.
`command_id`	`int64` Идентификатор команды, которая была вызвана.
`triggers_dialog`	`bool` Указывает, предназначена ли команда слэша для диалогового окна.

Тип

Перечисления
`TYPE_UNSPECIFIED`	Значение по умолчанию для перечисления. Не использовать.
`ADD`	Добавьте приложение «Чат» в пространство.
`INVOKE`	Введите команду слэша в пробеле.

Космос

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

Поля
`name`	`string` Identifier. Resource name of the space. Формат: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the `spaces.list()` method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA` , the space ID is `AAAAAAAAA` .
`type (deprecated)`	`Type` Этот товар устарел! Output only. Deprecated: Use `space_type` instead. The type of a space.
`space_type`	`SpaceType` Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
`single_user_bot_dm`	`bool` Optional. Whether the space is a DM between a Chat app and a single human.
`threaded (deprecated)`	`bool` Этот товар устарел! Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
`display_name`	`string` Optional. The space's display name. Required when creating a space with a `spaceType` of `SPACE` . If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName` , try a different `displayName` . An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
`external_user_allowed`	`bool` Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
`space_threading_state`	`SpaceThreadingState` Output only. The threading state in the Chat space.
`space_details`	`SpaceDetails` Optional. Details about the space including description and rules.
`space_history_state`	`HistoryState` Optional. The message history state for messages and threads in this space.
`import_mode`	`bool` Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode` requires user authentication .
`create_time`	`Timestamp` Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE` .
`last_active_time`	`Timestamp` Output only. Timestamp of the last message in the space.
`admin_installed`	`bool` Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
`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` Output only. The URI for a user to access the space.
`import_mode_expire_time`	`Timestamp` Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport` . This field is only populated for spaces that were created with import mode.
`customer`	`string` Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with app authentication and `SpaceType` is `SPACE` , otherwise should not be set. In the format `customers/{customer}` , where `customer` is the `id` from the Admin SDK customer resource . Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
Union field `space_permission_settings` . Represents the permission settings of a space. Only populated when the `space_type` is `SPACE` . `space_permission_settings` can be only one of the following:
`predefined_permission_settings`	`PredefinedPermissionSettings` Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: App authentication with administrator approval with the `chat.app.spaces` or `chat.app.spaces.create` scopes. Аутентификация пользователя
`permission_settings`	`PermissionSettings` Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: App authentication with administrator approval with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. Аутентификация пользователя

AccessSettings

Represents the access setting of the space.

Поля

access_state

AccessState

Output only. Indicates the access state of the space.

audience

string

Optional. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience .

Format: audiences/{audience}

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

Reading the target audience supports:

Аутентификация пользователя
App authentication with administrator approval with the chat.app.spaces scope.

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

Setting the target audience requires user authentication .

AccessState

Represents the access state of the space.

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

ACCESS_STATE_UNSPECIFIED Access state is unknown or not supported in this API.

PRIVATE Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.

DISCOVERABLE

A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users .

Creating discoverable spaces requires user authentication .

MembershipCount

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

Поля

joined_direct_human_user_count

int32

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

joined_group_count

int32

Output only. Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

Поля

managers_allowed

bool

Optional. Whether space owners ( ROLE_MANAGER ) have this permission.

members_allowed

bool

Optional. Whether basic space members ( ROLE_MEMBER ) have this permission.

assistant_managers_allowed

bool

Optional. Whether space managers ROLE_ASSISTANT_MANAGER ) have this permission.

PermissionSettings

Permission settings that you can specify when updating an existing named space.

To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

Поля
`manage_members_and_groups`	`PermissionSetting` Optional. Setting for managing members and groups in a space.
`modify_space_details`	`PermissionSetting` Optional. Setting for updating space name, avatar, description and guidelines.
`toggle_history`	`PermissionSetting` Optional. Setting for toggling space history on and off.
`use_at_mention_all`	`PermissionSetting` Optional. Setting for using @all in a space.
`manage_apps`	`PermissionSetting` Optional. Setting for managing apps in a space.
`manage_webhooks`	`PermissionSetting` Optional. Setting for managing webhooks in a space.
`post_messages`	`PermissionSetting` Output only. Setting for posting messages in a space.
`reply_messages`	`PermissionSetting` Optional. Setting for replying to messages in a space.

PredefinedPermissionSettings

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

Перечисления
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	Unspecified. Don't use.
`COLLABORATION_SPACE`	Setting to make the space a collaboration space where all members can post messages.
`ANNOUNCEMENT_SPACE`	Setting to make the space an announcement space where only space managers can post messages.

SpaceDetails

Details about the space including description and rules.

Поля

description

string

Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

guidelines

string

Optional. The space's rules, expectations, and etiquette.

Supports up to 5,000 characters.

SpaceThreadingState

Specifies the type of threading state in the Chat space.

Перечисления
`SPACE_THREADING_STATE_UNSPECIFIED`	Сдержанный.
`THREADED_MESSAGES`	Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.
`GROUPED_MESSAGES`	Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.
`UNTHREADED_MESSAGES`	Direct messages (DMs) between two people and group conversations between 3 or more people.

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

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

Перечисления
`SPACE_TYPE_UNSPECIFIED`	Сдержанный.
`SPACE`	A place where people send messages, share files, and collaborate. A `SPACE` can include Chat apps.
`GROUP_CHAT`	Group conversations between 3 or more people. A `GROUP_CHAT` can include Chat apps.
`DIRECT_MESSAGE`	1:1 messages between two humans or a human and a Chat app.

Тип

Deprecated: Use SpaceType instead.

Перечисления
`TYPE_UNSPECIFIED`	Сдержанный.
`ROOM`	Conversations between two or more humans.
`DM`	1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans.

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

A view that specifies which fields should be populated on the Space resource. To ensure compatibility with future releases, we recommend that your code account for additional values.

Перечисления
`SPACE_VIEW_UNSPECIFIED`	The default / unset value.
`SPACE_VIEW_RESOURCE_NAME_ONLY`	Populates only the Space resource name.
`SPACE_VIEW_EXPANDED`	Populates Space resource fields. Note: the `permissionSettings` field will not be populated. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly .

Нить

Ветка обсуждений в чате Google. Пример использования см. в разделе «Начать или ответить на ветку сообщений» .

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

Поля

name

string

Идентификатор. Имя ресурса потока.

Пример: spaces/{space}/threads/{thread}

thread_key

string

Необязательный параметр. Входные данные для создания или обновления потока. В противном случае — только вывод. Идентификатор потока. Поддерживает до 4000 символов.

Этот идентификатор уникален для приложения чата, которое его установило. Например, если несколько приложений чата создают сообщение, используя один и тот же ключ ветки, сообщения будут опубликованы в разных ветках. Чтобы ответить в ветке, созданной одним человеком или другим приложением чата, укажите вместо этого поле name ветки.

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

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

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