REST Resource: spaces

Ресурс: Космос

Пространство в Google Chat. Пространства — это беседы между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.

JSON-представление 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "importModeExpireTime": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Поля
name

string

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

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

Где {space} представляет собой системный идентификатор пространства. Вы можете получить идентификатор пространства, вызвав метод spaces.list() или из URL-адреса пространства. Например, если URL-адрес пространства — https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA , то идентификатор пространства — AAAAAAAAA .

type
(deprecated)

enum ( Type )

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

spaceType

enum ( SpaceType )

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

singleUserBotDm

boolean

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

threaded
(deprecated)

boolean

Только вывод. Устарело: используйте spaceThreadingState вместо этого. Определяет, объединены ли сообщения в потоки в этом пространстве.

displayName

string

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

В личных сообщениях это поле может быть пустым.

Поддерживает до 128 символов.

externalUserAllowed

boolean

Необязательно. Неизменяемо. Разрешает ли данное пространство участвовать любому пользователю Google Chat. Поле вводится при создании пространства в организации Google Workspace. Опустите это поле при создании пространств в следующих условиях:

  • Аутентифицированный пользователь использует учетную запись потребителя (неуправляемую учетную запись пользователя). По умолчанию пространство, созданное учетной записью потребителя, разрешает доступ любому пользователю Google Chat.

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

spaceThreadingState

enum ( SpaceThreadingState )

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

spaceDetails

object ( SpaceDetails )

Необязательно. Подробная информация о помещении, включая описание и правила.

spaceHistoryState

enum ( HistoryState )

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

importMode

boolean

Необязательно. Указывает, будет ли это пространство создано в Import Mode в рамках миграции данных в Google Workspace. Во время импорта пространства не будут видны пользователям до завершения импорта.

Для создания пространства в Import Mode требуется аутентификация пользователя .

createTime

string ( Timestamp format)

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

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

Отображается в выходных данных только в том случае, если spaceType имеет значение GROUP_CHAT или SPACE .

lastActiveTime

string ( Timestamp format)

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

adminInstalled

boolean

Только вывод. Для пространств прямых сообщений (DM) с приложением чата, независимо от того, было ли пространство создано администратором Google Workspace. Администраторы могут устанавливать и настраивать прямые сообщения с приложением чата от имени пользователей в своей организации.

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

membershipCount

object ( MembershipCount )

Только для вывода. Количество вступивших в членство, сгруппированное по типу участника. Заполняется, если spaceType имеет значение SPACE , DIRECT_MESSAGE или GROUP_CHAT .

accessSettings

object ( AccessSettings )

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

spaceUri

string

Только для вывода. URI для доступа пользователя к пространству.

importModeExpireTime

string ( Timestamp format)

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

Каждое пространство, созданное в режиме импорта, должно выйти из этого режима до истечения указанного времени с помощью spaces.completeImport .

Это поле заполняется только для пространств, созданных в режиме импорта.

customer

string

Необязательный параметр. Неизменяемый. Идентификатор клиента домена пространства. Требуется только при создании пространства с аутентификацией приложения , если SpaceType имеет значение SPACE ; в противном случае параметр задавать не следует.

В формате customers/{customer} , где customer — это id из ресурса customer в Admin SDK . Частные приложения также могут использовать псевдоним customers/my_customer для создания пространства в той же организации Google Workspace, что и приложение.

Это поле не заполняется для личных сообщений (DM) или при создании пространства пользователями, не являющимися пользователями Google Workspace.

Поле объединения space_permission_settings . Представляет собой настройки разрешений пространства. Заполняется только тогда, когда space_type имеет значение SPACE . space_permission_settings может принимать только одно из следующих значений:
predefinedPermissionSettings

enum ( PredefinedPermissionSettings )

Необязательно. Только для ввода. Предопределенные настройки разрешений пространства, вводятся только при создании пространства. Если поле не заполнено, создается пространство для совместной работы. После создания пространства настройки заполняются в поле PermissionSettings .

Настройка предопределенных параметров разрешений поддерживает:

permissionSettings

object ( PermissionSettings )

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

Чтение и обновление настроек прав доступа поддерживают:

Тип

Устарело: используйте SpaceType вместо этого.

Перечисления
TYPE_UNSPECIFIED Сдержанный.
ROOM Разговор между двумя или более людьми.
DM Прямое общение 1:1 между человеком и приложением для чата, где все сообщения отображаются в плоском формате. Обратите внимание, что это не включает прямые сообщения между двумя людьми.

Тип пространства

Тип пространства. Обязательно при создании или обновлении пространства. Выводится только для других целей.

Перечисления
SPACE_TYPE_UNSPECIFIED Сдержанный.
SPACE Место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. В SPACE могут находиться приложения для чата.
GROUP_CHAT Групповые беседы между тремя и более людьми. В GROUP_CHAT могут входить приложения для чата.
DIRECT_MESSAGE Сообщения один на один между двумя людьми или между человеком и приложением для чата.

SpaceThreadingState

Указывает тип состояния ветки обсуждения в пространстве чата.

Перечисления
SPACE_THREADING_STATE_UNSPECIFIED Сдержанный.
THREADED_MESSAGES Именованные пространства, поддерживающие цепочки сообщений. Когда пользователи отвечают на сообщение, они могут делать это в рамках цепочки сообщений, сохраняя свой ответ в контексте исходного сообщения.
GROUPED_MESSAGES Названные пространства, где обсуждение организовано по темам. Темы и ответы на них сгруппированы вместе.
UNTHREADED_MESSAGES Личные сообщения (DM) между двумя людьми и групповые беседы между тремя и более людьми.

SpaceDetails

Подробная информация о помещении, включая описание и правила.

JSON-представление 
{
  "description": string,
  "guidelines": string
}
Поля
description

string

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

Поддерживает до 150 символов.

guidelines

string

Необязательно. Правила, ожидания и этикет этого места.

Поддерживает до 5000 символов.

ИсторияШтата

История сообщений и пространств. Указывает, как долго сообщения и цепочки бесед сохраняются после создания.

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

Количество участников

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

JSON-представление 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Поля
joinedDirectHumanUserCount

integer

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

joinedGroupCount

integer

Только вывод. Количество всех групп, которые напрямую присоединились к пространству.

Настройки доступа

Представляет собой настройки доступа к пространству.

JSON-представление 
{
  "accessState": enum (AccessState),
  "audience": string
}
Поля
accessState

enum ( AccessState )

Только для вывода. Указывает состояние доступа к пространству.

audience

string

Необязательно. Название ресурса целевой аудитории , которая может найти пространство, присоединиться к нему и просмотреть сообщения в нем. Если не указано, доступ к пространству имеют только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробнее см. раздел «Как сделать пространство доступным для целевой аудитории» .

Формат: audiences/{audience}

Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение audiences/default .

Ознакомление с целевой аудиторией помогает:

Это поле не заполняется при использовании области действия chat.bot с аутентификацией приложения .

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

AccessState

Отражает состояние доступа к пространству.

Перечисления
ACCESS_STATE_UNSPECIFIED Состояние доступа неизвестно или не поддерживается в этом API.
PRIVATE Доступ к пространству имеют только пользователи или группы Google, добавленные индивидуально или приглашенные другими пользователями или администраторами Google Workspace.
DISCOVERABLE

Администратор пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, добавленные или приглашенные в пространство, также могут найти и получить к нему доступ. Для получения дополнительной информации см. раздел «Как сделать пространство доступным для определенных пользователей» .

Для создания доступных для поиска пространств требуется аутентификация пользователя .

Предопределенные настройки разрешений

Предопределенные параметры разрешений, которые можно указать только при создании именованного пространства. В будущем могут быть добавлены и другие параметры. Подробную информацию о параметрах разрешений для именованных пространств см. в разделе «Узнайте больше о пространствах» .

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

Настройки разрешений

Параметры разрешений , которые можно указать при обновлении существующего именованного пространства.

Чтобы задать параметры разрешений при создании пространства, укажите поле PredefinedPermissionSettings в вашем запросе.

JSON-представление 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Поля
manageMembersAndGroups

object ( PermissionSetting )

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

modifySpaceDetails

object ( PermissionSetting )

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

toggleHistory

object ( PermissionSetting )

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

useAtMentionAll

object ( PermissionSetting )

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

manageApps

object ( PermissionSetting )

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

manageWebhooks

object ( PermissionSetting )

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

postMessages

object ( PermissionSetting )

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

replyMessages

object ( PermissionSetting )

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

Настройки разрешений

Представляет собой настройку разрешений доступа к пространству.

JSON-представление 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean,
  "assistantManagersAllowed": boolean
}
Поля
managersAllowed

boolean

Необязательно. Указывает, имеют ли владельцы пространства ( ROLE_MANAGER ) это разрешение.

membersAllowed

boolean

Необязательно. Указывает, имеют ли базовые участники пространства ( ROLE_MEMBER ) это разрешение.

assistantManagersAllowed

boolean

Необязательно. Указывается, имеют ли менеджеры пространства ROLE_ASSISTANT_MANAGER ) это разрешение.

Методы

completeImport

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

create

 Создаёт пространство.

delete

 Удаляет именованное пространство.

findDirectMessage

 Возвращает существующее личное сообщение с указанным пользователем.

findGroupChats

 Возвращает все пространства с spaceType == GROUP_CHAT , в которых в списке участников, состоящих из людей, содержится ровно тот же пользователь, который совершил звонок, и пользователи, указанные в FindGroupChatsRequest.users .

get

 Возвращает подробную информацию о помещении.

list

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

patch

 Обновляет пространство.
Возвращает список пространств в организации Google Workspace на основе поиска, выполненного администратором.

setup

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