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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  }
}
Поля
name

string

Имя ресурса пространства.

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

type
(deprecated)

enum ( Type )

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

spaceType

enum ( SpaceType )

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

singleUserBotDm

boolean

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

threaded
(deprecated)

boolean

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

displayName

string

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

Для прямых сообщений это поле может быть пустым.

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

externalUserAllowed

boolean

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

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

  • Это пространство используется для импорта данных в Google Chat . В пространствах с режимом импорта должны быть разрешены только участники из одной организации Google Workspace.

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

spaceThreadingState

enum ( SpaceThreadingState )

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

spaceDetails

object ( SpaceDetails )

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

spaceHistoryState

enum ( HistoryState )

Состояние истории сообщений и потоков в этом пространстве.

importMode

boolean

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

createTime

string ( Timestamp format)

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

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

Заполняется в выходных данных только в том случае, если spaceType имеет GROUP_CHAT или SPACE .

adminInstalled

boolean

Только вывод. Установлено ли приложение Chat администратором Google Workspace. Администраторы могут установить приложение Chat для своего домена, организационного подразделения или группы пользователей.

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

accessSettings

object ( AccessSettings )

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

Тип

Устарело: вместо этого используйте 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

string

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

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

guidelines

string

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

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

Состояние истории

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

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

Доступ к настройкам

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

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

enum ( AccessState )

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

audience

string

Необязательный. Имя ресурса целевой аудитории , которая может получить доступ к пространству. Задайте в этом поле действительный идентификатор целевой аудитории, чтобы сделать пространство доступным для обнаружения, или используйте псевдоним audiences/default , чтобы задать для пространства настройку доступа по умолчанию в консоли администратора. Дополнительные сведения см. в разделе «Как сделать пространство доступным для обнаружения целевой аудиторией» . Снимите это поле, чтобы ограничить пространство. Заполняется только тогда, когда пространство доступно для обнаружения. Формат: audiences/{audience} , audiences/default можно использовать в качестве псевдонима настройки общего доступа к чату по умолчанию.

Аксессстате

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

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

Методы

completeImport

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

create

Создает именованное пространство.

delete

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

findDirectMessage

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

get

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

list

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

patch

Обновляет пространство.

setup

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