取得使用者和 #39 的聊天室讀取狀態詳細資料

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

SpaceReadState 資源是單例模式資源，代表特定使用者在 Google Chat 聊天室中上次讀取訊息的詳細資料。

必要條件

Node.js

• 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
  • 安裝 Node.js Cloud 用戶端程式庫。
  • 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要執行本指南中的範例，請將憑證以 client_secrets.json 格式儲存到本機目錄。
  如需相關指引，請完成這個快速入門中的環境設定步驟。
• 選擇支援使用者驗證的授權範圍。

本頁中的程式碼範例使用 gRPC API 介面與 Google Cloud 用戶端程式庫。或者，您也可以使用 REST API 介面。如要進一步瞭解 gRPC 和 REST 介面，請參閱 Google Chat API 總覽。

取得發出呼叫的使用者聊天室讀取狀態

如要取得使用者在聊天室中的讀取狀態詳細資料，請在要求中加入以下內容：

• 指定 chat.users.readstate 或 chat.users.readstate.readonly 授權範圍。
• 呼叫 GetSpaceReadState() 方法，傳遞空間讀取狀態的 name，以取得包含使用者 ID 或別名和空間 ID 的資料。取得空間讀取狀態僅支援取得呼叫者的讀取狀態，可透過設定下列其中一種方式指定：
  • me 別名。例如 users/me/spaces/SPACE/spaceReadState。
  • 撥打電話的使用者 Workspace 電子郵件地址。例如 users/[e-mail]/spaces/SPACE/spaceReadState。
  • 呼叫使用者的使用者 ID。例如 users/USER/spaces/SPACE/spaceReadState。

以下範例會取得呼叫使用者的聊天室讀取狀態：

Node.js

chat/client-libraries/cloud/get-space-read-state-user-cred.js

前往 GitHub 查看

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 space read state for the 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 here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState'
  };

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

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

main().catch(console.error);

如要執行這個範例，請將 SPACE_NAME 替換為空間 name 中的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。

Google Chat API 會取得指定的聊天室讀取狀態，並傳回 SpaceReadState 的例項。

相關主題

• 更新呼叫使用者的空間讀取狀態。
• 取得呼叫使用者的執行緒讀取狀態。