Method: spaces.patch

Обновляет пространство. Пример см. в разделе «Обновление пространства» .

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

Поддерживаются следующие типы аутентификации :

  • Аутентификация приложения с подтверждением администратора и одной из следующих областей авторизации:

    • https://www.googleapis.com/auth/chat.app.spaces

  • Аутентификация пользователя с использованием одной из следующих областей авторизации:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (только для пробелов в режиме импорта)
    • Аутентификация пользователя предоставляет права администратора, когда учетная запись администратора проходит аутентификацию, useAdminAccess имеет true , и используются следующие области авторизации:
      • https://www.googleapis.com/auth/chat.admin.spaces

Аутентификация приложений имеет следующие ограничения:

  • Для обновления параметров space.predefined_permission_settings или space.permission_settings приложение должно быть создателем пространства.
  • Обновление параметра space.access_settings.audience для аутентификации приложений не поддерживается.

HTTP-запрос

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
space.name

string

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

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

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

Параметры запроса

Параметры
updateMask

string ( FieldMask format)

Обязательно. Обновленные пути к полям, разделенные запятыми, если их несколько.

Для пространства можно обновить следующие поля:

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

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

spaceType : Поддерживается только изменение типа пространства GROUP_CHAT на SPACE . Включите displayName вместе с spaceType в маску обновления и убедитесь, что указанное пространство имеет непустое отображаемое имя и тип пространства SPACE . Включение маски spaceType и типа SPACE в указанное пространство при обновлении отображаемого имени является необязательным, если существующее пространство уже имеет тип SPACE . Попытка обновить тип пространства другими способами приведет к ошибке «недопустимый аргумент». spaceType не поддерживается с useAdminAccess .

spaceHistoryState : Обновляет настройки истории пространства , включая или выключая историю для этого пространства. Поддерживается только в том случае, если настройки истории включены для организации Google Workspace. Для обновления состояния истории пространства необходимо опустить все остальные маски полей в вашем запросе. spaceHistoryState не поддерживается с useAdminAccess .

accessSettings.audience : Обновляет параметры доступа , определяющие, кто может обнаруживать пространство, присоединяться к нему и просматривать сообщения в именованном пространстве, где поле spaceType имеет SPACE . Если у существующего пространства есть целевая аудитория, вы можете удалить аудиторию и ограничить доступ к пространству, опустив значение для этой маски поля. Чтобы обновить параметры доступа для пространства, пользователь, выполняющий аутентификацию, должен быть менеджером пространства, и в вашем запросе должны быть опущены все остальные маски полей. Вы не можете обновить это поле, если пространство находится в режиме импорта . Для получения дополнительной информации см. раздел «Как сделать пространство доступным для определенных пользователей ». accessSettings.audience не поддерживается с useAdminAccess .

accessSettings.access_permission_settings : Обновляет настройки прав доступа, определяющие, кто может обнаруживать и присоединяться к пространству, если поле spaceType имеет значение SPACE . Субъекты, которым разрешено присоединяться к пространству, также должны иметь право его обнаруживать. Для обновления настроек прав доступа к пространству пользователь, выполняющий аутентификацию, должен быть менеджером пространства или помощником менеджера и не должен указывать все остальные маски полей в запросе. Вы не можете обновить это поле, если пространство находится в режиме импорта . Для получения дополнительной информации см. раздел «Как сделать пространство доступным для обнаружения определенным пользователям ». accessSettings.access_permission_settings не поддерживается с useAdminAccess . Поддерживаемые маски полей включают:

  • accessSettings.access_permission_settings.discoverSpaceSetting
  • accessSettings.access_permission_settings.joinSpaceSetting

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

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

Необязательный параметр. Если true , метод выполняется с использованием прав администратора Google Workspace пользователя.

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

Требуется область действия OAuth 2.0 chat.admin.spaces .

Некоторые значения FieldMask не поддерживаются при наличии административного доступа. Подробности см. в описании параметра updateMask .

Текст запроса

Тело запроса содержит экземпляр объекта Space .

Ответный текст

В случае успеха тело ответа содержит экземпляр объекта Space .

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

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