- Ресурс: Космос
- Методы
Ресурс: Космос
Место в Google Chat. Пространства — это разговоры между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.
JSON-представление |
---|
{ "name": string, "type": enum ( |
Поля | |
---|---|
name | Имя ресурса пространства. Формат: Где |
type | Только вывод. Устарело: вместо этого используйте |
spaceType | Тип помещения. Требуется при создании пространства или обновлении типа пространства. Вывод только для другого использования. |
singleUserBotDm | Необязательный. Является ли пространство личным сообщением между приложением чата и одним человеком. |
threaded | Только вывод. Устарело: вместо этого используйте |
displayName | Отображаемое имя пространства. Требуется при создании пространства с Для прямых сообщений это поле может быть пустым. Поддерживает до 128 символов. |
externalUserAllowed | Неизменяемый. Разрешается ли в этом пространстве любому пользователю Google Chat быть участником. Ввод при создании пространства в организации Google Workspace. Пропустите это поле при создании пространств в следующих условиях:
Для существующих пространств это поле предназначено только для вывода. |
spaceThreadingState | Только вывод. Состояние потока в пространстве чата. |
spaceDetails | Подробная информация о пространстве, включая описание и правила. |
spaceHistoryState | Состояние истории сообщений и потоков в этом пространстве. |
importMode | Необязательный. Создано ли это пространство в |
createTime | Необязательный. Неизменяемый. Для пространств, созданных в Chat, — время создания пространства. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания пространства в источнике, чтобы сохранить исходное время создания. Заполняется в выходных данных только в том случае, если |
lastActiveTime | Только вывод. Временная метка последнего сообщения в пространстве. |
adminInstalled | Только вывод. Для пространств прямого обмена сообщениями (DM) с приложением Chat: было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с помощью приложения Chat от имени пользователей в своей организации. Чтобы поддерживать установку администратора, ваше приложение Chat должно поддерживать прямой обмен сообщениями. |
membershipCount | Только вывод. Количество присоединившихся участников, сгруппированных по типу участников. Заполняется, когда |
accessSettings | Необязательный. Указывает настройки доступа к пространству. Заполняется только в том случае, если |
spaceUri | Только вывод. URI для доступа пользователя к пространству. |
Поле объединения space_permission_settings . Представляет настройки разрешений пространства. Заполняется только в том случае, если space_type равен SPACE . space_permission_settings может быть только одним из следующих: | |
predefinedPermissionSettings | Необязательный. Только ввод. Настройки разрешения пространства. Входные данные для создания пространства. Если это поле не задано, создается пространство для совместной работы. После создания пространства параметры заполняются в поле |
permissionSettings | Необязательный. Точные настройки разрешений, которые можно установить для обновления пространства. Вход для обновления пространства. В противном случае только вывод. Вместо этого для создания пространства используйте |
Тип
Устарело: вместо этого используйте SpaceType
.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Сдержанный. |
ROOM | Разговоры между двумя и более людьми. |
DM | 1:1 Прямое сообщение между человеком и приложением чата, где все сообщения однородны. Обратите внимание, что сюда не входят прямые сообщения между двумя людьми. |
Тип пространства
Тип помещения. Требуется при создании или обновлении пространства. Вывод только для другого использования.
Перечисления | |
---|---|
SPACE_TYPE_UNSPECIFIED | Сдержанный. |
SPACE | Место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. SPACE может включать в себя приложения чата. |
GROUP_CHAT | Групповые беседы между 3 и более людьми. GROUP_CHAT может включать приложения чата. |
DIRECT_MESSAGE | Сообщения 1:1 между двумя людьми или человеком и приложением чата. |
SpaceThreadingState
Указывает тип состояния потока в пространстве чата.
Перечисления | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED | Сдержанный. |
THREADED_MESSAGES | Именованные пространства, поддерживающие потоки сообщений. Когда пользователи отвечают на сообщение, они могут ответить в цепочке, что сохраняет их ответ в контексте исходного сообщения. |
GROUPED_MESSAGES | Именованные пространства, где беседа организована по темам. Темы и ответы на них сгруппированы вместе. |
UNTHREADED_MESSAGES | Прямые сообщения (DM) между двумя людьми и групповые беседы между 3 или более людьми. |
ПространствоДетали
Подробная информация о пространстве, включая описание и правила.
JSON-представление |
---|
{ "description": string, "guidelines": string } |
Поля | |
---|---|
description | Необязательный. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников пространства. Поддерживает до 150 символов. |
guidelines | Необязательный. Правила, ожидания и этикет этого места. Поддерживает до 5000 символов. |
Состояние истории
Состояние истории сообщений и пространств. Указывает, как долго сообщения и цепочки разговоров хранятся после создания.
Перечисления | |
---|---|
HISTORY_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
HISTORY_OFF | История отключена. Сообщения и темы хранятся 24 часа . |
HISTORY_ON | История включена. Правила хранения Сейфа организации определяют, как долго хранятся сообщения и цепочки. |
ЧленствоКаунт
Представляет количество участников пространства, сгруппированных по категориям.
JSON-представление |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Поля | |
---|---|
joinedDirectHumanUserCount | Количество пользователей-людей, которые напрямую присоединились к пространству, не считая пользователей, присоединившихся путем членства в присоединенной группе. |
joinedGroupCount | Подсчет всех групп, которые напрямую присоединились к пространству. |
Доступ к настройкам
Представляет настройки доступа к пространству.
JSON-представление |
---|
{
"accessState": enum ( |
Поля | |
---|---|
accessState | Только вывод. Указывает состояние доступа к пространству. |
audience | Необязательный. Имя ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к нему и просмотреть сообщения в пространстве. Если этот параметр не установлен, доступ к нему смогут получить только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробности см. в разделе «Как сделать пространство доступным для просмотра целевой аудиторией» . Формат: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите |
Аксессстате
Представляет состояние доступа к пространству.
Перечисления | |
---|---|
ACCESS_STATE_UNSPECIFIED | Состояние доступа неизвестно или не поддерживается в этом API. |
PRIVATE | Только пользователи или группы Google, которые были индивидуально добавлены или приглашены другими пользователями или администраторами Google Workspace, могут находить пространство и получать к нему доступ. |
DISCOVERABLE | Менеджер пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, которые были индивидуально добавлены или приглашены в пространство, также могут находить его и получать к нему доступ. Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям . |
Предопределенные параметры разрешений
Параметры разрешений пространства, которые можно указать при создании именованного пространства. В будущем могут быть добавлены дополнительные настройки. Подробные сведения о настройках разрешений для именованных пространств см. в разделе Дополнительные сведения о пространствах .
Перечисления | |
---|---|
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 } |
Поля | |
---|---|
managersAllowed | Есть ли у менеджеров пространств это разрешение. |
membersAllowed | Имеют ли участники, не являющиеся менеджерами, это разрешение. |
Методы | |
---|---|
| Завершает процесс импорта указанного пространства и делает его видимым для пользователей. |
| Создает пространство без участников. |
| Удаляет именованное пространство. |
| Возвращает существующее прямое сообщение указанному пользователю. |
| Возвращает подробную информацию о пространстве. |
| Перечисляет пространства, членом которых является вызывающий абонент. |
| Обновляет пространство. |
| Возвращает список пространств в организации Google Workspace на основе поиска администратора. |
| Создает пространство и добавляет в него указанных пользователей. |