- Ресурс: Космос
- Методы
Ресурс: Космос
Пространство в Google Chat. Пространства — это беседы между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.
| JSON-представление |
|---|
{ "name": string, "type": enum ( |
| Поля | |
|---|---|
name | Идентификатор. Название ресурса пространства. Format: Где |
type | Только для вывода. Устарело: используйте |
spaceType | Необязательный параметр. Тип пространства. Обязателен при создании пространства или изменении типа пространства. Выводится только для других целей. |
singleUserBotDm | Необязательно. Укажите, является ли это личным сообщением между приложением для чата и живым человеком. |
threaded | Только вывод. Устарело: используйте |
displayName | Необязательно. Отображаемое имя пространства. Обязательно при создании пространства с В личных сообщениях это поле может быть пустым. Поддерживает до 128 символов. |
externalUserAllowed | Необязательно. Неизменяемо. Разрешает ли данное пространство участвовать любому пользователю Google Chat. Поле вводится при создании пространства в организации Google Workspace. Опустите это поле при создании пространств в следующих условиях:
Для существующих помещений это поле предназначено только для вывода. |
spaceThreadingState | Только вывод. Состояние ветки обсуждения в чате. |
spaceDetails | Необязательно. Подробная информация о помещении, включая описание и правила. |
spaceHistoryState | Необязательно. История сообщений и веток обсуждений в этом пространстве. |
importMode | Необязательно. Указывает, будет ли это пространство создано в Для создания пространства в |
createTime | Необязательно. Неизменяемо. Для пространств, созданных в чате, указывается время создания пространства. Это поле предназначено только для вывода, за исключением случаев использования в пространствах режима импорта. Для пространств в режиме импорта установите в этом поле историческую метку времени, в которую пространство было создано в источнике, чтобы сохранить исходное время создания. Отображается в выходных данных только в том случае, если |
lastActiveTime | Только вывод. Временная метка последнего сообщения в этом пространстве. |
adminInstalled | Только вывод. Для пространств прямых сообщений (DM) с приложением чата, независимо от того, было ли пространство создано администратором Google Workspace. Администраторы могут устанавливать и настраивать прямые сообщения с приложением чата от имени пользователей в своей организации. Для поддержки установки администратором ваше приложение чата должно поддерживать прямую переписку. |
membershipCount | Только для вывода. Количество вступивших в членство, сгруппированное по типу участника. Заполняется, если |
accessSettings | Необязательный параметр. Задает параметры доступа к пространству. Заполняется только в том случае, если |
spaceUri | Только для вывода. URI для доступа пользователя к пространству. |
importModeExpireTime | Только для вывода. Время, когда пространство будет автоматически удалено системой, если она останется в режиме импорта. Каждое пространство, созданное в режиме импорта, должно выйти из этого режима до истечения указанного времени с помощью Это поле заполняется только для пространств, созданных в режиме импорта. |
customer | Необязательный параметр. Неизменяемый. Идентификатор клиента домена пространства. Требуется только при создании пространства с аутентификацией приложения , если In the format Это поле не заполняется для личных сообщений (DM) или при создании пространства пользователями, не являющимися пользователями Google Workspace. |
Представляет собой настройки прав доступа для пространства. Заполняется только тогда, когда space_type имеет SPACE . Ниже приведен список взаимоисключающих полей. В ответе будет установлено не более одного из полей: | |
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 Setting predefined permission settings supports:
|
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 | Пространства, не поддерживающие многопоточность сообщений. Это состояние многопоточности используется только в особых случаях, включая:
|
SpaceDetails
Подробная информация о помещении, включая описание и правила.
| JSON representation |
|---|
{ "description": string, "guidelines": string } |
| Fields | |
|---|---|
description | Необязательно. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников мероприятия. Supports up to 150 characters. |
guidelines | Необязательно. Правила, ожидания и этикет этого места. 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 | Только вывод. Количество пользователей, которые присоединились к пространству напрямую, без учета пользователей, присоединившихся через членство в группе. |
joinedGroupCount | Только вывод. Количество всех групп, которые напрямую присоединились к пространству. |
AccessSettings
Represents the access setting of the space.
| JSON representation |
|---|
{ "accessState": enum ( |
| Fields | |
|---|---|
accessState | Только для вывода. Указывает состояние доступа к пространству. |
audience | 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: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение Reading the target audience supports:
Это поле не заполняется при использовании области действия Для указания целевой аудитории требуется аутентификация пользователя . |
accessPermissionSettings | Необязательно. Настройки прав доступа к пространству. Чтобы задать целевую аудиторию при создании пространства, укажите поле |
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 ( |
| Fields | |
|---|---|
discoverSpaceSetting | Необязательно. Настройка прав доступа для обнаружения пространства. |
joinSpaceSetting | Необязательно. Настройка прав доступа для присоединения к пространству. |
Настройка прав доступа
An access permission setting.
| JSON-представление |
|---|
{
"principals": [
{
object ( |
| Поля | |
|---|---|
principals[] | Необязательный. Неупорядоченный список. Разрешенные субъекты для этого разрешения. |
Главный
Доступ предоставлен субъектом, представляющим организацию.
| JSON-представление |
|---|
{
"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 | Название ресурса целевой аудитории , которая может найти это пространство или присоединиться к нему. Подробнее см. раздел «Как сделать пространство доступным для целевой аудитории» . Формат: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение |
Предопределенные настройки разрешений
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 ( |
| Поля | |
|---|---|
manageMembersAndGroups | Необязательный параметр. Настройка для управления участниками и группами в пространстве. |
modifySpaceDetails | Необязательно. Настройка для обновления названия пространства, аватара, описания и правил. |
toggleHistory | Необязательный параметр. Настройка для включения и выключения истории использования пространства. |
useAtMentionAll | Необязательный параметр. Настройка для использования @all в пробеле. |
manageApps | Необязательный параметр. Настройка для управления приложениями в пространстве. |
manageWebhooks | Необязательный параметр. Настройка для управления веб-хуками в пространстве. |
postMessages | Только для вывода. Настройка для публикации сообщений в пространстве. |
replyMessages | Необязательный параметр. Настройка для ответа на сообщения в рабочем пространстве. |
Настройки разрешений
Представляет собой настройку разрешений доступа к пространству.
| JSON-представление |
|---|
{ "managersAllowed": boolean, "membersAllowed": boolean, "assistantManagersAllowed": boolean } |
| Поля | |
|---|---|
managersAllowed | Необязательно. Указывает, имеют ли владельцы пространства ( |
membersAllowed | Необязательно. Указывает, имеют ли базовые участники пространства ( |
assistantManagersAllowed | Необязательно. Указывается, имеют ли менеджеры пространства |
Методы | |
|---|---|
| Завершает процесс импорта указанного пространства и делает его видимым для пользователей. |
| Создаёт пространство. |
| Удаляет именованное пространство. |
| Возвращает существующее личное сообщение с указанным пользователем. |
| Возвращает все пространства с spaceType == GROUP_CHAT , в которых в списке участников, состоящих из людей, содержится ровно тот же пользователь, который совершил звонок, и пользователи, указанные в FindGroupChatsRequest.users . |
| Возвращает подробную информацию о помещении. |
| Отображает список сообществ, участником которых является вызывающий абонент. |
| Обновляет пространство. |
| Возвращает список пространств в организации Google Workspace. |
| Создаёт пространство и добавляет в него указанных пользователей. |