Method: spaces.patch

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

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

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

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

    • 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 Transcoding .

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

Параметры
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 : Обновляет описание пространства. Поддерживает до 150 символов.

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 .

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

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

boolean

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

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

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

Некоторые значения 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

Более подробную информацию см. в Руководстве по авторизации .