Rechercher un espace de message privé (MP)

Ce guide explique comment utiliser la méthode findDirectMessage() sur la ressource Space de l'API Google Chat pour obtenir des informations sur un espace de messages privés.

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.

Lorsqu'un administrateur Google Workspace installe une application Chat pour l'ensemble de son organisation Google Workspace, Google Chat crée une discussion privée entre l'application Chat installée et chaque utilisateur de l'organisation.

L'authentification avec l'authentification de l'application permet à une application Chat d'obtenir les MP auxquels elle a accès dans Google Chat (par exemple, les MP dont elle est membre). L'authentification avec l'authentification des utilisateurs renvoie les messages privés auxquels l'utilisateur authentifié a accès.

Prérequis

Node.js

Rechercher un message privé

Pour trouver un message privé dans Google Chat, transmettez les éléments suivants dans votre requête:

  • Avec l'authentification de l'application, spécifiez le champ d'application de l'autorisation chat.bot. Avec l'authentification des utilisateurs, spécifiez le champ d'autorisation chat.spaces.readonly ou chat.spaces.
  • Appelez la méthode FindDirectMessage() en transmettant le name de l'autre utilisateur dans le message privé à renvoyer. Avec l'authentification des utilisateurs, cette méthode renvoie un message privé entre l'utilisateur appelant et l'utilisateur spécifié. Avec l'authentification de l'application, cette méthode renvoie un message privé entre l'application appelante et l'utilisateur spécifié.
  • Pour ajouter un utilisateur en tant que membre d'un espace, spécifiez users/{user}, où {user} correspond à l'{person_id} de l'person de l'API People ou à l'ID d'un user dans l'API Directory. Par exemple, si la personne resourceName de l'API People est people/123456789, vous pouvez ajouter l'utilisateur à l'espace en incluant une adhésion avec users/123456789 comme member.name.

Rechercher un message privé avec authentification des utilisateurs

Pour trouver un message privé avec authentification des utilisateurs:

Node.js

chat/client-libraries/cloud/find-dm-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 find a Direct Message 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 USER_NAME here
    name: 'users/USER_NAME'
  };

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

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

main().catch(console.error);

Pour exécuter cet exemple, remplacez USER_NAME par l'ID du champ name de l'utilisateur.

L'API Chat renvoie une instance de Space qui détaille le message privé spécifié.

Rechercher un message privé avec l'authentification de l'application

Pour trouver un message privé avec l'authentification de l'application:

Node.js

chat/client-libraries/cloud/find-dm-space-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to find a Direct Message space with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace USER_NAME here
    name: 'users/USER_NAME'
  };

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

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

main().catch(console.error);

Pour exécuter cet exemple, remplacez USER_NAME par l'ID du champ name de l'utilisateur.

L'API Chat renvoie une instance de Space qui détaille le message privé spécifié.