取得使用者和 #39 執行緒讀取狀態的詳細資料

本指南說明如何在 Google Chat API 的 ThreadReadState 資源上使用 get() 方法，取得訊息串內使用者的讀取狀態詳細資料。如要取得聊天室中訊息的已讀狀態，請參閱「取得使用者聊天室已讀狀態的詳細資料」。

ThreadReadState 資源是單例資源，可代表 Google Chat 訊息會話串中指定使用者最後讀取的訊息詳細資料。

必要條件

Node.js

取得呼叫使用者的執行緒讀取狀態

如要取得使用者訊息執行緒內讀取狀態的詳細資料，請在要求中加入以下內容：

  • 指定 chat.users.readstate 或 chat.users.readstate.readonly 授權範圍。
  • 呼叫 GetThreadReadState() 方法，傳遞執行緒讀取狀態的 name，以取得包含使用者 ID 或別名和空間 ID 的資料。取得執行緒讀取狀態僅支援取得呼叫使用者的讀取狀態，您可以設定下列其中一個項目來指定此狀態：
    • me 別名。例如 users/me/spaces/SPACE/threads/THREAD/threadReadState。
    • 撥打電話的使用者 Workspace 電子郵件地址。例如 users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState。
    • 發出呼叫的使用者 ID。例如 users/USER/spaces/SPACE/threads/THREAD/threadReadState。

以下範例會取得發出呼叫的使用者執行緒讀取狀態：

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

如要執行這個範例，請替換下列內容：

  • SPACE_NAME：聊天室 name 的 ID。您可以呼叫 ListSpaces() 方法或聊天室網址來取得 ID。
  • THREAD_NAME：執行緒 name 中的 ID。您可以使用 Chat API 以非同步方式建立訊息，或在建立訊息時指派自訂名稱，然後從回應主體中取得 ID。

Google Chat API 會取得指定執行緒讀取狀態，並傳回 ThreadReadState 的執行個體。