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,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
Поля
name

string

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

Format: 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 ; в противном случае параметр задавать не следует.

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.

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

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

enum ( 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:

permissionSettings

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

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

Конец взаимоисключающих областей.

Тип

Deprecated: Use SpaceType instead.

Перечисления
TYPE_UNSPECIFIED Сдержанный.
ROOM Conversations between two or more humans.
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

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

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

SpaceDetails

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

JSON representation
{
  "description": string,
  "guidelines": string
}
Fields
description

string

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

Supports up to 150 characters.

guidelines

string

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

Supports up to 5,000 characters.

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

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

Перечисления
HISTORY_STATE_UNSPECIFIED Default value. Do not use.
HISTORY_OFF История сообщений отключена. Сообщения и ветки обсуждений сохраняются в течение 24 часов .
HISTORY_ON История продолжается. Правила хранения данных в хранилище организации определяют, как долго хранятся сообщения и переписки.

MembershipCount

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

JSON representation
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Fields
joinedDirectHumanUserCount

integer

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

joinedGroupCount

integer

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

AccessSettings

Represents the access setting of the space.

JSON representation
{
  "accessState": enum (AccessState),
  "audience": string,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
Fields
accessState

enum ( AccessState )

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

audience

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}

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

Reading the target audience supports:

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

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

accessPermissionSettings

object ( AccessPermissionSettings )

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

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

AccessState

Represents the access state of the space.

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

A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users .

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

AccessPermissionSettings

Access permission settings for a space.

JSON-представление
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  }
}
Fields
discoverSpaceSetting

object ( AccessPermissionSetting )

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

joinSpaceSetting

object ( AccessPermissionSetting )

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

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

An access permission setting.

JSON-представление
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Поля
principals[]

object ( Principal )

Необязательный. Неупорядоченный список. Разрешенные субъекты для этого разрешения.

Главный

Доступ предоставлен субъектом, представляющим организацию.

JSON-представление
{

  "audience": {
    object (Audience)
  }
}
Поля
Тип субъекта. Ниже приведён список взаимоисключающих полей. В ответе будет установлено не более одного из этих полей:
audience

object ( Audience )

Аудитория.

Конец взаимоисключающих областей.

Аудитория

A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users.

Для получения более подробной информации см. разделы «Целевая аудитория» и «Как сделать пространство доступным для целевой аудитории» .

JSON representation
{
  "name": string
}
Поля
name

string

Название ресурса целевой аудитории , которая может найти это пространство или присоединиться к нему. Подробнее см. раздел «Как сделать пространство доступным для целевой аудитории» . Формат: audiences/{audience}

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

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

Predefined permission settings that you can only specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces .

Перечисления
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

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