REST Resource: spaces

{
  "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,
  "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.
}

string

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

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

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

enum ( Type )

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

enum ( SpaceType )

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

boolean

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

boolean

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

string

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

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

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

boolean

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

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

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

enum ( SpaceThreadingState )

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

object ( SpaceDetails )

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

enum ( HistoryState )

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

boolean

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

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

string ( Timestamp format)

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

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

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

string ( Timestamp format)

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

boolean

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

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

object ( MembershipCount )

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

object ( AccessSettings )

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

string

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

string

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

В формате customers/{customer} , где customer — это id из [ресурс клиента Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) . Частные приложения также могут использовать псевдоним customers/my_customer для создания пространства в той же организации Google Workspace, что и приложение.

Для личных сообщений это поле не заполняется.

enum ( PredefinedPermissionSettings )

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

object ( PermissionSettings )

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

{
  "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,
  "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.
}

string

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

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

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

enum ( Type )

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

enum ( SpaceType )

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

boolean

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

boolean

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

string

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

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

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

boolean

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

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

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

enum ( SpaceThreadingState )

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

object ( SpaceDetails )

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

enum ( HistoryState )

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

boolean

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

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

string ( Timestamp format)

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

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

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

string ( Timestamp format)

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

boolean

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

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

object ( MembershipCount )

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

object ( AccessSettings )

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

string

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

string

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

В формате customers/{customer} , где customer — это id из [ресурс клиента Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) . Частные приложения также могут использовать псевдоним customers/my_customer для создания пространства в той же организации Google Workspace, что и приложение.

Для личных сообщений это поле не заполняется.

enum ( PredefinedPermissionSettings )

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

object ( PermissionSettings )

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