列出聊天室

本指南說明如何在 Google Chat API 的 Space 資源上使用 list 資源列出聊天室。商家資訊空間會傳回經過分頁且可篩選的空格清單。

Space 資源代表使用者可以和 Chat 應用程式傳送訊息、共用檔案及進行協同合作的位置。聊天室分為以下幾種類型：

即時訊息 (DM) 是兩位使用者或使用者和 Chat 應用程式之間的對話。
群組通訊是指三位以上使用者和 Chat 應用程式之間的對話。
已命名的聊天室是永久的地方，可讓使用者傳送訊息、共用檔案及協同合作。

列出具有應用程式驗證的聊天室會列出 Chat 應用程式可存取的聊天室。列出具有使用者驗證的空間，其中會列出已驗證使用者可存取的空格。

必要條件

Python

Python 3.6 以上版本
pip 套件管理工具
最新的 Python 專用 Google 用戶端程式庫。如要安裝或更新，請在指令列介面中執行下列指令：
```
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
```
已發布的 Chat 應用程式。如要建立及發布 Chat 應用程式，請參閱「建構 Google Chat 應用程式」。
已設定 Chat 應用程式的授權。商家資訊空間支援以下兩種驗證方法：
- 使用 chat.spaces.readonly 或 chat.spaces 授權範圍的使用者驗證。
- 使用 chat.bot 授權範圍的應用程式驗證。

列出採用使用者驗證機制的聊天室

如要在 Google Chat 中列出聊天室，請在要求中傳遞以下內容：

使用使用者驗證時，請指定 chat.spaces.readonly 或 chat.spaces 授權範圍。
呼叫 Space 資源上的 list 方法。

下列範例會列出已驗證使用者可見的已命名聊天室和群組通訊 (但不會列出遭到篩除的即時訊息)：

Python

在工作目錄中，建立名為 chat_space_list.py 的檔案。

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

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists named spaces and group chats (but not direct messages)
    visible to the authenticated 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.spaces().list(

          # An optional filter that returns named spaces or unnamed group chats,
          # but not direct messages (DMs).
          filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

      ).execute()

    # Prints the returned list of spaces.
    print(result)

if __name__ == '__main__':
    main()

在工作目錄中建構並執行範例：
```
python3 chat_space_list.py
```

Chat API 會傳回已命名聊天室和群組通訊的分頁陣列。

列出採用應用程式驗證功能的聊天室

如要在 Google Chat 中列出聊天室，請在要求中傳遞以下內容：

請使用應用程式驗證，指定 chat.bot 授權範圍。
呼叫 Space 資源上的 list 方法。

以下範例列出 Chat 應用程式可見的已命名聊天室和群組通訊 (但不含即時訊息)：

Python

在工作目錄中，建立名為 chat_space_list_app.py 的檔案。

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

from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

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

        # An optional filter that returns named spaces or unnamed
        # group chats, but not direct messages (DMs).
        filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

    ).execute()

print(result)

在工作目錄中建構並執行範例：
```
python3 chat_space_list_app.py
```

Chat API 會傳回聊天室的分頁陣列。

自訂分頁或篩選清單

如要列出 Google Chat 中的聊天室，請傳遞下列選用的查詢參數，以自訂分頁或篩選所列聊天室的分頁：

pageSize：要傳回的空格數量上限。服務傳回的結果可能會少於這個值。如未指定，最多會傳回 100 個空格。最大值為 1,000；超過 1,000 的值會自動變更為 1,000。
pageToken：從先前的清單聊天室呼叫接收的網頁權杖。提供此權杖即可擷取後續網頁。進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。傳遞不同的值可能會導致非預期的結果。
filter：查詢篩選器。需要使用者驗證。如需支援的查詢詳細資料，請參閱 spaces.list 方法。

列出聊天室

必要條件

Python

列出採用使用者驗證機制的聊天室

Python

列出採用應用程式驗證功能的聊天室

Python

自訂分頁或篩選清單

相關主題