Method: spaces.patch

Actualiza un espacio. Para ver un ejemplo, consulta Actualiza un espacio.

Si actualizas el campo displayName y recibes el mensaje de error ALREADY_EXISTS, prueba con otro nombre visible. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

Admite los siguientes tipos de autenticación:

  • Autenticación de la app con aprobación del administrador y uno de los siguientes permisos de autorización:

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

  • Autenticación de usuarios con uno de los siguientes permisos de autorización:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (solo espacios de modo de importación)
    • La autenticación de usuarios otorga privilegios de administrador cuando se autentica una cuenta de administrador, useAdminAccess es true y se usan los siguientes permisos de autorización:
      • https://www.googleapis.com/auth/chat.admin.spaces

La autenticación de la app tiene las siguientes limitaciones:

  • Para actualizar space.predefined_permission_settings o space.permission_settings, la app debe ser la creadora del espacio.
  • No se admite la actualización de space.access_settings.audience para la autenticación de apps.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
space.name

string

Identificador. Es el nombre del recurso del espacio.

Formato: spaces/{space}

Aquí, {space} representa el ID asignado por el sistema para el espacio. Puedes obtener el ID del espacio llamando al método spaces.list() o desde la URL del espacio. Por ejemplo, si la URL del espacio es https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, el ID del espacio es AAAAAAAAA.

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Es obligatorio. Son las rutas de acceso de los campos actualizados, separadas por comas si hay varias.

Puedes actualizar los siguientes campos de un espacio:

spaceDetails: Actualiza la descripción del espacio. Admite hasta 150 caracteres.

displayName: Solo admite la actualización del nombre visible para los espacios en los que el campo spaceType es SPACE. Si recibes el mensaje de error ALREADY_EXISTS, prueba con otro valor. Es posible que un espacio existente dentro de la organización de Google Workspace ya use este nombre visible.

spaceType: Solo admite el cambio de un tipo de espacio GROUP_CHAT a SPACE. Incluye displayName junto con spaceType en la máscara de actualización y asegúrate de que el espacio especificado tenga un nombre visible no vacío y el tipo de espacio SPACE. Incluir la máscara spaceType y el tipo SPACE en el espacio especificado cuando se actualiza el nombre visible es opcional si el espacio existente ya tiene el tipo SPACE. Si intentas actualizar el tipo de espacio de otras maneras, se producirá un error de argumento no válido. spaceType no es compatible con useAdminAccess.

spaceHistoryState: Actualiza la configuración del historial del espacio activando o desactivando el historial del espacio. Solo se admite si la organización de Google Workspace tiene habilitada la configuración del historial. Para actualizar el estado del historial del espacio, debes omitir todas las demás máscaras de campo en tu solicitud. spaceHistoryState no es compatible con useAdminAccess.

accessSettings.audience: Actualiza la configuración de acceso de quién puede descubrir el espacio, unirse a él y obtener una vista previa de los mensajes en el espacio con nombre donde el campo spaceType es SPACE. Si el espacio existente tiene un público objetivo, puedes quitarlo y restringir el acceso al espacio omitiendo un valor para esta máscara de campo. Para actualizar la configuración de acceso de un espacio, el usuario que se autentica debe ser administrador del espacio y omitir todas las demás máscaras de campo en su solicitud. No puedes actualizar este campo si el espacio está en modo de importación. Para obtener más información, consulta Cómo hacer que un espacio sea detectable para usuarios específicos. accessSettings.audience no es compatible con useAdminAccess.

permissionSettings: Admite el cambio de la configuración de permisos de un espacio. Cuando actualices la configuración de permisos, solo podrás especificar máscaras de campo permissionSettings. No podrás actualizar otras máscaras de campo al mismo tiempo. permissionSettings no es compatible con useAdminAccess. Las máscaras de campo admitidas incluyen las siguientes:

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

boolean

Opcional. Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que llama debe ser administrador de Google Workspace y tener el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.spaces.

Algunos valores de FieldMask no se admiten con acceso de administrador. Para obtener más información, consulta la descripción de updateMask.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Space.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Space.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta la Guía de autorización.