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

本指南說明如何在以下項目中使用 updateSpaceReadState 方法： Google Chat API 的 SpaceReadState 資源，用於將聊天室標示為已讀取或未讀取。

SpaceReadState 項資源 是單例模式資源，代表 指定使用者上次在 Google Chat 聊天室中已讀訊息的時間。

必要條件

Python

  • Python 3.6 以上版本
  • pip 套件管理工具
  • 最新的 Google 用戶端程式庫。安裝或更新 在指令列介面中執行下列指令： 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 或以上版本
  • npm 套件管理工具
  • 最新的 Google 用戶端程式庫。安裝或更新 在指令列介面中執行下列指令： 
    npm install @google-cloud/local-auth @googleapis/chat

Apps Script

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

如要在聊天室中更新使用者的讀取狀態，請在 您的要求：

  • 指定 chat.users.readstate 授權範圍。
  • 在 updateSpaceReadState 方法 的 SpaceReadState 項資源。
  • 傳遞要取得的聊天室讀取狀態 name，包括使用者 ID 或 別名和聊天室 ID取得空間讀取狀態僅支援取得讀取權限 狀態，可以透過設定 包括：
    • me 別名。例如 users/me/spaces/SPACE/spaceReadState。
    • 通話對象的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/SPACE/spaceReadState。
    • 發出呼叫的使用者 ID。例如 users/USER/spaces/SPACE/spaceReadState。
  • 傳遞 updateMask，用於指定聊天室讀取狀態的各個層面 update 中具有下列支援的欄位路徑：
    • lastReadTime：更新使用者空間讀取狀態的時間。 通常會與最後讀取訊息的時間戳記相對應。 或是使用者指定的時間戳記，用於標記上次讀取位置 空白鍵。如果 lastReadTime 早於最新的訊息建立時間， 聊天室中顯示為未讀取。如要將聊天室標示為已讀，請設定 將 lastReadTime 設為晚於 (大於) 最新訊息建立後的任何值 讓應用程式從可以最快做出回應的位置 回應使用者要求系統會將 lastReadTime 強制轉換成最新的訊息建立時間。 請注意，聊天室讀取狀態只會影響 顯示在聊天室頂層對話中。討論串的回覆為 不受此時間戳記影響，而是依靠執行緒讀取狀態。

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

Python

  1. 在工作目錄中，建立名為 chat_spaceReadState_update.py。

  2. 在 chat_spaceReadState_update.py 中加入下列程式碼：

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the space read state for the calling user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.users().spaces().updateSpaceReadState(

        # The space read state to update.
        #
        # Replace USER with the calling user's ID, Workspace email,
        # or the alias me.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='users/me/spaces/SPACE/spaceReadState',
        updateMask='lastReadTime',
        body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'}

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. 請在程式碼中替換下列內容：

    • SPACE：聊天室名稱， 您可以從中取得 spaces.list 方法 或聊天室網址傳送

  4. 在工作目錄中建構並執行範例：

    python3 chat_spaceReadState_update.py

Node.js

  1. 在工作目錄中，建立名為 chat_spaceReadState_update.js。

  2. 在 chat_spaceReadState_update 中加入下列程式碼：

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @return {!Promise<!Object>}
*/
async function updateSpaceReadState() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.users.readstate',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.users.spaces.updateSpaceReadState({

    /**
    * The space read state to update.
    *
    * Replace USER with the calling user's ID, Workspace email,
    * or the alias me.
    *
    * Replace SPACE with a space name.
    * Obtain the space name from the spaces resource of Chat API,
    * or from a space's URL.
    */
    name: 'users/me/spaces/SPACE/spaceReadState',
    updateMask: 'lastReadTime',
    requestBody: {
      lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z'
    }
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getSpaceReadState().then(console.log);

  3. 請在程式碼中替換下列內容：

    • SPACE：聊天室名稱， 您可以從中取得 spaces.list 方法 或聊天室網址傳送

  4. 在工作目錄中建構並執行範例：

    node chat_spaceReadState_update.js

Apps Script

本範例使用 進階 Chat 服務。

  1. 將 chat.users.readstate 授權範圍新增至 Apps Script 專案的 appsscript.json 檔案：

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate"
]

  2. 將像這樣的函式新增至 Apps Script 專案的 程式碼：

    /**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function updateSpaceReadState(spaceReadStateName) {
  try {
    const time = new Date('January 1, 2000')).toJSON();
    const body = {'lastReadTime': time};
    Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update read state with error %s', err.message);
  }
}

Google Chat API 會更新指定聊天室讀取狀態，並傳回 執行個體 SpaceReadState 資源。