Gruppenbereich für Direktnachrichten (DN) suchen

In dieser Anleitung wird erläutert, wie Sie die findDirectMessage() Methode für die Space Ressource der Google Chat API verwenden, um Details zu einem Gruppenbereich für Direktnachrichten abzurufen.

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

  • Direktnachrichten sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und einer Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen mindestens drei 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, erstellt Google Chat eine Direktnachricht zwischen der installierten Chat-App und jedem Nutzer in der Organisation.

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

Vorbereitung

Node.js

Direktnachricht suchen

Wenn Sie eine Direktnachricht in Google Chat suchen möchten, geben Sie in Ihrer Anfrage Folgendes an:

  • Geben Sie bei der App-Authentifizierung den chat.bot Autorisierungsbereich an. Geben Sie bei der Nutzerauthentifizierung, den chat.spaces.readonly oder chat.spaces Autorisierungsbereich an.
  • Rufen Sie die FindDirectMessage(), Methode auf und übergeben Sie den name des anderen Nutzers in der Direktnachricht, die zurückgegeben werden soll. Bei der Nutzerauthentifizierung, gibt diese Methode eine Direktnachricht zwischen dem aufrufenden Nutzer und dem angegebenen Nutzer zurück. Bei der App-Authentifizierung gibt diese Methode eine Direktnachricht zwischen der aufrufenden App und dem angegebenen Nutzer zurück.
  • Wenn Sie einen menschlichen Nutzer als Mitglied eines Gruppenbereichs 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 eines user in der Directory API ist. Wenn beispielsweise der resourceName der Person in der People API people/123456789 ist, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie eine Mitgliedschaft mit users/123456789 als member.name einfügen.

Direktnachricht mit Nutzerauthentifizierung suchen

So suchen 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);
}

await main();

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, die Details zur angegebenen Direktnachricht enthält.

Direktnachricht mit App-Authentifizierung suchen

So suchen 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);
}

await main();

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, die Details zur angegebenen Direktnachricht enthält.