更新使用者和#39 的聊天室讀取狀態

本指南將說明如何在 Google Chat API 的 SpaceReadState 資源上使用 update() 方法，將聊天室標示為已讀取或未讀取。

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

必要條件

Node.js

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

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

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

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

如要更新聊天室內使用者的已讀狀態，請在要求中加入以下內容：

• 指定 chat.users.readstate 授權範圍。
• 呼叫 UpdateSpaceReadState() 方法。
• 傳遞 updateMask 和 lastReadTime 值。
• 使用以下方法，將 spaceReadState 傳遞為 SpaceReadState 的例項：
  • name 欄位設為要更新的空間讀取狀態，其中包含使用者 ID 或別名和空間 ID。更新空間讀取狀態僅支援更新呼叫使用者的讀取狀態，您可以設定下列其中一個項目來指定此狀態：
    • me 別名。例如 users/me/spaces/SPACE/spaceReadState。
    • 撥打電話的使用者 Workspace 電子郵件地址。例如 users/[e-mail]/spaces/SPACE/spaceReadState。
    • 呼叫使用者的使用者 ID。例如 users/USER/spaces/SPACE/spaceReadState。
  • lastReadTime 欄位會設為使用者空間讀取狀態更新時更新的值。通常會對應至上次讀取訊息的時間戳記，或是使用者指定的時間戳記，用於標示聊天室中的最後讀取位置。如果 lastReadTime 早於最新訊息建立時間，聊天室就會在 UI 中顯示為未讀。如要將聊天室標示為已讀，請將 lastReadTime 設為大於 (晚於) 最新訊息建立時間的任何值。lastReadTime 會強制比對最新的訊息建立時間。請注意，聊天室讀取狀態只會影響聊天室頂層對話中顯示訊息的讀取狀態。討論串中的回覆不會受到這個時間戳記的影響，而是依賴討論串的讀取狀態。

以下範例會更新呼叫使用者的空間讀取狀態：

Node.js

chat/client-libraries/cloud/update-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'];

// This sample shows how to update a 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 timestamp = new Date('2000-01-01').getTime();
  const request = {
    spaceReadState: {
      // Replace SPACE_NAME here
      name: 'users/me/spaces/SPACE_NAME/spaceReadState',
      lastReadTime: {
        seconds: Math.floor(timestamp / 1000),
        nanos: (timestamp % 1000) * 1000000
      }
    },
    updateMask: {
      // The field paths to update.
      paths: ['last_read_time']
    }
  };

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

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

main().catch(console.error);

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

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

相關主題

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