Package google.chat.v1

ButtonList

Список кнопок.

ResponseType

Только ввод. Тип ответа чат-приложения.

string

Только ввод. URL-адрес для аутентификации или настройки пользователей. (Только для типов ответов REQUEST_CONFIG .)

DialogAction

Только ввод. Ответ на событие взаимодействия, связанное с диалогом . Должен сопровождаться ResponseType.Dialog .

UpdatedWidget

Только ввод. Ответ обновлённого виджета.

SelectionItem

Массив объектов SelectionItem.

string

Идентификатор обновлённого виджета. Идентификатор должен совпадать с идентификатором виджета, который инициировал запрос на обновление.

SelectionItems

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

Code

Код статуса.

string

Сообщение, отправляемое пользователям о статусе их запроса. Если не установлено, отправляется общее сообщение на основе status_code .

AnnotationType

Тип этой аннотации.

int32

Длина подстроки в теле текстового сообщения, которой соответствует эта аннотация.

int32

Начальный индекс (начиная с 0 включительно) в теле текстового сообщения, которому соответствует эта аннотация.

UserMentionMetadata

Метаданные упоминания пользователя.

SlashCommandMetadata

Метаданные для команды «косая черта».

RichLinkMetadata

Метаданные для расширенной ссылки.

CustomEmojiMetadata

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

int32

Идентификатор команды, указанный в конфигурации API чата.

AppCommandType

Тип команды приложения чата.

string

Только вывод. URL-адрес, на котором размещено GIF-изображение.

string

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

string

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

string

Только вывод. Тип содержимого (MIME-тип) файла.

string

Только вывод. URL-адрес миниатюры, который следует использовать для предварительного просмотра вложения пользователем. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложения.

string

Только вывод. URL-адрес для загрузки, который должен использоваться для загрузки вложения пользователем. Приложения чата не должны использовать этот URL для загрузки содержимого вложения.

Source

Только вывод. Источник вложения.

AttachmentDataRef

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

DriveDataRef

Только вывод. Ссылка на вложение Google Диска. Это поле используется с API Google Диска.

string

Необязательно. Имя ресурса данных вложения. Это поле используется API мультимедиа для загрузки данных вложения.

string

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

string

Обязательно, если сообщение содержит несколько карт. Уникальный идентификатор карты в сообщении.

Card

Карта. Максимальный размер — 32 КБ.

string

Пространство связанного ресурса пространства чата.

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

string

Ветка связанного ресурса чат-пространства.

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

string

Сообщение связанного ресурса чат-пространства.

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

string

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

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

Space

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

CardHeader

Заголовок карты. Заголовок обычно содержит заголовок и изображение.

Section

Разделы разделены линейным разделителем.

CardAction

Действия этой карты.

string

Название карты.

string

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

OnClick

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

string

Название должно быть указано. Заголовок имеет фиксированную высоту: если указан как заголовок, так и подзаголовок, каждая занимает одну строку. Если указано только заголовок, он занимает обе строки.

string

Подзаголовок заголовка карты.

ImageStyle

Тип изображения (например, квадратная граница или круговая граница).

string

URL -адрес изображения в заголовке карты.

string

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

WidgetMarkup

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

CustomEmoji

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

string

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

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

Membership

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

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

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

• При аутентификации в качестве пользователя требуется область авторизации chat.memberships .

• При аутентификации в качестве приложения требуется область авторизации chat.app.memberships . Аутентификация в качестве приложения доступна в

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

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

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

bool

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

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

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

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

string

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

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

Message

Требуется Тело сообщения.

string

Необязательный. Установите: используйте thread.thread_key вместо этого. ID для потока. Поддерживает до 4000 символов. Чтобы запустить или добавить в поток, создайте сообщение и укажите threadKey или thread.name . Например, используйте, см. Запуск или ответьте на поток сообщения .

string

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

MessageReplyOption

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

При ответе на взаимодействие с пользователями это поле игнорируется. Для взаимодействия в потоке ответ создается в том же потоке. В противном случае ответ создан как новый поток.

string

Необязательный. Пользовательский идентификатор для сообщения. Lets Chat Приложения получают, обновляют или удаляете сообщение без необходимости хранить идентификатор, назначенный системой, в имени ресурса сообщения (представлено в поле name сообщения»).

Значение для этого поля должно соответствовать следующим требованиям:

• Начинается с client- . Например, client-custom-name -это действительный пользовательский идентификатор, но custom-name нет.
• Содержит до 63 символов и только строчные буквы, цифры и дефисы.
• Уникален в пространстве. Приложение чата не может использовать один и тот же пользовательский идентификатор для разных сообщений.

Для получения подробной информации см. Имя сообщения .

string

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

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

Reaction

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

Space

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

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

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

string

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

string

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

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

string

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

string

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

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

Имена эмодзи должны начинать и заканчиваться колонами, должны быть строчными и могут содержать только буквенно -цифровые символы, дефисы и подчеркивание. Дефисы и подставки должны использоваться для разделения слов и нельзя использовать последовательно.

Пример:: :valid-emoji-name:

string

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

CustomEmojiPayload

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

bytes

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

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

string

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

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

CustomEmoji

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

string

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

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

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

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 .

bool

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

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

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

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

string

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

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

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

bool

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

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

string

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

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

string

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

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

bool

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

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

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

DeletionType

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

Card

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

ActionStatus

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

Dialog

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

string

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

DriveDataRef

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

string

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

string

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

CustomEmoji

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

Emoji

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

int32

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

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.

string

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

string

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

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

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

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.

bool

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

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

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

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

string

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

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

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

string

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

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

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 . Примечание. На пути разрешен только идентификатор пользователя или электронную почту вызывающего абонента.

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

string

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

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

bool

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

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

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

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

string

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

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

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

int32

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

string

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

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

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

string

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

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

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

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

creator("users/me")

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

CustomEmoji

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

string

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

string

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

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

int32

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

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

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

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

string

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

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

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 .

bool

Необязательный. Когда true также возвращает членство, связанное с Google Group , в дополнение к другим типам членства. Если установлен filter , членство Google Group , которое не соответствует критериям фильтра, не возвращаются.

bool

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

В настоящее время требуется аутентификация пользователя .

bool

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

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

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

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

Membership

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

string

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

string

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

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

int32

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

Если не указано, не более 25 возвращаются.

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

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

string

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

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

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 .

string

Необязательный. Как упорядочен список сообщений. Укажите значение по заказу с помощью операции заказа. Допустимые значения операции заказа следующие:

• ASC для восхождения.

• DESC для спуска.

Порядок по умолчанию - create_time ASC .

bool

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

Message

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

string

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

string

Требуется Пользователи сообщений отреагировали на.

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

int32

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

string

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

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

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

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 .

Reaction

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

string

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

string

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

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

int32

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

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

string

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

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

string

Требуется Фильтр запросов.

Вы должны указать хотя бы один тип события ( event_type ), используя оператор HASE : Чтобы отфильтровать по нескольким типам событий, используйте оператор OR . Опустите типы событий партии в вашем фильтре. Запрос автоматически возвращает любые связанные пакетные события. Например, если вы фильтровали новые реакции ( google.workspace.chat.reaction.v1.created ), сервер также возвращает партии новых событий реакций ( 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 .

SpaceEvent

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

string

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

int32

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

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

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

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

string

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

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

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 .

Space

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

string

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

string

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

string

Идентификатор. Имя ресурса членства, назначенное сервером.

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

MembershipState

Только вывод. Состояние членства.

MembershipRole

Необязательный. Роль пользователя в пространстве чата, которая определяет их разрешенные действия в пространстве.

Это поле можно использовать только в качестве ввода в UpdateMembership .

Timestamp

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

Timestamp

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

User

Необязательный. Пользователь или приложение Google Chat, которому соответствует членство. Если ваше приложение в чате аутентифицируется как пользователь , вывод популяет name пользователя и type .

Group

Необязательный. Группа Google членство соответствует.

Чтение или мутирование членов для групп Google требует аутентификации пользователей .

MembershipCreatedEventData

A list of new memberships.

MembershipDeletedEventData

A list of deleted memberships.

MembershipUpdatedEventData

A list of updated memberships.

Membership

The new membership.

Membership

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

Membership

The updated membership.

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 .

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 .

Timestamp

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

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

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.

Timestamp

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

string

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

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

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

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.

CardWithId

Optional. An array of cards .

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

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

Design and preview cards with the Card Builder.

Annotation

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

Thread

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

Space

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

string

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

ActionResponse

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

string

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

SlashCommand

Output only. Slash command information, if applicable.

Attachment

Optional. User-uploaded attachment.

MatchedUrl

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

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 .

string

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message .

EmojiReactionSummary

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

User

Optional. Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following:

• Вложения
• Accessory widgets

For details, see Send a message privately .

DeletionMetadata

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

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.

AttachedGif

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

AccessoryWidget

Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

MessageCreatedEventData

A list of new messages.

MessageDeletedEventData

A list of deleted messages.

MessageUpdatedEventData

A list of updated messages.

Message

The new message.

Message

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

Message

The updated message.

string

Output only. Resource name of the quoted message.

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

Timestamp

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

string

Identifier. The resource name of the reaction.

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

User

Output only. The user who created the reaction.

Emoji

Required. The emoji used in the reaction.

ReactionCreatedEventData

A list of new reactions.

ReactionDeletedEventData

A list of deleted reactions.

Reaction

The new reaction.

Reaction

The deleted reaction.

string

The URI of this link.

RichLinkType

The rich link type.

DriveLinkData

Data for a drive link.

ChatSpaceLinkData

Data for a chat space link.

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.

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.

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.

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

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. Значение по умолчанию.

• 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

Space

A page of the requested spaces.

string

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

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.

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.

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.

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

int64

The ID of the slash command.

User

The Chat app whose command was invoked.

Type

The type of slash command.

string

The name of the invoked slash command.

int64

The command ID of the invoked slash command.

bool

Indicates whether the slash command is for a dialog.

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

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

SpaceType

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

bool

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

bool

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

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.

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.

SpaceThreadingState

Output only. The threading state in the Chat space.

SpaceDetails

Optional. Details about the space including description and rules.

HistoryState

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

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 .

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 .

Timestamp

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

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.

MembershipCount

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

AccessSettings

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

string

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

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.

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

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:

• In Developer Preview , App authentication with administrator approval with the chat.app.spaces or chat.app.spaces.create scopes.

• Аутентификация пользователя

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:

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

• Аутентификация пользователя

AccessState

Output only. Indicates the access state of the space.

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 in

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

Setting the target audience requires user authentication .

int32

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

int32

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

bool

Optional. Whether spaces managers have this permission.

bool

Optional. Whether non-manager members have this permission.

PermissionSetting

Optional. Setting for managing members and groups in a space.

PermissionSetting

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

PermissionSetting

Optional. Setting for toggling space history on and off.

PermissionSetting

Optional. Setting for using @all in a space.

PermissionSetting

Optional. Setting for managing apps in a space.

PermissionSetting

Optional. Setting for managing webhooks in a space.

PermissionSetting

Output only. Setting for posting messages in a space.

PermissionSetting

Optional. Setting for replying to messages in a space.

string

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

Supports up to 150 characters.

string

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

Supports up to 5,000 characters.

SpaceUpdatedEventData

A list of updated spaces.

string

Resource name of the space event.

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

Timestamp

Time when the event occurred.

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

MessageCreatedEventData

Event payload for a new message.

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

MessageUpdatedEventData

Event payload for an updated message.

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

MessageDeletedEventData

Event payload for a deleted message.

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

MessageBatchCreatedEventData

Event payload for multiple new messages.

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

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

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

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

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

SpaceUpdatedEventData

Event payload for a space update.

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

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

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

MembershipCreatedEventData

Event payload for a new membership.

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

MembershipUpdatedEventData

Event payload for an updated membership.

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

MembershipDeletedEventData

Event payload for a deleted membership.

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

MembershipBatchCreatedEventData

Event payload for multiple new memberships.

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

MembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

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

MembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

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

ReactionCreatedEventData

Event payload for a new reaction.

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

ReactionDeletedEventData

Event payload for a deleted reaction.

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

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

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

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

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

string

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

NotificationSetting

The notification setting.

MuteSetting

The space notification mute setting.

string

Resource name of the space read state.

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

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.

Space

The updated space.

string

Identifier. Resource name of the thread.

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

string

Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread name field instead.

string

Resource name of the thread read state.

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

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.

Membership

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

FieldMask

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

Currently supported field paths:

• role

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 .

Message

Required. Message with fields updated.

FieldMask

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

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.

SpaceNotificationSetting

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.

FieldMask

Required. Supported field paths:

• notification_setting

• mute_setting

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

FieldMask

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.

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.

FieldMask

Required. The updated field paths, comma separated if there are multiple.

You can update the following fields for a space:

space_details : Updates the space's description. Supports up to 150 characters.

display_name : Only supports updating the display name for spaces where spaceType field is SPACE . If you receive the error message ALREADY_EXISTS , try a different value. An existing space within the Google Workspace organization might already use this display name.

space_type : Only supports changing a GROUP_CHAT space type to SPACE . Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with useAdminAccess .

space_history_state : Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with useAdminAccess .

access_settings.audience : Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE . If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode . To learn more, see Make a space discoverable to specific users . access_settings.audience is not supported with useAdminAccess .

permission_settings : Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess . The supported field masks include:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

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 OAuth 2.0 scope .

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

string

Resource name for a Google Chat user .

Format: users/{user} . users/app can be used as an alias for the calling app bot user.

For human users , {user} is the same user identifier as:

• the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

• the id for a user in the Admin SDK Directory API.

• the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789 , you can use users/user@example.com as an alias to reference users/123456789 . Only the canonical resource name (for example users/123456789 ) will be returned from the API.

string

Output only. The user's display name.

string

Unique identifier of the user's Google Workspace domain.

Type

User type.

bool

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

User

The user mentioned.

Type

The type of user mention.

Button

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

TextParagraph

Display a text paragraph in this widget.

Image

Display an image in this widget.

KeyValue

Display a key value item in this widget.

TextButton

A button with text and onclick action.

ImageButton

A button with image and onclick action.

string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

ActionParameter

List of action parameters.

string

The name of the parameter for the action script.

string

The value of the parameter.