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. Un espace existant dans l'organisation Google Workspace utilise peut-être déjà ce nom à afficher.

Nécessite une authentification de l'utilisateur.

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

Nom de ressource de l'espace.

Format : spaces/{space}

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

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

Vous pouvez modifier les champs suivants pour un espace:

  • spaceDetails

  • displayName: ne permet de mettre à jour le nom à afficher que pour les espaces où le champ spaceType est SPACE. Si le message d'erreur ALREADY_EXISTS s'affiche, essayez une autre valeur. Un espace existant dans l'organisation Google Workspace utilise peut-être 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é a un nom à afficher 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à du type SPACE. Toute tentative de modification du type d'espace entraîne une erreur d'argument non valide. spaceType n'est pas compatible avec l'accès administrateur.

  • spaceHistoryState: active ou désactive l'historique de l'espace pour mettre à jour les paramètres de l'historique des espaces. Disponible uniquement si les paramètres d'historique sont activés pour l'organisation Google Workspace. Pour mettre à jour l'état de l'historique des espaces, vous devez omettre tous les autres masques de champ dans votre requête. spaceHistoryState n'est pas compatible avec l'accès administrateur.

  • accessSettings.audience: met à jour le paramètre d'accès permettant de 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 a une audience cible, vous pouvez supprimer cette audience et limiter l'accès à l'espace en omettant une valeur pour ce masque de champ. Pour modifier les paramètres d'accès à un espace, l'utilisateur authentifié doit être gestionnaire de l'espace et omettre tous les autres masques de champ dans votre 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 par des utilisateurs spécifiques. accessSettings.audience n'est pas compatible avec l'accès administrateur.

  • Preview développeur: permet de modifier les paramètres d'autorisation d'un espace. Les chemins d'accès de champs compatibles incluent: permissionSettings.manage_members_and_groups, permissionSettings.modify_space_details, permissionSettings.toggle_history, permissionSettings.use_at_mention_all, permissionSettings.manage_apps, permissionSettings.manage_webhooks, permissionSettings.reply_messages (Avertissement: mutuellement exclusifs avec tous les chemins d'accès des champs des paramètres sans autorisation). permissionSettings n'est pas compatible avec l'accès administrateur.
useAdminAccess

boolean

Lorsque la valeur est true, la méthode s'exécute avec les droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de 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.

Champs d'application des autorisations

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

  • 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 relatif aux autorisations.