Details zum Lesestatus eines Nutzers abrufen

In diesem Leitfaden wird beschrieben, wie Sie die Methode get() für die Ressource ThreadReadState der Google Chat API verwenden, um Details zum Lesestatus eines Nutzers in einem Nachrichtenverlauf abzurufen. Informationen zum Abrufen des Lesestatus einer Nachricht in einem Projektbereich finden Sie unter Details zum Lesestatus eines Nutzers in einem Projektbereich abrufen.

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

Vorbereitung

Node.js

Lesestatus des Threads des anrufenden Nutzers abrufen

Wenn Sie Details zum Lesestatus eines Nutzers in einem Nachrichtenverlauf abrufen möchten, fügen Sie Ihrer Anfrage Folgendes hinzu:

  • Geben Sie den Autorisierungsbereich chat.users.readstate oder chat.users.readstate.readonly an.
  • Rufen Sie die Methode GetThreadReadState() auf und übergeben Sie die name des Thread-Lesestatus, die eine Nutzer-ID oder einen Alias und eine Bereichs-ID enthält. Das Abrufen des Lesestatus von Threads unterstützt nur das Abrufen des Lesestatus des aufrufenden Nutzers, der durch Festlegen einer der folgenden Optionen angegeben werden kann:
    • Der Alias me. Beispiel: users/me/spaces/SPACE/threads/THREAD/threadReadState
    • Die Google Workspace-E-Mail-Adresse des anrufenden Nutzers. Beispiel: users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState
    • Die Nutzer-ID des aufrufenden Nutzers. Beispiel: users/USER/spaces/SPACE/threads/THREAD/threadReadState

Im folgenden Beispiel wird der Lesestatus des Threads des aufrufenden 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);

Wenn Sie dieses Beispiel ausführen möchten, ersetzen Sie Folgendes:

  • SPACE_NAME: Die ID aus dem name des Bereichs. Sie können die ID abrufen, indem Sie die Methode ListSpaces() aufrufen oder die URL des Bereichs verwenden.
  • THREAD_NAME: die ID aus dem name des Threads. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API oder mit dem benutzerdefinierten Namen zurückgegeben wird, der der Nachricht bei der Erstellung zugewiesen wurde.

Die Google Chat API ruft den angegebenen Status „Gelesen“ für den Thread ab und gibt eine Instanz von ThreadReadState zurück.