Details zum Lesestatus eines Nutzers abrufen

In diesem Leitfaden wird erläutert, wie Sie die Methode get() für die ThreadReadState-Ressource der Google Chat API verwenden, um Details zum Lesestatus eines Nutzers in einem Nachrichten-Thread abzurufen. Wie Sie den Lesestatus einer Nachricht in einem Gruppenbereich abrufen, erfahren Sie unter Details zum Lesestatus eines Nutzers in einem Gruppenbereich abrufen.

Die Ressource ThreadReadState ist eine Singleton-Ressource, die Details zur zuletzt gelesenen Nachricht eines bestimmten Nutzers in einem Google Chat-Nachrichten-Thread enthält.

Vorbereitung

Node.js

Lesestatus des Anrufers abrufen

Wenn Sie Details zum Lesestatus eines Nutzers in einem Nachrichten-Thread abrufen möchten, geben Sie Folgendes in Ihre Anfrage ein:

  • Geben Sie den chat.users.readstate- oder chat.users.readstate.readonly-Autorisierungsbereich an.
  • Rufen Sie die Methode GetThreadReadState() auf und übergeben Sie die name des Threads, dessen Lesestatus abgerufen werden soll. Diese enthält eine Nutzer-ID oder einen Alias und eine Gruppen-ID. Beim Abrufen des Lesestatus eines Threads wird nur der Lesestatus des anrufenden Nutzers unterstützt. Dieser kann durch Festlegen einer der folgenden Optionen angegeben werden:
    • Der Alias für me. Beispiel: users/me/spaces/SPACE/threads/THREAD/threadReadState
    • Die Workspace-E-Mail-Adresse des anrufenden Nutzers. Beispiel: users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState
    • Die Nutzer-ID des anrufenden Nutzers. Beispiel: users/USER/spaces/SPACE/threads/THREAD/threadReadState

Im folgenden Beispiel wird der Lesestatus des Threads des anrufenden Nutzers abgerufen:

Node.js

chat/client-libraries/cloud/get-thread-read-state-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to get the thread read state for a space and calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and THREAD_NAME here
    name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'
  };

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

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

main().catch(console.error);

Ersetzen Sie zum Ausführen dieses Beispiels Folgendes:

  • SPACE_NAME: die ID aus dem name des Gruppenbereichs. Sie können die ID durch Aufrufen der Methode ListSpaces() oder aus der URL des Gruppenbereichs abrufen.
  • THREAD_NAME: die ID aus dem name des Threads. Sie können die ID aus dem Antworttext abrufen, der zurückgegeben wird, nachdem eine Nachricht asynchron mit der Chat API erstellt wurde, oder mit dem benutzerdefinierten Namen, der der Nachricht beim Erstellen zugewiesen wurde.

Die Google Chat API ruft den angegebenen Lesestatus des Threads ab und gibt eine Instanz von ThreadReadState zurück.