Obtenir des informations sur un espace

Ce guide explique comment utiliser la méthode get() sur une ressource Space de l'API Google Chat pour afficher les informations détaillées d'un espace, comme son nom à afficher, sa description et ses consignes.

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode get() pour récupérer des informations sur n'importe quel espace de votre organisation Google Workspace.

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 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 espaces persistants où les utilisateurs peuvent envoyer des messages, partager des fichiers et collaborer.

L'authentification avec l'authentification de l'application permet à une application Chat d'obtenir des informations sur un espace dont elle est membre. L'authentification avec l'authentification utilisateur vous permet d'obtenir les espaces auxquels l'utilisateur authentifié a accès, en tant que membre de l'espace ou administrateur Google Workspace.

Prérequis

Node.js

Python

Java

Apps Script

Obtenir un espace

Pour obtenir un espace dans Google Chat, transmettez les éléments suivants dans votre requête:

Obtenir les détails d'un espace en tant qu'utilisateur

Pour obtenir les détails de l'espace avec l'authentification des utilisateurs:

Node.js

chat/client-libraries/cloud/get-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];  // This sample shows how to get space with user credential async function main() {   // Create a client   const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);    // Initialize request argument(s)   const request = {     // Replace SPACE_NAME here     name: 'spaces/SPACE_NAME'   };    // Make the request   const response = await chatClient.getSpace(request);    // Handle the response   console.log(response); }  main().catch(console.error);

Python

chat/client-libraries/cloud/get_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.readonly"]  # This sample shows how to get space with user credential def get_space_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.GetSpaceRequest(         # Replace SPACE_NAME here         name = "spaces/SPACE_NAME",     )      # Make the request     response = client.get_space(request)      # Handle the response     print(response)  get_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.GetSpaceRequest; import com.google.chat.v1.Space;  // This sample shows how to get space with user credential. public class GetSpaceUserCred {    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.spaces.readonly";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()         // Replace SPACE_NAME here         .setName("spaces/SPACE_NAME");       Space response = chatServiceClient.getSpace(request.build());        System.out.println(JsonFormat.printer().print(response));     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to get space with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'  * referenced in the manifest file (appsscript.json).  */ function getSpaceUserCred() {   // Initialize request argument(s)   // TODO(developer): Replace SPACE_NAME here   const name = 'spaces/SPACE_NAME';    // Make the request   const response = Chat.Spaces.get(name);    // Handle the response   console.log(response); }

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

L'API Chat renvoie une instance de Space qui détaille l'espace spécifié.

Obtenir les détails d'un espace en tant qu'administrateur Google Workspace

Si vous êtes administrateur Google Workspace, vous pouvez appeler la méthode GetSpace pour récupérer des informations sur n'importe quel espace de votre organisation Google Workspace.

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

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

Obtenir les détails d'un espace en tant qu'application Chat

Pour obtenir des informations sur l'espace avec l'authentification de l'application:

Node.js

chat/client-libraries/cloud/get-space-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';  // This sample shows how to get space with app credential async function main() {   // Create a client   const chatClient = createClientWithAppCredentials();    // Initialize request argument(s)   const request = {     // Replace SPACE_NAME here     name: 'spaces/SPACE_NAME'   };    // Make the request   const response = await chatClient.getSpace(request);    // Handle the response   console.log(response); }  main().catch(console.error);

Python

chat/client-libraries/cloud/get_space_app_cred.py
from authentication_utils import create_client_with_app_credentials from google.apps import chat_v1 as google_chat  # This sample shows how to get space with app credential def get_space_with_app_cred():     # Create a client     client = create_client_with_app_credentials()      # Initialize request argument(s)     request = google_chat.GetSpaceRequest(         # Replace SPACE_NAME here         name = "spaces/SPACE_NAME",     )      # Make the request     response = client.get_space(request)      # Handle the response     print(response)  get_space_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceAppCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.GetSpaceRequest; import com.google.chat.v1.Space;  // This sample shows how to get space with app credential. public class GetSpaceAppCred {    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithAppCredentials()) {       GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()         // Replace SPACE_NAME here         .setName("spaces/SPACE_NAME");       Space response = chatServiceClient.getSpace(request.build());        System.out.println(JsonFormat.printer().print(response));     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to get space with app credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'  * used by service accounts.  */ function getSpaceAppCred() {   // Initialize request argument(s)   // TODO(developer): Replace SPACE_NAME here   const name = 'spaces/SPACE_NAME';   const parameters = {};    // Make the request   const response = Chat.Spaces.get(name, parameters, getHeaderWithAppCredentials());    // Handle the response   console.log(response); }

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

L'API Chat renvoie une instance de Space qui détaille l'espace spécifié.

Limites et points à noter