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

Идентификатор календаря связанного календаря.

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

Метка раньше отображалась в пункте меню действий.

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} может быть адресом электронной почты пользователя. Для пользователей в одной организации Workspace {user} также может быть id человека из API People или id пользователя в API каталога. Например, если идентификатор профиля пользователя People API для user@example.com — 123456789 , вы можете добавить пользователя в пространство, задав для membership.member.name users/user@example.com илиusers users/123456789 .

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

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

bool

Необязательно. Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуется область действия OAuth 2.0 chat.admin.memberships .

Создание членства в приложении или создание членства для пользователей за пределами организации Google Workspace, принадлежащей администратору, не поддерживается с использованием доступа администратора.

string

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

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

Message

Обязательно. Тело сообщения.

string

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

string

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

MessageReplyOption

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

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

string

Необязательно. Пользовательский идентификатор сообщения. Позволяет приложениям чата получать, обновлять или удалять сообщения без необходимости сохранять назначенный системой идентификатор в имени ресурса сообщения (представленном в поле 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 с аутентификацией пользователя или область chat.memberships.app с аутентификацией приложения и формат spaces/{space}/members/{member} . Вы можете использовать адрес электронной почты в качестве псевдонима для {member} . Например, spaces/{space}/members/example@gmail.com , где example@gmail.com — это адрес электронной почты пользователя Google Chat.

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

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

bool

Необязательно. Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуется область действия OAuth 2.0 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 Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуется область действия OAuth 2.0 chat.admin.delete .

DeletionType

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

Card

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

ActionStatus

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

Dialog

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

string

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

DriveDataRef

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

string

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

string

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

CustomEmoji

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

Emoji

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

int32

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

string

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

Формат: users/{user} , где {user} — это либо id человека из API People, либо id пользователя в API каталога. Например, если идентификатор профиля People API — 123456789 , вы можете найти прямое сообщение с этим человеком, указав в качестве name users/123456789 . После аутентификации пользователя вы можете использовать адрес электронной почты в качестве псевдонима для {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 , где example@gmail.com — это адрес электронной почты пользователя Google Chat.

bool

Необязательно. Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуются области действия OAuth 2.0 chat.admin.memberships или chat.admin.memberships.readonly .

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

string

Обязательно. Имя ресурса сообщения.

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

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

string

Обязательно. Имя ресурса космического события.

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

string

Обязательно. Формат: пользователи/{пользователь}/пространства/{пробел}/spaceNotificationSetting

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

string

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

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

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

• me псевдоним. Например, users/me/spaces/{space}/spaceReadState .

• Их адрес электронной почты Workspace. Например, users/user@example.com/spaces/{space}/spaceReadState .

• Их идентификатор пользователя. Например, users/123456789/spaces/{space}/spaceReadState .

Формат: пользователи/{пользователь}/пространства/{пространство}/spaceReadState

string

Обязательно. Имя ресурса пространства в форме spaces/{space} .

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

bool

Необязательно. Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуются области действия chat.admin.spaces или chat.admin.spaces.readonly OAuth 2.0 .

string

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

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

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

• me псевдоним. Например, users/me/spaces/{space}/threads/{thread}/threadReadState .

• Их адрес электронной почты Workspace. Например, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState .

• Их идентификатор пользователя. Например, users/123456789/spaces/{space}/threads/{thread}/threadReadState .

Формат: пользователи/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Название ресурса для группы Google.

Представляет группу в Cloud Identity Groups 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 .

Если для use_admin_access установлено значение true, member.type = "HUMAN" , member.type != "BOT" . Фильтры других типов участников будут отклонены.

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

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 Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах .

Требуется область OAuth 2.0 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 ).

Чтобы фильтровать сообщения по дате их создания, укажите 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.unicode или emoji.custom_emoji.uid ) и пользователю ( user.name ).

Чтобы отфильтровать реакции для нескольких смайлов или пользователей, объедините похожие поля с помощью оператора OR , например emoji.unicode = "🙂" OR emoji.unicode = "👍" и user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" .

Чтобы фильтровать реакции по смайликам и пользователю, используйте оператор 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 Chat , в котором произошли события.

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

int32

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

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

string

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

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

string

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

Вы должны указать хотя бы один тип события ( event_type ), используя оператор has : Для фильтрации по нескольким типам событий используйте оператор OR . Исключите типы пакетных событий в фильтре. Запрос автоматически возвращает все связанные пакетные события. Например, если вы фильтруете по новым реакциям ( google.workspace.chat.reaction.v1.created ), сервер также возвращает пакетные события новых реакций ( google.workspace.chat.reaction.v1.batchCreated ). Список поддерживаемых типов событий см. в справочной документации SpaceEvents .

При желании вы также можете фильтровать по времени начала ( start_time ) и времени окончания ( end_time ):

• start_time : эксклюзивная временная метка, с которой начинается список космических событий. Вы можете перечислить события, произошедшие не более 28 дней назад. Если не указано, перечисляет космические события за последние 28 дней.
• end_time : временная метка, до которой будут перечислены космические события. Если не указано, выводит список событий до момента запроса.

Чтобы указать время начала или окончания, используйте оператор равенства = и формат в 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 ).

Для фильтрации по типу пространства необходимо указать допустимое значение перечисления, например 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

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

Type

Указывает тип пространства Meet.

HuddleStatus

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

string

Identifier. Resource name of the membership, assigned by the server.

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

MembershipState

Output only. State of the membership.

MembershipRole

Optional. User's role within a Chat space, which determines their permitted actions in the space.

This field can only be used as input in UpdateMembership .

Timestamp

Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces.

Timestamp

Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces.

User

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

Group

Optional. The Google Group the membership corresponds to.

Reading or mutating memberships for Google Groups requires user authentication .

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 can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with start_index and length of 0.

Thread

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

Optional. Information about a message that another message quotes.

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

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

For example usage, see Quote another message .

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

Required. Resource name of the message that is quoted.

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

Timestamp

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

If the message was edited, use this field, last_update_time . If the message was never edited, use create_time .

If last_update_time doesn't match the latest version of the quoted message, the request fails.

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.

MeetSpaceLinkData

Data for a Meet space link.

CalendarEventLinkData

Data for a Calendar event 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. 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

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

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

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

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.

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

• quoted_message_metadata (Only allows removal of the quoted message.)

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 .

Формат: пользователи/{пользователь}/пространства/{пространство}/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.