Method: spaces.patch
Met à jour un espace. Pour obtenir un exemple, consultez Mettre à jour un espace.
Si vous modifiez 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 de l'organisation Google Workspace utilise déjà ce nom à afficher.
Compatible avec les types d'authentification suivants:
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 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 de champ mis à jour, séparés par une virgule s'il y en a plusieurs. Vous pouvez modifier les champs suivants d'un espace: spaceDetails : met à jour la description de l'espace. Peut contenir jusqu'à 150 caractères.
displayName : permet uniquement de modifier le nom à afficher pour les espaces où le champ spaceType est SPACE . Si le message d'erreur ALREADY_EXISTS s'affiche, essayez une autre valeur. Il est possible qu'un espace existant de l'organisation Google Workspace utilise déjà ce nom à afficher.
spaceType : permet uniquement de remplacer un type d'espace GROUP_CHAT 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 tentative de mise à jour du type d'espace par un autre moyen 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 pour l'espace. Cette fonctionnalité 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 des utilisateurs autorisés à 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 dispose d'une audience cible, vous pouvez la supprimer et limiter l'accès à l'espace en omisssant 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 la requête. 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 . Les masques de champ compatibles sont 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. Requiert 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
.
Champs d'application 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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/02/27 (UTC).
[null,null,["Dernière mise à jour le 2025/02/27 (UTC)."],[[["Updates a Google Chat space's details, including display name, description, space type, history settings, access settings, and permission settings."],["Requires specific authentication and authorization, including app authentication with administrator approval or user authentication, potentially with administrator privileges."],["Supports partial updates using the `updateMask` query parameter to specify the fields to be modified."],["Provides options for using administrator privileges with the `useAdminAccess` query parameter, but some fields and functionalities are not supported in this mode."],["Uses the PATCH HTTP method and gRPC Transcoding syntax for the request URL."]]],["This content describes how to update a space within Google Workspace Chat via the API. Key actions include sending a `PATCH` request to `https://chat.googleapis.com/v1/{space.name=spaces/*}`, specifying the space's name in the path. The `updateMask` query parameter defines which fields to update, including space details, display name, type, history state, access and permissions. `useAdminAccess` allow to update the space with administrator permissions. Authentication requires specific OAuth scopes. The request and response body use the `Space` object.\n"]]