列出聊天室

本指南說明如何針對以下項目的 Space 資源使用 list 資源： 使用 Google Chat API 列出聊天室。清單聊天室會傳回可篩選的分頁式 聊天室清單。

Space 項資源 代表使用者和 Chat 擴充應用程式可以傳送訊息的地方 分享檔案及協同合作聊天室分為以下幾類：

  • 即時訊息 (DM) 是指兩位使用者或使用者之間的對話， Chat 應用程式。
  • 群組通訊是 3 位以上使用者的對話， Chat 擴充應用程式。
  • 已命名的聊天室是使用者傳送訊息、共用檔案、 這項原則著重於透過對開放式探究 嚴謹治學、誠信與合作的堅持來達到上述目標

列出含有 應用程式驗證 列出 Chat 應用程式可存取的聊天室。清單項目 含有 使用者驗證 列出已驗證使用者可存取的聊天室。

必要條件

Python

Node.js

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

如要在 Google Chat 中列出聊天室，請在 要求：

以下範例會列出已命名的聊天室和群組通訊 (但不會列出直接聯絡人) 通過驗證的使用者可檢視的訊息：

Python

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

  2. 在 chat_space_list.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.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()

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

    python3 chat_space_list.py

Node.js

  1. 在工作目錄中，建立名為 list-spaces.js 的檔案。

  2. 在 list-spaces.js 中加入下列程式碼：

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

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

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

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

  3. 在工作目錄中執行範例：

    node list-spaces.js

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

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

如要在 Google Chat 中列出聊天室，請在 要求：

以下範例會列出已命名的聊天室和群組通訊 (但不會列出直接聯絡人) 訊息)：

Python

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

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

    from google.oauth2 import service_account
from apiclient.discovery import build

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

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

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

# 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)

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

    python3 chat_space_list_app.py

Node.js

  1. 在工作目錄中，建立名為 app-list-spaces.js 的檔案。

  2. 在 app-list-spaces.js 中加入下列程式碼：

    const chat = require('@googleapis/chat');

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

  3. 在工作目錄中執行範例：

    node app-list-spaces.js

Chat API 會傳回聊天室陣列。

自訂分頁或篩選清單

如要在 Google Chat 中列出聊天室，請傳遞下列選用碼 查詢參數，用於自訂或篩選已列出的空格：

  • pageSize：要傳回的聊天室數量上限。服務可能會傳回 小於這個值如未指定，最多會傳回 100 個空格。 最高值為 1,000；超過 1,000 個的值會自動變更為 1,000 人。
  • pageToken：從先前的 list_space 呼叫接收的頁面符記。 提供這個權杖即可擷取後續網頁。進行分頁時， 篩選器值應與提供網頁符記的呼叫相符。傳送 否則可能會導致非預期的結果
  • filter：查詢篩選器。如要進一步瞭解支援的查詢詳細資料，請參閱 spaces.list 方法。