Gruppenbereich für Direktnachrichten (DN) suchen

In diesem Leitfaden wird beschrieben, wie Sie die Methode findDirectMessage() für die Ressource Space der Google Chat API verwenden, um Details zu einem Gruppenbereich für Direktnachrichten abzurufen.

Die Space-Ressource stellt einen Ort dar, an dem Personen und Chat-Apps Nachrichten senden, Dateien teilen und zusammenarbeiten können. Es gibt verschiedene Arten von Bereichen:

  • Direktnachrichten (DNs) sind Unterhaltungen zwischen zwei Nutzern oder zwischen einem Nutzer und einer Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps.
  • Benannte Gruppenbereiche sind dauerhafte Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.

Wenn ein Google Workspace-Administrator eine Chat-App für die gesamte Google Workspace-Organisation installiert, wird in Google Chat eine Direktnachricht zwischen der installierten Chat-App und jedem Nutzer in der Organisation erstellt.

Bei der Authentifizierung mit der App-Authentifizierung kann eine Chat-App Direktnachrichten abrufen, auf die sie in Google Chat Zugriff hat, z. B. Direktnachrichten, in denen sie Mitglied ist. Bei der Authentifizierung mit der Nutzerauthentifizierung werden Direktnachrichten zurückgegeben, auf die der authentifizierte Nutzer Zugriff hat.

Vorbereitung

Node.js

Direktnachrichten suchen

Wenn Sie eine Direktnachricht in Google Chat finden möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie bei der App-Authentifizierung den Autorisierungsbereich chat.bot an. Geben Sie bei der Nutzerauthentifizierung den Autorisierungsbereich chat.spaces.readonly oder chat.spaces an.
  • Rufen Sie die Methode FindDirectMessage() auf und übergeben Sie die name des anderen Nutzers in der Direktnachricht, die zurückgegeben werden soll. Bei der Nutzerauthentifizierung wird mit dieser Methode eine Direktnachricht zwischen dem aufrufenden und dem angegebenen Nutzer zurückgegeben. Bei der App-Authentifizierung wird mit dieser Methode eine Direktnachricht zwischen der aufrufenden App und dem angegebenen Nutzer zurückgegeben.
  • Wenn Sie einen menschlichen Nutzer als Space-Mitglied hinzufügen möchten, geben Sie users/{user} an, wobei {user} entweder die {person_id} für die person aus der People API oder die ID einer user in der Directory API ist. Wenn die Person resourceName in der People API beispielsweise people/123456789 ist, können Sie den Nutzer dem Bereich hinzufügen, indem Sie eine Mitgliedschaft mit users/123456789 als member.name einfügen.

Direktnachricht mit Nutzerauthentifizierung finden

So finden Sie eine Direktnachricht mit Nutzerauthentifizierung:

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

Ersetzen Sie USER_NAME durch die ID aus dem Feld name des Nutzers, um dieses Beispiel auszuführen.

Die Chat API gibt eine Instanz von Space zurück, in der die angegebene Direktnachricht beschrieben wird.

Direktnachricht mit App-Authentifizierung finden

So finden Sie eine Direktnachricht mit App-Authentifizierung:

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

Ersetzen Sie USER_NAME durch die ID aus dem Feld name des Nutzers, um dieses Beispiel auszuführen.

Die Chat API gibt eine Instanz von Space zurück, in der die angegebene Direktnachricht beschrieben wird.