Package google.chat.v1

Пространство импорта режима.

Контекстуаладдонмаркюп

Этот тип не имеет полей.

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

Карточка

Карта - это элемент пользовательского интерфейса, который может содержать виджеты пользовательского интерфейса, такие как текст и изображения.

Поля
`header`	`CardHeader` Заголовок карты. Заголовок обычно содержит заголовок и изображение.
`sections[]`	`Section` Разделы разделены линейным разделителем.
`card_actions[]`	`CardAction` Действия этой карты.
`name`	`string` Название карты.

Кардация

Действие карты - это действие, связанное с картой. Для карты счета -фактуры типичным действием будет: Удалить счет -фактуру, счет по электронной почте или открыть счет в браузере.

Не поддерживается приложениями Google Chat.

Поля

action_label

string

Метка использовалась в элементе меню Action.

on_click

OnClick

Действие Onclick для этого элемента действия.

Карточный голод

Поля
`title`	`string` Название должно быть указано. Заголовок имеет фиксированную высоту: если указан как заголовок, так и подзаголовок, каждая занимает одну строку. Если указано только заголовок, он занимает обе строки.
`subtitle`	`string` Подзаголовок заголовка карты.
`image_style`	`ImageStyle` Тип изображения (например, квадратная граница или круговая граница).
`image_url`	`string` URL -адрес изображения в заголовке карты.

Образец

Перечисления
`IMAGE_STYLE_UNSPECIFIED`
`IMAGE`	Квадратная граница.
`AVATAR`	Круговая граница.

Раздел

Раздел содержит набор виджетов, которые отображаются (вертикально) в порядке, в котором они указаны. На всех платформах карты имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, Float).

Поля

header

string

Заголовок секции. Форматированный текст поддерживается. Для получения дополнительной информации о форматировании текста см. Форматирование текста в приложениях Google Chat и форматирование текста в надстройках Google Workspace .

widgets[]

WidgetMarkup

Раздел должен содержать хотя бы один виджет.

CreateCustomeJirequest

Запрос на создание пользовательского смайлика.

Поля

custom_emoji

Требуется Пользовательские смайлики для создания.

CreateMembershipRequest

Запросить сообщение о создании членства.

Поля

parent

string

Требуется Название ресурса пространства для создания членства.

Формат: пространства/{пространство}

membership

Требуется Отношение членства к созданию.

Поле memberType должно содержать пользователя с заполненными полями user.name и user.type . Сервер назначит имя ресурса и перезаписывает все, что указано.

Когда приложение чата создает отношение членства для пользователя человека, оно должно использовать определенные области авторизации и установить конкретные значения для определенных полей:

При аутентификации в качестве пользователя требуется область авторизации chat.memberships .
При аутентификации в качестве приложения требуется область авторизации chat.app.memberships . Аутентификация в качестве приложения доступна в
Предварительный просмотр разработчика: доступен в рамках программы предварительного просмотра разработчиков Google Workspace , которая дает ранний доступ к определенным функциям.
Установите user.type для HUMAN и установите user.name с форматом users/{user} , где {user} может быть адресом электронной почты для пользователя. Для пользователей в той же организации рабочей области {user} также может быть id человека из API People или id для пользователя в API каталогов. Например, если идентификатор профиля человека API API для user@example.com - 123456789 , вы можете добавить пользователя в пространство, установив membership.member.name на users/user@example.com или users/123456789 .

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

Когда приложение чата создает для себя отношение членства, оно должно быть аутентифицировано как пользователь и использовать область chat.memberships.app , установить user.type для BOT и установить user.name для users/app .

use_admin_access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships .

Создание членства в приложении или создание участников для пользователей за пределами организации Google Respace Administrator не поддерживается с использованием Admin Access.

CreateMessAgeRequest

Создает сообщение.

Поля
`parent`	`string` Требуется Имя ресурса пространства для создания сообщения. Формат: `spaces/{space}`
`message`	`Message` Требуется Тело сообщения.
`thread_key (deprecated)`	`string` Этот предмет устарел! Необязательный. Установите: используйте `thread.thread_key` вместо этого. ID для потока. Поддерживает до 4000 символов. Чтобы запустить или добавить в поток, создайте сообщение и укажите `threadKey` или `thread.name` . Например, используйте, см. Запуск или ответьте на поток сообщения .
`request_id`	`string` Необязательный. Уникальный идентификатор запроса для этого сообщения. Указание существующего идентификатора запроса возвращает сообщение, созданное с помощью этого идентификатора вместо создания нового сообщения.
`message_reply_option`	`MessageReplyOption` Необязательный. Указывает, запускает ли сообщение поток или отвечает на один. Поддерживается только в названных пространствах. При ответе на взаимодействие с пользователями это поле игнорируется. Для взаимодействия в потоке ответ создается в том же потоке. В противном случае ответ создан как новый поток.
`message_id`	`string` Необязательный. Пользовательский идентификатор для сообщения. Lets Chat Приложения получают, обновляют или удаляете сообщение без необходимости хранить идентификатор, назначенный системой, в имени ресурса сообщения (представлено в поле `name` сообщения»). Значение для этого поля должно соответствовать следующим требованиям: Начинается с `client-` . Например, `client-custom-name` -это действительный пользовательский идентификатор, но `custom-name` нет. Содержит до 63 символов и только строчные буквы, цифры и дефисы. Уникален в пространстве. Приложение чата не может использовать один и тот же пользовательский идентификатор для разных сообщений. Для получения подробной информации см. Имя сообщения .

Messagereplyoption

Указывает, как ответить на сообщение. В будущем может быть добавлено больше штатов.

Перечисления
`MESSAGE_REPLY_OPTION_UNSPECIFIED`	По умолчанию. Запускает новую ветку. Использование этой опции игнорирует любой `thread ID` или `thread_key` который включен.
`REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD`	Создает сообщение в качестве ответа на поток, указанный `thread ID` или `thread_key` . Если он не удается, сообщение запускает новый поток вместо этого.
`REPLY_MESSAGE_OR_FAIL`	Создает сообщение в качестве ответа на поток, указанный `thread ID` или `thread_key` . Если используется новый `thread_key` , создается новый поток. Если создание сообщения не удается, вместо этого возвращается ошибка `NOT_FOUND` .

CreatereActionRequest

Создает реакцию на сообщение.

Поля

parent

string

Требуется Сообщение, где создается реакция.

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

reaction

Требуется Реакция на создание.

CreateSpacerequest

Запрос на создание названного пространства без участников.

Поля

space

Требуется Поля displayName и spaceType должны быть заполнены. Поддерживаются только SpaceType.SPACE и SpaceType.GROUP_CHAT . SpaceType.GROUP_CHAT может использоваться только в том случае, если importMode установлен на true.

Если вы уже получаете сообщение об ошибке ALREADY_EXISTS , попробуйте другое имя displayName . Существующее пространство в организации Google Workspace может уже использовать это имя отображения.

name пространства назначено на сервере, поэтому все, что указано в этом поле, будет проигнорировано.

request_id

string

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

CustomeMoji

Представляет собой пользовательский смайлик .

Поля
`name`	`string` Идентификатор. Имя ресурса пользовательского смайлика, назначенного сервером. Формат: `customEmojis/{customEmoji}`
`uid`	`string` Только вывод. Уникальный ключ для пользовательского ресурса эмодзи.
`emoji_name`	`string` Необязательный. Неизменен. Предоставленное пользователем имя для пользовательских смайликов, которое является уникальным в организации. Требуется, когда создается пользовательский смайлик, вывод только в противном случае. Имена эмодзи должны начинать и заканчиваться колонами, должны быть строчными и могут содержать только буквенно -цифровые символы, дефисы и подчеркивание. Дефисы и подставки должны использоваться для разделения слов и нельзя использовать последовательно. Пример:: `:valid-emoji-name:`
`temporary_image_uri`	`string` Только вывод. Временный URL -адрес изображения для пользовательского смайлика, действительный не менее 10 минут. Обратите внимание, что это не заполняется в ответе, когда создается пользовательский смайлик.
`payload`	`CustomEmojiPayload` Необязательный. Только вход. Данные полезной нагрузки. Требуется, когда создается пользовательский смайлик.

CustomeJipayLoad

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

Поля

file_content

bytes

Требуется Только вход. Изображение, используемое для пользовательских смайликов.

Полезная нагрузка должна быть менее 256 т.п.н., а измерение изображения должно быть квадратным и от 64 до 500 пикселей. Ограничения могут быть изменены.

filename

string

Требуется Только вход. Имя файла изображения.

Поддерживаемые расширения файлов: .png , .jpg , .gif .

CustomeJimeTadata

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

Поля

custom_emoji

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

DeleteCustomejirequest

Запрос на удаление пользовательского смайлика.

Поля

name

string

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

Формат: customEmojis/{customEmoji}

Вы можете использовать имя эмодзи в качестве псевдонима для {customEmoji} . Например, customEmojis/:example-emoji: где :example-emoji: это имя эмодзи для пользовательского смайлика.

DeletemembershipRequest

Запрос удалить членство в пространстве.

Поля

name

string

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

При удалении человеческого членства требуется область применения в chat.memberships . Вы можете использовать электронное письмо в качестве псевдонима для {member} . Например, spaces/{space}/members/example@gmail.com spaces/{space}/members/{member} , где example@gmail.com - электронное письмо пользователя Google chat.memberships.app .

При удалении членства в приложении требуется chat.memberships.app Scope и spaces/{space}/members/app Format.

Формат: spaces/{space}/members/{member} или spaces/{space}/members/app .

use_admin_access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships .

Удаление членов приложения в пространстве не поддерживается с использованием доступа к администратору.

DeletemessageRequest

Запрос удалить сообщение.

Поля

name

string

Требуется Имя ресурса сообщения.

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

Если вы установили пользовательский идентификатор для вашего сообщения, вы можете использовать значение из поля clientAssignedMessageId для {message} . Для получения подробной информации см. Имя сообщения .

force

bool

Необязательный. Когда true , удаление сообщения также удаляет свои резьбовые ответы. Когда false , если сообщение имеет резьбовые ответы, удаление не удается.

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

DeletereActionRequest

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

Поля

name

string

Требуется Название реакции на удаление.

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

DeleteSpacerequest

Запрос на удаление места.

Поля

name

string

Требуется Название ресурса пространства для удаления.

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

use_admin_access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.delete .

DeletionMetadata

Информация о удаленном сообщении. Сообщение удаляется при установке delete_time .

Поля

deletion_type

DeletionType

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

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 .

Диалог

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

Поля

action_status

ActionStatus

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

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

dialog

Dialog

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

DRIEDATAREF

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

Поля

drive_file_id

string

Идентификатор для файла диска. Используйте с приводом API.

DRIVELINKDATA

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

Поля

drive_data_ref

DriveDataRef

DriedAtaref , который ссылается на файл Google Drive.

mime_type

string

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

Эмодзи

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

Поля

Полевой content союза. Требуется Содержание эмодзи. content может быть только одним из следующих:

unicode

string

Необязательный. Основные смайлики, представленные строкой Unicode.

custom_emoji

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

Эмодзиреатзамман

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

Поля

emoji

Emoji

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

reaction_count

int32

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

FindDirectMessAgeRequest

Запрос на получение прямого пространства сообщений на основе пользовательского ресурса.

Поля

name

string

Требуется Имя ресурса пользователя, чтобы найти прямое сообщение.

Format: users/{user} , где {user} является либо id для человека из API People, либо id для пользователя в API каталогов. Например, если идентификатор профиля People API составляет 123456789 , вы можете найти прямое сообщение с этим человеком, используя users/123456789 в качестве name . Когда вы аутентифицированы как пользователь , вы можете использовать электронную почту в качестве псевдонима для {user} . Например, users/example@gmail.com , где example@gmail.com - это письмо пользователя Google Chat.

GetAttachmentRequest

Просьба получить вложение.

Поля

name

string

Требуется Имя ресурса вложения, в spaces/{space}/messages/{message}/attachments/{attachment} .

GetCustomeJirequest

Запрос на возврат одного пользовательского смайлика.

Поля

name

string

Требуется Название ресурса пользовательского смайлика.

Формат: customEmojis/{customEmoji}

GetMembershipRequest

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

Поля

name

string

Требуется Название ресурса членства для извлечения.

Чтобы получить собственное членство в приложении с помощью аутентификации пользователя , вы можете при желании использовать spaces/{space}/members/app .

Формат: spaces/{space}/members/{member} или spaces/{space}/members/app

Вы можете использовать электронную почту пользователя в качестве псевдонима для {member} . Например, spaces/{space}/members/example@gmail.com space/members/example@gmail.com, где example@gmail.com - электронное письмо пользователя Google Chat.

use_admin_access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships или chat.admin.memberships.readonly .

Получение членства в приложении в пространстве не поддерживается при использовании доступа к администратору.

GetMessageRequest

Запрос получить сообщение.

Поля

name

string

Требуется Имя ресурса сообщения.

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

GetSpaceEventRequest

Запросить сообщение о получении космического мероприятия.

Поля

name

string

Требуется Название ресурса космического события.

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

GetSpacenotificationsettingRequest

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

Поля

name

string

Требуется Формат: users/{user}/spaces/{space}/spacenotificationsetting

users/me/spaces/{space}/spaceNotificationSetting , или
users/user@example.com/spaces/{space}/spaceNotificationSetting { space )/spacenotificationsetting, или
users/123456789/spaces/{space}/spaceNotificationSetting . Примечание. На пути разрешен только идентификатор пользователя или электронную почту вызывающего абонента.

GetSpacereadStateRequest

Запросить сообщение для API GetSpacereadState.

Поля

name

string

Требуется Название ресурса Космического чтения состояния для извлечения.

Поддерживает только получение состояния чтения для звонящего пользователя.

Чтобы обозначить пользователя по вызову, установите одно из следующих:

me псевдоним. Например, users/me/spaces/{space}/spaceReadState .
Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/spaceReadState { space )/spacereadstate.
Их идентификатор пользователя. Например, users/123456789/spaces/{space}/spaceReadState .

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

GetSpacerequest

Просьба вернуть одно пространство.

Поля

name

string

Требуется Имя ресурса пространства, в формах Form spaces/{space} .

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

use_admin_access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.spaces chat.admin.spaces.readonly

GetThreadReadStateRequest

Запросить сообщение о GetThreadReadStateRequest API.

Поля

name

string

Требуется Название ресурса потока считываем состояние для извлечения.

Поддерживает только получение состояния чтения для звонящего пользователя.

Чтобы обозначить пользователя по вызову, установите одно из следующих:

me псевдоним. Например, users/me/spaces/{space}/threads/{thread}/threadReadState .
Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState space/threads/{ the Readure/threadReadState.
Их идентификатор пользователя. Например, users/123456789/spaces/{space}/threads/{thread}/threadReadState .

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

Группа

Группа Google в чате Google.

Поля

name

string

Имя ресурса для группы Google.

Представляет группу в группе облачных идентификаторов API.

Формат: группы/{группа}

ИСТОРИЯ

Государство истории для сообщений и пространств. Определяет, как долго хранятся сообщения и беседы после создания.

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

Listcustomejisrequest

Запрос вернуть список пользовательских смайликов.

Поля

page_size

int32

Необязательный. Максимальное количество пользовательских смайликов вернулось. Сервис может вернуть меньше пользовательских смайликов, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200.

page_token

string

Необязательный. (Если возобновить из предыдущего запроса.)

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

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

filter

string

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

Поддерживает фильтрацию создателем.

Чтобы фильтровать создателем, вы должны указать достоверное значение. В настоящее время только creator("users/me") , а NOT creator("users/me") принимаются для фильтрации пользовательских смайликов по тому, были ли они созданы звонком или нет.

Например, следующий запрос возвращает пользовательские смайлики, созданные вызывающим абонент:

creator("users/me")

Неверные запросы отклоняются с ошибкой INVALID_ARGUMENT .

Listcustomejisresponse

Ответ на список пользовательских смайликов.

Поля

custom_emojis[]

Неупомянутый список. Список пользовательских смайликов.

next_page_token

string

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

Listmembershipsrequest

Запросить сообщение о перечислении членства.

Поля
`parent`	`string` Требуется Название ресурса пространства, для которого можно получить список членов. Формат: пространства/{пространство}
`page_size`	`int32` Необязательный. Максимальное количество членов для возврата. Сервис может вернуть меньше этого значения. В случае неопределенности, не более 100 членов возвращаются. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. Отрицательные значения возвращают ошибку `INVALID_ARGUMENT` .
`page_token`	`string` Необязательный. Токен страницы, полученный от предыдущего вызова для перечисления членов. Предоставьте этот параметр, чтобы получить последующую страницу. При нанесении на страницу все другие предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам.
`filter`	`string` Необязательный. Фильтр запросов. Вы можете отфильтровать членство с помощью роли ( `role` ) члена и типа ( `member.type` ). Чтобы фильтровать по роли, установить `role` в `ROLE_MEMBER` или `ROLE_MANAGER` . Чтобы фильтровать по типу, установите `member.type` на `HUMAN` или `BOT` . Вы также можете отфильтровать для `member.type` с помощью оператора `!=` . Чтобы отфильтровать как роли, так и типом, используйте `AND` оператор. Чтобы фильтровать по роли или типу, используйте `OR` оператор. Либо `member.type = "HUMAN"` или `member.type != "BOT"` Другие фильтры типа `use_admin_access` будут отклонены. Например, следующие запросы действительны: `role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT"` Следующие запросы недействительны: `member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"` Неверные запросы отклоняются сервером с ошибкой `INVALID_ARGUMENT` .
`show_groups`	`bool` Необязательный. Когда `true` также возвращает членство, связанное с `Google Group` , в дополнение к другим типам членства. Если установлен `filter` , членство `Google Group` , которое не соответствует критериям фильтра, не возвращаются.
`show_invited`	`bool` Необязательный. Когда `true` , также возвращает членство, связанное с `invited` членами, в дополнение к другим типам членства. Если устанавливается фильтр, `invited` членства, которые не соответствуют критериям фильтра, не возвращаются. В настоящее время требуется аутентификация пользователя .
`use_admin_access`	`bool` Необязательный. Когда `true` , метод работает с использованием привилегий администратора Google Respace пользователя. Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует либо `chat.admin.memberships.readonly` `chat.admin.memberships` Перечисление участников приложения в пространстве не поддерживается при использовании доступа к администратору.

Listmembershipsresponse

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

Поля

memberships[]

Неупомянутый список. Список членов на запрошенной (или первой) странице.

next_page_token

string

ListMessagesRequest

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

Поля
`parent`	`string` Требуется Имя ресурса пространства для перечисления сообщений. Формат: `spaces/{space}`
`page_size`	`int32` Необязательный. Максимальное количество сообщений возвращалось. Служба может вернуть меньше сообщений, чем это значение. Если не указано, не более 25 возвращаются. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. Отрицательные значения возвращают ошибку `INVALID_ARGUMENT` .
`page_token`	`string` Необязательный. Токен страницы, полученный из предыдущего вызова сообщений списка. Предоставьте этот параметр, чтобы получить последующую страницу. При нанесении на страницу все другие предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам.
`filter`	`string` Необязательный. Фильтр запросов. Вы можете отфильтровать сообщения по дате ( `create_time` ) и поток ( `thread.name` ). Чтобы отфильтровать сообщения до даты, которую они были созданы, укажите The `create_time` с временной меткой в формате RFC-3339 и двойных кавычках. Например, `"2023-04-21T11:30:00-04:00"` . Вы можете использовать больше, чем оператор `>` для перечисления сообщений, которые были созданы после метки времени, или меньше, чем оператор `<` для перечисления сообщений, которые были созданы до метки времени. Чтобы отфильтровать сообщения в интервал времени, используйте `AND` оператор между двумя временными метками. Чтобы отфильтровать по потоку, укажите `thread.name` , отформатированный как `spaces/{space}/threads/{thread}` . Вы можете указать только один `thread.name` . Название за запрос. Чтобы фильтровать по потоке и дате, используйте `AND` оператор в своем запросе. Например, следующие запросы действительны: `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_ARGUMENT` .
`order_by`	`string` Необязательный. Как упорядочен список сообщений. Укажите значение по заказу с помощью операции заказа. Допустимые значения операции заказа следующие: `ASC` для восхождения. `DESC` для спуска. Порядок по умолчанию - `create_time ASC` .
`show_deleted`	`bool` Необязательный. Должны ли включать удаленные сообщения. Удаленные сообщения включают удаленное время и метаданные об их удалении, но содержание сообщений недоступно.

ListMessagesResponse

Ответ Сообщение для перечисления сообщений.

Поля

messages[]

Список сообщений.

next_page_token

string

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

ListreactionSrequest

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

Поля
`parent`	`string` Требуется Пользователи сообщений отреагировали на. Формат: `spaces/{space}/messages/{message}`
`page_size`	`int32` Необязательный. Максимальное количество реакций возвращается. Служба может вернуть меньше реакций, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200.
`page_token`	`string` Необязательный. (Если возобновить из предыдущего запроса.) Токен страницы, полученный из предыдущего вызова реакций списка. Предоставьте это, чтобы получить последующую страницу. При страничном значении фильтра должно соответствовать вызову, который предоставил токен страницы. Прохождение другого значения может привести к неожиданным результатам.
`filter`	`string` Необязательный. Фильтр запросов. Вы можете отфильтровать реакции с помощью Emoji (либо `emoji.unicode` , либо `emoji.custom_emoji.uid` ) и user ( `user.name` ). Чтобы отфильтровать реакции для нескольких смайликов или пользователей, присоединяйтесь к аналогичным полям с оператором `OR` , такими как `emoji.unicode = "🙂" OR emoji.unicode = "👍"` и `user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"` . Чтобы отфильтровать реакции с помощью Emoji и пользователя, используйте `AND` оператор, такой как `emoji.unicode = "🙂" AND user.name = "users/AAAAAA"` . Если ваш запрос использует как `AND` или `OR` , сгруппируйте их с скобками. Например, следующие запросы действительны: `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}"` Следующие запросы недействительны: `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_ARGUMENT` .

ListreactionSresponse

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

Поля

reactions[]

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

next_page_token

string

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

Listspaceeventsrequest

Запросить сообщение о перечислении космических событий.

Поля
`parent`	`string` Требуется Название ресурса в чате Google , где произошли события. Формат: `spaces/{space}` .
`page_size`	`int32` Необязательный. Максимальное количество космических событий возвращалось. Сервис может вернуть меньше этого значения. Отрицательные значения возвращают ошибку `INVALID_ARGUMENT` .
`page_token`	`string` Необязательный. Токен страницы, полученный из предыдущего звонка космических событий списка. Предоставьте это, чтобы получить последующую страницу. При нанесении на страницу все остальные параметры, предоставленные для перечисления пространственных событий, должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам.
`filter`	`string` Требуется Фильтр запросов. Вы должны указать хотя бы один тип события ( `event_type` ), используя оператор HASE `:` Чтобы отфильтровать по нескольким типам событий, используйте оператор `OR` . Опустите типы событий партии в вашем фильтре. Запрос автоматически возвращает любые связанные пакетные события. Например, если вы фильтровали новые реакции ( `google.workspace.chat.reaction.v1.created` ), сервер также возвращает Batch новые реакции событий ( `google.workspace.chat.reaction.v1.batchCreated` ). Список поддерживаемых типов событий см. В справочной документации `SpaceEvents` . При желании вы также можете отфильтровать по времени начала ( `start_time` ) и времени окончания ( `end_time` ): `start_time` : Exclusive TimeStamp, с которой можно начать список космических событий. Вы можете перечислить события, которые произошли до 28 дней назад. Если не указано, перечисляет космические события за последние 28 дней. `end_time` : включающая временная метка до тех пор, пока не будут перечислены космические события. В случае неопределенности перечислены события до времени запроса. Чтобы указать время начала или окончания, используйте оператор Equals `=` Format в RFC-3339 . Чтобы отфильтровать как на `start_time` , так и `end_time` , используйте `AND` оператор. Например, следующие запросы действительны: `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")` Следующие запросы недействительны: `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_ARGUMENT` .

ListSpaceEventsResponse

Ответ Сообщение для перечисления космических событий.

Поля

space_events[]

SpaceEvent

Результаты возвращаются в хронологическом порядке (сначала самое старое событие). ПРИМЕЧАНИЕ. Поле permissionSettings не возвращается в объекте Space для запросов списка.

next_page_token

string

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

ListspacesRequest

Запрос на перечисление пространств, которым является абонент.

Поля

page_size

int32

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

В случае неопределенности, не более 100 мест возвращаются.

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

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

page_token

string

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

filter

string

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

Вы можете отфильтровать пространства по типу пространства ( space_type ).

Чтобы отфильтровать по типу пространства, вы должны указать допустимое значение Enum, такое как SPACE или GROUP_CHAT ( space_type не может быть SPACE_TYPE_UNSPECIFIED ). Чтобы запросить несколько типов пространства, используйте оператор OR .

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

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

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Listspacesresponse

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

Поля

spaces[]

MembershipCreatedEventData

Список пробелов на запрошенной (или первой) странице. ПРИМЕЧАНИЕ. Поле permissionSettings не возвращается в объекте Space для запросов списка.

next_page_token

string

Matchedurl

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

Поля

url

string

Только вывод. URL, который был сопоставлен.

Членство

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

Поля
`name`	`string` Идентификатор. Имя ресурса членства, назначенное сервером. Формат: `spaces/{space}/members/{member}`
`state`	`MembershipState` Только вывод. Состояние членства.
`role`	`MembershipRole` Необязательный. Роль пользователя в пространстве чата, которая определяет их разрешенные действия в пространстве. Это поле можно использовать только в качестве ввода в `UpdateMembership` .
`create_time`	`Timestamp`
`delete_time`	`Timestamp`
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`
`group_member`	`Group` 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. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.
`ROLE_MANAGER`	A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in `SpaceType.SPACE` .

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` 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` 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. For more information, see View text formatting sent in a message
`cards[] (deprecated)`	`Card` This item is deprecated! 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` 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 associated with the `text` in this message.
`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`
`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`
`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`
`emoji_reaction_summaries[]`	`EmojiReactionSummary` Output only. The list of emoji reaction summaries on the message.
`private_message_viewer`	`User` Вложения 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` Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.
`attached_gifs[]`	`AttachedGif` Output only. GIF images that are attached to the message.
`accessory_widgets[]`	`AccessoryWidget` 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 , deleteTime , and deletionMetadata fields are populated.

MessageUpdatedEventData

Event payload for an updated message.

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

Поля

message

ReactionCreatedEventData

The updated message.

QuotedMessageMetadata

Information about a quoted message.

Поля

name

string

Output only. Resource name of the quoted message.

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

last_update_time

Timestamp

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

Реакция

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.

Поля
`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.

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.

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

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[]

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.

Космос

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. Format: `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` This item is deprecated! Output only. Deprecated: Use `space_type` instead. The type of a space.
`space_type`	`SpaceType`
`single_user_bot_dm`	`bool`
`threaded (deprecated)`	`bool` This item is deprecated! Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
`display_name`	`string` For direct messages, this field might be empty. Supports up to 128 characters.
`external_user_allowed`	`bool` 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`
`space_history_state`	`HistoryState`
`import_mode`	`bool` Creating a space in `Import Mode` requires user authentication .
`create_time`	`Timestamp` 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`
`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` In the format `customers/{customer}` , where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) . Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. Developer Preview: Available as part of the Google Workspace Developer Preview Program , which grants early access to certain features.
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` Setting predefined permission settings supports: In Developer Preview , App authentication with administrator approval with the `chat.app.spaces` or `chat.app.spaces.create` scopes. Аутентификация пользователя
`permission_settings`	`PermissionSettings` Reading and updating permission settings supports: In Developer Preview , 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

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 in
Developer Preview: Available as part of the Google Workspace Developer Preview Program , which grants early access to certain features.

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

members_allowed

bool

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`
`modify_space_details`	`PermissionSetting`
`toggle_history`	`PermissionSetting`
`use_at_mention_all`	`PermissionSetting`
`manage_apps`	`PermissionSetting`
`manage_webhooks`	`PermissionSetting`
`post_messages`	`PermissionSetting` Output only. Setting for posting messages in a space.
`reply_messages`	`PermissionSetting`

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

Supports up to 150 characters.

guidelines

string

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.

SpaceType

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.

УведомлениеНастройка

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

SpaceUpdatedEventData

Event payload for an updated space.

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

Поля

space

The updated space.

Нить

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

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

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

SpaceNotificationSetting

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

allow_missing

bool

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