Package google.chat.v1

ButtonList

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

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

SelectionItem

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

string

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

SelectionItems

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

Code

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

string

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

AnnotationType

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

int32

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

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

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

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

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

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

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

Необходимо. Реакция, необходимая для создания.

string

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

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

Section

Обязательно. Раздел для создания.

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

Обязательно. Название раздела для удаления.

Формат: users/{user}/sections/{section}

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 Google Диска.

DriveDataRef

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

string

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

string

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

CustomEmoji

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

Emoji

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

int32

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

string

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

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

string

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

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

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

int32

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

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

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

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

string

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

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

SpaceView

Запрашиваемый тип представления пространства. Если не задано, по умолчанию используется SPACE_VIEW_RESOURCE_NAME_ONLY . Запросы, указывающие SPACE_VIEW_EXPANDED , должны включать области действия, разрешающие чтение данных пространства, например, https://www.googleapis.com/auth/chat.spaces или https://www.googleapis.com/auth/chat.spaces.readonly .

Space

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

string

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

string

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

string

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

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

Обязательно. Формат: users/{user}/spaces/{space}/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 .

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

string

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

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

bool

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

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

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

string

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

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

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

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

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

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

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

string

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

Представляет группу в API Cloud Identity Groups.

Формат: groups/{group}

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

Required. The resource name of the space to list messages from.

Format: spaces/{space}

int32

Optional. The maximum number of messages returned. The service might return fewer messages than this value.

If unspecified, at most 25 are returned.

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

Negative values return an INVALID_ARGUMENT error.

string

Optional. A page token received from a previous list messages 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

Optional. A query filter.

You can filter messages by date ( create_time ) and thread ( thread.name ).

To filter messages by the date they were created, specify the create_time with a timestamp in RFC-3339 format and double quotation marks. For example, "2023-04-21T11:30:00-04:00" . You can use the greater than operator > to list messages that were created after a timestamp, or the less than operator < to list messages that were created before a timestamp. To filter messages within a time interval, use the AND operator between two timestamps.

To filter by thread, specify the thread.name , formatted as spaces/{space}/threads/{thread} . You can only specify one thread.name per query.

To filter by both thread and date, use the AND operator in your query.

For example, the following queries are valid:

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 queries are rejected by the server with an INVALID_ARGUMENT error.

string

Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:

• ASC for ascending.

• DESC for descending.

The default ordering is create_time ASC .

bool

Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

Message

List of messages.

string

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

string

Required. The message users reacted to.

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

int32

Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200.

string

Optional. (If resuming from a previous query.)

A page token received from a previous list reactions call. Provide this to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

string

Optional. A query filter.

You can filter reactions by emoji (either emoji.unicode or emoji.custom_emoji.uid ) and user ( user.name ).

To filter reactions for multiple emojis or users, join similar fields with the OR operator, such as emoji.unicode = "🙂" OR emoji.unicode = "👍" and user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" .

To filter reactions by emoji and user, use the AND operator, such as emoji.unicode = "🙂" AND user.name = "users/AAAAAA" .

If your query uses both AND and OR , group them with parentheses.

For example, the following queries are valid:

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

The following queries are invalid:

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 queries are rejected with an INVALID_ARGUMENT error.

Reaction

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

string

Continuation token to retrieve the next page of results. It's empty for the last page of results.

string

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

When you're filtering by space, use the wildcard - to search across all sections. For example, users/{user}/sections/- .

Format: users/{user}/sections/{section}

int32

Optional. The maximum number of section items to return. The service may return fewer than this value.

If unspecified, at most 10 section items will be returned.

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

Negative values return an INVALID_ARGUMENT error.

string

Optional. A page token, received from a previous list section items call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

string

Optional. A query filter.

Currently only supports filtering by space.

For example, space = spaces/{space} .

Invalid queries are rejected with an INVALID_ARGUMENT error.

SectionItem

The section items from the specified section.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

• The me alias. For example, users/me .

• Their Workspace email address. For example, users/user@example.com .

• Their user id. For example, users/123456789 .

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

int32

Optional. The maximum number of sections to return. The service may return fewer than this value.

If unspecified, at most 10 sections will be returned.

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

Negative values return an INVALID_ARGUMENT error.

string

Optional. A page token, received from a previous list sections call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Section

The sections from the specified user.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. Resource name of the Google Chat space where the events occurred.

Format: spaces/{space} .

int32

Optional. The maximum number of space events returned. The service might return fewer than this value.

Negative values return an INVALID_ARGUMENT error.

string

Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

string

Required. A query filter.

You must specify at least one event type ( event_type ) using the has : operator. To filter by multiple event types, use the OR operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions ( google.workspace.chat.reaction.v1.created ), the server also returns batch new reactions events ( google.workspace.chat.reaction.v1.batchCreated ). For a list of supported event types, see the SpaceEvents reference documentation .

Optionally, you can also filter by start time ( start_time ) and end time ( end_time ):

• start_time : Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.
• end_time : Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request.

To specify a start or end time, use the equals = operator and format in RFC-3339 . To filter by both start_time and end_time , use the AND operator.

For example, the following queries are valid:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

The following queries are invalid:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

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

SpaceEvent

Results are returned in chronological order (oldest event first). Note: The permissionSettings field is not returned in the Space object for list requests.

string

Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages.

int32

Optional. The maximum number of spaces to return. The service might 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.

Negative values return an INVALID_ARGUMENT error.

string

Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

string

Optional. A query filter.

You can filter spaces by the space type ( space_type ).

To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED ). To query for multiple space types, use the OR operator.

For example, the following queries are valid:

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

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

Space

List of spaces in the requested (or first) page. Note: The permissionSettings field is not returned in the Space object for list requests.

string

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

string

Output only. The URL that was matched.

string

Meeting code of the linked Meet space.

Type

Indicates the type of the Meet space.

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, bulleted list, and block quote.

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

• Bullet list items using asterisks ( * )—for example, * item .

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 .

Chat apps can create cards with app authentication . As part of the Developer Preview Program , if your Chat app authenticates as a user , it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication.

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 , and deletionMetadata fields are populated.

Message

The updated message.

string

Required. The resource name of the section item to move.

Format: users/{user}/sections/{section}/items/{item}

string

Required. The resource name of the section to move the section item to.

Format: users/{user}/sections/{section}

SectionItem

The updated section item.

string

Required. The resource name of the section to position.

Format: users/{user}/sections/{section}

int32

Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.

Position

Optional. The relative position of the section in the list of sections.

Section

The updated section.

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.

QuoteType

Optional. Specifies the quote type. If not set, defaults to REPLY in the message read/write path for backward compatibility.

QuotedMessageSnapshot

Output only. A snapshot of the quoted message's content.

ForwardedMetadata

Output only. Metadata about the source space of the quoted message. Populated only for FORWARD quote type.

string

Output only. The quoted message's author name. Populated for both REPLY & FORWARD quote types.

string

Output only. Snapshot of the quoted message's text content.

string

Output only. Contains the quoted message text with markups added to support rich formatting like hyperlinks,custom emojis, markup, etc. Populated only for FORWARD quote type.

Annotation

Output only. Annotations parsed from the text body of the quoted message. Populated only for FORWARD quote type.

Attachment

Output only. Attachments that were part of the quoted message. These are copies of the quoted message's attachment metadata. Populated only for FORWARD quote type.

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

Required. The resource name of the message.

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

CardWithId

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

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.

string

Identifier. Resource name of the section.

For system sections, the section ID is a constant string:

• DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
• DEFAULT_SPACES: users/{user}/sections/default-spaces
• DEFAULT_APPS: users/{user}/sections/default-apps

Format: users/{user}/sections/{section}

string

Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION . Supports up to 80 characters. Required when creating a CUSTOM_SECTION .

int32

Output only. The order of the section in relation to other sections. Sections with a lower sort_order value appear before sections with a higher value.

SectionType

Required. The type of the section.

string

Identifier. The resource name of the section item.

Format: users/{user}/sections/{section}/items/{item}

string

Optional. The space resource name.

Format: spaces/{space}

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.

This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.

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 space owners ( ROLE_MANAGER ) have this permission.

bool

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

bool

Optional. Whether space managers ROLE_ASSISTANT_MANAGER ) have this permission.