Ce guide explique comment utiliser la méthode patch
sur la ressource Space
de
l'API Google Chat pour mettre à jour un espace. Mettez à jour un espace pour modifier les attributs d'une
(nom à afficher, description et consignes visibles par les utilisateurs).
La
Ressource Space
représente un endroit où les utilisateurs et les applications Chat peuvent envoyer des messages,
partager des fichiers et collaborer. Il existe plusieurs types d'espaces:
- Les messages privés (MP) sont des conversations entre deux utilisateurs ou un utilisateur et une application Chat.
- Les chats de groupe sont des conversations entre trois utilisateurs ou plus et Applications de chat
- Les espaces nommés sont des espaces permanents où les utilisateurs envoient des messages, partagent des fichiers et collaborer.
Prérequis
Python
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Python 3.6 ou version ultérieure
- L'outil de gestion de packages pip
- Les dernières bibliothèques clientes Google Pour les installer
ou les mettre à jour,
exécutez la commande suivante dans votre interface de ligne de commande:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Configurez votre environnement:
<ph type="x-smartling-placeholder">
- </ph>
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
- <ph type="x-smartling-placeholder"></ph>
Créez des identifiants client OAuth pour une application de bureau. Pour exécuter l'exemple
, enregistrez les identifiants dans un fichier JSON (
client_secrets.json
) dans votre dans votre répertoire local.
- <ph type="x-smartling-placeholder"></ph> Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Node.js
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Node.js 14 ou version ultérieure
- La commande npm outil de gestion des paquets
- Les dernières bibliothèques clientes Google Pour les installer
ou les mettre à jour,
exécutez la commande suivante dans votre interface de ligne de commande:
npm install @google-cloud/local-auth @googleapis/chat
- Configurez votre environnement:
<ph type="x-smartling-placeholder">
- </ph>
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
- <ph type="x-smartling-placeholder"></ph>
Créez des identifiants client OAuth pour une application de bureau. Pour exécuter l'exemple
, enregistrez les identifiants dans un fichier JSON (
client_secrets.json
) dans votre dans votre répertoire local.
- <ph type="x-smartling-placeholder"></ph> Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Modifier un espace
Pour mettre à jour un espace existant dans Google Chat, transmettez ce qui suit : dans votre demande:
- Spécifiez le champ d'application de l'autorisation
chat.spaces
. - Appelez la méthode
Méthode
patch
sur la ressourceSpace
. Dans votre requête, vous spécifiez le champname
de l'espace, leupdateMask
avec un ou plusieurs champs à mettre à jour, et unbody
avec les informations mises à jour sur l'espace.
Vous pouvez modifier des éléments tels que le nom à afficher, le type d'espace, l'état de l'historique et plus encore. Pour voir tous les champs que vous pouvez mettre à jour, consultez la documentation de référence.
Voici comment mettre à jour le champ spaceDetails
d'un espace existant:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_space_update.py
. Ajoutez le code suivant dans
chat_space_update.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.spaces"] def main(): ''' Authenticates with Chat API via user credentials, then updates the specified space description and guidelines. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
Dans le code, remplacez
SPACE
par un nom d'espace, ce qui que vous pouvez obtenir Méthodespaces.list
dans l'API Chat ou via l'URL d'un espace.Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_space_update.py
Node.js
- Dans votre répertoire de travail, créez un fichier nommé
update-space.js
. Ajoutez le code suivant dans
update-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a Chat space with the description and guidelines. * @return {!Promise<!Object>} */ async function updateSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.patch({ name: 'spaces/SPACE', updateMask: 'spaceDetails', requestBody: { spaceDetails: { description: 'This description was updated with Chat API!', guidelines: 'These guidelines were updated with Chat API!' }, } }); } updateSpace().then(console.log);
Dans le code, remplacez
SPACE
par un nom d'espace, ce qui que vous pouvez obtenir Méthodespaces.list
dans l'API Chat ou via l'URL d'un espace.Dans votre répertoire de travail, exécutez l'exemple:
node update-space.js
L'API Google Chat renvoie une instance de la classe
Ressource Space
reflétant les mises à jour.
Articles associés
- En savoir plus sur un espace
- Répertorier les espaces
- Supprimer un espace
- Configurer un espace
- Recherchez un espace de messagerie privée.
- Rendre un espace visible par des utilisateurs spécifiques