Method: spaces.patch

Met à jour un espace. Pour obtenir un exemple, consultez Mettre à jour un espace.

Si vous mettez à jour le champ displayName et que vous recevez le message d'erreur ALREADY_EXISTS, essayez un autre nom à afficher. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

Prend en charge les types d'authentification suivants :

  • Authentification de l'application avec l'approbation de l'administrateur et l'un des niveaux d'accès des autorisations suivants :

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

  • Authentification de l'utilisateur avec l'un des niveaux d'accès des autorisations suivants :

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (espaces en mode importation uniquement)
    • L'authentification de l'utilisateur accorde des droits d'administrateur lorsqu'un compte administrateur s'authentifie, que useAdminAccess est défini sur true et que le niveau d'accès des autorisations suivant est utilisé :
      • https://www.googleapis.com/auth/chat.admin.spaces

L'authentification de l'application est soumise aux limites suivantes :

  • Pour mettre à jour space.predefined_permission_settings ou space.permission_settings, l'application doit être le créateur de l'espace.
  • La mise à jour de space.access_settings.audience n'est pas compatible avec l'authentification de l'application.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
space.name

string

Identifiant. Nom de la ressource de l'espace.

Format: spaces/{space}

Où {space} représente l'ID attribué par le système à l'espace. Vous pouvez obtenir l'ID de l'espace en appelant la spaces.list() méthode ou à partir de l'URL de l'espace. Par exemple, si l'URL de l'espace est https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, l'ID de l'espace est AAAAAAAAA.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Obligatoire. Chemins d'accès des champs mis à jour, séparés par une virgule s'il y en a plusieurs.

Vous pouvez mettre à jour les champs suivants pour un espace :

spaceDetails : met à jour la description et les consignes de l'espace. Vous devez transmettre la description et les consignes dans la requête de mise à jour en tant que SpaceDetails. Si vous ne souhaitez mettre à jour qu'un seul des champs, transmettez la valeur existante pour l'autre champ.

displayName : ne permet de mettre à jour le nom à afficher que pour les espaces dont le champ spaceType est SPACE. Si vous recevez le message d'erreur ALREADY_EXISTS, essayez une autre valeur. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

spaceType : ne permet de modifier un type d'espace GROUP_CHAT que pour le remplacer par SPACE. Incluez displayName avec spaceType dans le masque de mise à jour et assurez-vous que l'espace spécifié comporte un nom à afficher non vide et le type d'espace SPACE. L'inclusion du masque spaceType et du type SPACE dans l'espace spécifié lors de la mise à jour du nom à afficher est facultative si l'espace existant est déjà de type SPACE. Toute autre tentative de mise à jour du type d'espace génère une erreur d'argument non valide. spaceType n'est pas compatible avec useAdminAccess.

spaceHistoryState : met à jour les paramètres d'historique de l'espace en activant ou en désactivant l'historique de l'espace. N'est compatible que si les paramètres d'historique sont activés pour l'organisation Google Workspace. Pour mettre à jour l'état de l'historique de l'espace, vous devez omettre tous les autres masques de champ dans votre requête. spaceHistoryState n'est pas compatible avec useAdminAccess.

accessSettings.audience : met à jour le paramètre d'accès des personnes autorisées à découvrir l'espace, à le rejoindre et à prévisualiser les messages dans l'espace nommé où le champ spaceType est SPACE. Si l'espace existant comporte une audience cible, vous pouvez la supprimer et limiter l'accès à l'espace en omettant une valeur pour ce masque de champ. Pour mettre à jour les paramètres d'accès d'un espace, l'utilisateur qui s'authentifie doit être un gestionnaire d'espace et omettre tous les autres masques de champ dans sa requête. Vous ne pouvez pas mettre à jour ce champ si l'espace est en mode importation. Pour en savoir plus, consultez Rendre un espace détectable par des utilisateurs spécifiques. accessSettings.audience n'est pas compatible avec useAdminAccess.

accessSettings.access_permission_settings : met à jour les paramètres d'autorisation d'accès des personnes autorisées à découvrir et à rejoindre l'espace où le champ spaceType est SPACE. Les comptes principaux autorisés à rejoindre l'espace doivent également être autorisés à le découvrir. Pour mettre à jour les paramètres d'autorisation d'accès d'un espace, l'utilisateur qui s'authentifie doit être un gestionnaire d'espace ou un gestionnaire adjoint et omettre tous les autres masques de champ dans la requête. Vous ne pouvez pas mettre à jour ce champ si l'espace est en mode importation. Pour en savoir plus, consultez Rendre un espace détectable par des utilisateurs spécifiques. accessSettings.access_permission_settings n'est pas compatible avec useAdminAccess. Les masques de champ compatibles incluent les suivants :

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

permissionSettings : permet de modifier les paramètres d'autorisation d'un espace. Lorsque vous mettez à jour les paramètres d'autorisation, vous ne pouvez spécifier que des masques de champ permissionSettings. Vous ne pouvez pas mettre à jour d'autres masques de champ en même temps. Les masques de champ compatibles incluent les suivants :

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

boolean

Facultatif. Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit "Gérer les conversations Chat et Espaces".

Nécessite le chat.admin.spaces niveau d'accès OAuth 2.0.

Certaines valeurs FieldMask ne sont pas compatibles avec l'accès administrateur. Pour en savoir plus, consultez la description de updateMask.

Corps de la requête

Le corps de la requête contient une instance de Space.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Space.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le guide sur l'autorisation.