Modifier un espace

Ce guide explique comment utiliser la patch() méthode sur la ressource Space de l'API Google Chat pour mettre à jour un espace. Mettez à jour un espace pour modifier ses attributs, comme son nom à afficher visible par l'utilisateur, sa description et ses consignes.

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode patch() pour mettre à jour n'importe quel espace existant dans votre organisation Google Workspace.

La ressource Space représente un emplacement où les personnes 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 entre un utilisateur et une application Chat.
  • Les chats de groupe sont des conversations entre trois utilisateurs ou plus et des applications Chat.
  • Les espaces nommés sont des emplacements persistants où les utilisateurs envoient des messages, partagent des fichiers et collaborent.

Prérequis

Node.js

Python

Java

Apps Script

Mettre à jour un espace en tant qu'utilisateur

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

  • Spécifiez l'autorisation chat.spaces.
  • Appelez la UpdateSpace() méthode. Dans votre requête, spécifiez le champ name de l'espace, le champ updateMask avec un ou plusieurs champs à mettre à jour, et un body contenant les informations mises à jour de l'espace.

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 displayName d'un espace existant :

Node.js

chat/client-libraries/cloud/update-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces'];

// This sample shows how to update a space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    space: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name',
    },
    // The field paths to update. Separate multiple values with commas or use `*`
    // to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name'],
    },
  };

  // Make the request
  const response = await chatClient.updateSpace(request);

  // Handle the response
  console.log(response);
}

await main();

Python

chat/client-libraries/cloud/update_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

    # Make the request
    response = client.update_space(request)

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = "spaces/SPACE_NAME";
  const space = {
    displayName: "New space display name",
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = "displayName";

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask,
  });

  // Handle the response
  console.log(response);
}

Pour exécuter cet exemple, remplacez SPACE_NAME par l'ID du champ de l'espace.name Vous pouvez obtenir l'ID en appelant la ListSpaces() méthode ou à partir de l'URL de l'espace.

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

Mettre à jour un espace en tant qu'administrateur Google Workspace

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode UpdateSpace() pour mettre à jour n'importe quel espace de votre organisation Google Workspace.

Pour appeler cette méthode en tant qu'administrateur Google Workspace, procédez comme suit :

  • Appelez la méthode à l'aide de l'authentification de l'utilisateur et spécifiez une autorisation qui permet d'appeler la méthode avec des droits d'administrateur.
  • Dans votre requête, définissez le paramètre de requête useAdminAccess sur true.

Pour en savoir plus et obtenir des exemples, consultez Gérer les espaces Google Chat en tant qu'administrateur Google Workspace.

Mettre à jour un espace en tant qu'application Chat

L'authentification des applications nécessite une approbation unique de l'administrateur.

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

  • Spécifiez l'autorisation chat.app.spaces. Avec l'authentification des applications, vous ne pouvez mettre à jour que les espaces créés par les applications Chat.
  • Appelez la patch méthode sur la Space ressource. Dans votre requête, spécifiez le champ name de l'espace, le champ updateMask avec un ou plusieurs champs à mettre à jour, et un body contenant les informations mises à jour de l'espace.

Vous pouvez modifier des éléments tels que le nom à afficher, le type d'espace, l'état de l'historique, les paramètres d'autorisation, etc. Pour voir tous les champs que vous pouvez mettre à jour, consultez la documentation de référence.

Écrire un script qui appelle l'API Chat

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_app.py.

  2. Incluez le code suivant dans chat_space_update_app.py :

    from google.oauth2 import service_account
from apiclient.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.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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 les éléments suivants :

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

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

    python3 chat_space_update_app.py

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

Limites et points à noter