Modifier un espace

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 en modifier les attributs, tels que son nom à afficher visible par l'utilisateur, sa description et ses consignes.

La ressource Space représente un emplacement 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 au moins trois utilisateurs et des applications Chat.
  • Les espaces nommés sont des espaces persistants où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer.

Conditions préalables

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion de packages pip

  • Les dernières bibliothèques clientes Google pour Python. 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
  • Un projet Google Cloud dans lequel l'API Google Chat est activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La mise à jour d'un espace nécessite une authentification de l'utilisateur avec le champ d'application d'autorisation chat.spaces.

Node.js

  • Node.js et npm

  • Les dernières bibliothèques clientes Google pour Node.js. Pour les installer, exécutez la commande suivante dans votre interface de ligne de commande:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un projet Google Cloud dans lequel l'API Google Chat est activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. La mise à jour d'un espace nécessite une authentification de l'utilisateur avec le champ d'application d'autorisation chat.spaces.

Modifier un espace

Pour mettre à jour un espace existant dans Google Chat, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application de l'autorisation chat.spaces.
  • Appelez la méthode patch sur la ressource Space. Dans votre requête, vous spécifiez le champ d'espace name, le champ updateMask avec un ou plusieurs champs à mettre à jour et un body avec les informations d'espace mises à jour.

Vous pouvez modifier des éléments tels que le nom à afficher, le type d'espace, l'état de l'historique, etc. 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

  1. Dans votre répertoire de travail, créez un fichier nommé chat_space_update.py.

  2. 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()

  3. Dans le code, remplacez SPACE par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_space_update.py

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé update-space.js.

  2. 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);

  3. Dans le code, remplacez SPACE par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

  4. Dans votre répertoire de travail, exécutez l'exemple:

    node update-space.js

L'API Google Chat renvoie une instance de la ressource Space reflétant les mises à jour.