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 le message d'erreur ALREADY_EXISTS s'affiche, essayez un autre nom à afficher. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise déjà ce nom à afficher.

Compatible avec les types d'authentification suivants :

  • Authentification de l'application avec l'approbation de l'administrateur et l'une des étendues d'autorisation suivantes :

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

  • Authentification de l'utilisateur avec l'un des niveaux d'autorisation 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 privilèges d'administrateur lorsqu'un compte d'administrateur s'authentifie, useAdminAccess est true et que les étendues d'autorisation suivantes sont utilisées :
      • https://www.googleapis.com/auth/chat.admin.spaces

L'authentification des applications présente les 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 acceptée pour l'authentification des applications.

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'identifiant attribué par le système à l'espace. Vous pouvez obtenir l'identifiant de l'espace en appelant la méthode spaces.list() 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. Les chemins d'accès aux champs mis à jour, séparés par des virgules s'il y en a plusieurs.

Vous pouvez modifier les champs suivants d'un espace :

spaceDetails: Met à jour la description et les directives de l'espace. Vous devez inclure à la fois la description et les directives dans la demande de mise à jour sous la forme SpaceDetails. Si vous ne souhaitez mettre à jour qu'un seul des champs, transmettez la valeur existante pour l'autre champ.

displayName : Prend uniquement en charge la mise à jour du nom d'affichage pour les espaces où le champ spaceType est SPACE. Si vous recevez le message d'erreur ALREADY_EXISTS, essayez une valeur différente. Il est possible qu'un espace existant dans l'organisation Google Workspace utilise 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é possède 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 modification du nom à afficher est facultative si l'espace existant possède déjà le type SPACE. Toute autre tentative de modification 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 de l'historique de l'espace en activant ou en désactivant l'historique de l'espace. N'est disponible 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 pour déterminer qui peut découvrir l'espace, le rejoindre et prévisualiser les messages dans l'espace nommé où le champ spaceType est défini sur 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 administrateur de l'espace et omettre tous les autres masques de champ dans sa demande. Vous ne pouvez pas modifier ce champ si l'espace est en mode importation. Pour en savoir plus, consultez Rendre un espace visible pour des utilisateurs spécifiques. accessSettings.audience n'est pas compatible avec useAdminAccess.

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. permissionSettings n'est pas compatible avec useAdminAccess. Voici les masques de champ acceptés :

  • 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 avec les droits d'administrateur Google Workspace de l'utilisateur.

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

Nécessite le champ d'application OAuth 2.0 chat.admin.spaces.

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 d'autorisation.