本頁面由 Cloud Translation API 翻譯而成。

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

本指南說明如何在以下項目中使用 getSpaceReadState 方法： Google Chat API 的 SpaceReadState 資源，可取得使用者讀取作業的詳細資料保持空白狀態如要取得郵件串中郵件的讀取狀態，看取得使用者的執行緒讀取狀態詳細資料。

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

必要條件

Python

企業或企業具有存取權的 Google Workspace 帳戶 Google Chat。

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

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。圖示和說明
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例，請將憑證以 JSON 檔案 (client_secrets.json) 的格式儲存至您的本機目錄
，瞭解如何調查及移除這項存取權。如需相關指引，請完成這份快速入門導覽課程中的設定環境步驟。
選擇支援使用者驗證的授權範圍。

Node.js

企業或企業具有存取權的 Google Workspace 帳戶 Google Chat。

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

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。圖示和說明
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例，請將憑證以 JSON 檔案 (client_secrets.json) 的格式儲存至您的本機目錄
，瞭解如何調查及移除這項存取權。如需相關指引，請完成這份快速入門導覽課程中的設定環境步驟。
選擇支援使用者驗證的授權範圍。

Apps Script

企業或企業具有存取權的 Google Workspace 帳戶 Google Chat。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。圖示和說明
- 建立獨立的 Apps Script 專案，並開啟進階 Chat 服務。
，瞭解如何調查及移除這項存取權。如需相關指南，請完成快速入門導覽課程。
選擇支援使用者驗證的授權範圍。

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

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

指定 chat.users.readstate 或 chat.users.readstate.readonly 授權範圍
在 getSpaceReadState 方法的 SpaceReadState 項資源。
傳遞要取得的聊天室讀取狀態 name，包括使用者 ID 或別名和聊天室 ID取得空間讀取狀態僅支援取得讀取權限狀態，可以透過設定包括：
- me 別名。例如 users/me/spaces/SPACE/spaceReadState。
- 通話對象的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/SPACE/spaceReadState。
- 發出呼叫的使用者 ID。例如 users/USER/spaces/SPACE/spaceReadState。

以下範例會取得發出呼叫的使用者空間讀取狀態：

Python

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

在 chat_spaceReadState_get.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.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets 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().getSpaceReadState(

        # The space read state to get.
        #
        # 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'

      ).execute()

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

if __name__ == '__main__':
    main()

請在程式碼中替換下列內容：
- SPACE：聊天室名稱，您可以從中取得 spaces.list 方法或聊天室網址傳送
在工作目錄中建構並執行範例：
```
python3 chat_spaceReadState_get.py
```

Node.js

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

在 chat_spaceReadState_get 中加入下列程式碼：

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

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

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

  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.getSpaceReadState({

    /**
    * The space read state to get.
    *
    * 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'
  });
}

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

請在程式碼中替換下列內容：
- SPACE：聊天室名稱，您可以從中取得 spaces.list 方法或聊天室網址傳送
在工作目錄中建構並執行範例：
```
node chat_spaceReadState_get.js
```

Apps Script

本範例使用進階 Chat 服務。

將 chat.users.readstate.readonly 授權範圍新增至 Apps Script 專案的 appsscript.json 檔案：
```
"oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate.readonly"
]
```

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

/**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function getSpaceReadState(spaceReadStateName) {
  try {
    Chat.Users.Spaces.getSpaceReadState(spaceReadStateName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get read state with error %s', err.message);
  }
}

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

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

必要條件

Python

Node.js

Apps Script

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

Python

Node.js

Apps Script

相關主題