Package google.chat.v1

ButtonList

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

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

SelectionItem

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

string

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

SelectionItems

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

Code

Код состояния.

string

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

AnnotationType

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

int32

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

int32

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

UserMentionMetadata

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

SlashCommandMetadata

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

RichLinkMetadata

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

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

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

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 .

Когда приложение чата создает для себя отношение членства, оно должно пройти аутентификацию как пользователь и использовать область 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 .

string

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

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

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

string

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

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

При удалении членства в приложении требуется 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 , где 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 /spacenotificationsetting, или
• users/123456789/spaces/{space}/spaceNotificationSetting . Примечание. На пути разрешен только идентификатор пользователя или электронную почту вызывающего абонента.

string

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

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

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

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

• Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/spaceReadState /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.readonly chat.admin.spaces .

string

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

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

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

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

• Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState /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 оператор.

Либо use_admin_access 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 Respace пользователя.

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

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

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

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

Список новых членов.

MembershipDeletedEventData

Список удаленных членов.

MembershipUpdatedEventData

Список обновленных членов.

Membership

Новое членство.

Membership

Удаленное членство. Только name и state поля заполнены.

Membership

Обновленное членство.

string

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

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

Где {space} -это идентификатор пространства, в котором публикуется сообщение, а {message} -это идентификатор, посвященный системе для сообщения. Например, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB .

Если вы установите пользовательский идентификатор при создании сообщения, вы можете использовать этот идентификатор для указания сообщения в запросе, заменив {message} на поле clientAssignedMessageId . Например, spaces/AAAAAAAAAAA/messages/client-custom-name . Для получения подробной информации см. Имя сообщения .

User

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

Timestamp

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

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

Timestamp

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

Timestamp

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

string

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

Чтобы узнать о создании текстовых сообщений, см. Отправить сообщение .

string

Только вывод. Содержит text сообщения с разметками, добавленными для передачи форматирования. Это поле может не захватить все форматирование, видимое в пользовательском интерфейсе, но включает в себя следующее:

• Синтаксис разметки для жирного шрифта, курсивного, ударного, монопрояжника, блока монопроизводства и списка с маркировкой.

• Пользователь упоминает, используя формат <users/{user}> .

• Пользовательские гиперссылки с использованием формата <{url}|{rendered_text}> , где первая строка - URL, а вторая - текст рендеринга - например, <http://example.com|custom text> .

• Пользовательский эмодзи с использованием формата :{emoji_name}: - например,: :smile: . Это не относится к Emoji Unicode, например, U+1F600 для ухмыляющегося лица.

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

Card

Устроенный: используйте cards_v2 вместо этого.

Богатые, отформатированные и интерактивные карты, которые вы можете использовать для отображения элементов пользовательского интерфейса, таких как: форматированные тексты, кнопки и кликабельные изображения. Карты обычно отображаются ниже простого тела сообщения. cards и cards_v2 могут иметь максимальный размер 32 КБ.

CardWithId

Необязательный. Множество карт .

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

Чтобы узнать, как создать сообщение, которое содержит карты, см. Отправить сообщение .

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

Annotation

Только вывод. Аннотации, связанные с text в этом сообщении.

Thread

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

Space

Только вывод. Если ваше приложение в чате аутентифицируется как пользователь , вывод только заполняет name пространства .

string

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

ActionResponse

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

string

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

SlashCommand

Только вывод. Информация о команде SLASH, если применимо.

Attachment

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

MatchedUrl

Только вывод. URL в spaces.messages.text , который соответствует шаблону предварительного просмотра ссылки. Для получения дополнительной информации см. Предварительные ссылки .

bool

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

Если пространство не поддерживает ответ в потоках, это поле всегда false .

string

Необязательный. Пользовательский идентификатор для сообщения. Вы можете использовать поле для определения сообщения или для получения, удаления или обновления сообщения. Чтобы установить пользовательский идентификатор, укажите поле messageId при создании сообщения. Для получения подробной информации см. Имя сообщения .

EmojiReactionSummary

Только вывод. Список резюме реакции эмодзи на сообщении.

User

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

• Вложения
• Аксессуальные виджеты

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

DeletionMetadata

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

QuotedMessageMetadata

Только вывод. Информация о сообщении, которое цитируется пользователем Google Chat в пространстве. Пользователи Google Chat могут процитировать сообщение, чтобы ответить на него.

AttachedGif

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

AccessoryWidget

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

Создание сообщения с помощью аксессуаров требует аутентификации приложений .

MessageCreatedEventData

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

MessageDeletedEventData

Список удаленных сообщений.

MessageUpdatedEventData

Список обновленных сообщений.

Message

Новое сообщение.

Message

Удаленное сообщение. Только поля name , createTime , deleteTime и deletionMetadata заполняются.

Message

Обновленное сообщение.

string

Только вывод. Имя ресурса цитируемого сообщения.

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

Timestamp

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

string

Идентификатор. Название ресурса реакции.

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

User

Output only. The user who created the reaction.

Emoji

Необходимый. 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

Необходимый. 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

Необязательный. 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

Необходимый. 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

Необязательный. 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

Необязательный. 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 20 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 invoked.

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

Идентификатор. 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

Необязательный. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.

bool

Необязательный. 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

Необязательный. 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

Необязательный. 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

Необязательный. Details about the space including description and rules.

HistoryState

Необязательный. The message history state for messages and threads in this space.

bool

Необязательный. 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

Необязательный. 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

Необязательный. 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.

string

Необязательный. 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

Необязательный. 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.

PermissionSettings

Необязательный. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

AccessState

Output only. Indicates the access state of the space.

string

Необязательный. 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

Необязательный. Whether spaces managers have this permission.

bool

Необязательный. Whether non-manager members have this permission.

PermissionSetting

Необязательный. Setting for managing members and groups in a space.

PermissionSetting

Необязательный. Setting for updating space name, avatar, description and guidelines.

PermissionSetting

Необязательный. Setting for toggling space history on and off.

PermissionSetting

Необязательный. Setting for using @all in a space.

PermissionSetting

Необязательный. Setting for managing apps in a space.

PermissionSetting

Необязательный. Setting for managing webhooks in a space.

PermissionSetting

Output only. Setting for posting messages in a space.

PermissionSetting

Необязательный. Setting for replying to messages in a space.

string

Необязательный. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

string

Необязательный. 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

Идентификатор. 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

Необязательный. 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

Идентификатор. Resource name of the thread.

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

string

Необязательный. 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

Необходимый. The membership to update. Only fields specified by update_mask are updated.

FieldMask

Необходимый. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

• role

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 the chat.admin.memberships OAuth 2.0 scope .

Message

Необходимый. Message with fields updated.

FieldMask

Необходимый. 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

Необязательный. 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

Необходимый. 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

Необходимый. Supported field paths: - notification_setting - mute_setting

SpaceReadState

Необходимый. 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

Необходимый. 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

Необходимый. 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

Необходимый. 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

Необязательный. 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.

string

The URL of the image.

OnClick

The onclick action.

double

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

OnClick

The onclick action.

string

The name of this image_button that's used for accessibility. Default value is provided if this name isn't specified.

Icon

The icon specified by an enum that indices to an icon provided by Chat API.

string

The icon specified by a URL.

string

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

string

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

bool

If the content should be multiline.

string

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

OnClick

The onclick action. Only the top label, bottom label, and content region are clickable.

Icon

An enum value that's replaced by the Chat API with the corresponding icon image.

string

The icon specified by a URL.

Button

A button that can be clicked to trigger an action.

FormAction

A form action is triggered by this onclick action if specified.

OpenLink

This onclick action triggers an open link action if specified.

string

The URL to open.

string

The text of the button.

OnClick

The onclick action of the button.

string