列出聊天室

本指南說明如何使用 Google Chat API Space 資源的 list() 方法列出聊天室。列出空間會傳回可分頁顯示和篩選的空間清單。

Space資源代表使用者和 Chat 應用程式可傳送訊息、共用檔案及協作的空間。聊天室分為以下幾種類型:

  • 即時訊息 (DM) 是指兩位使用者之間,或使用者與 Chat 應用程式之間的對話。
  • 群組對話是指三位以上使用者和即時通訊應用程式之間的對話。
  • 具名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案及協作。

使用應用程式驗證列出聊天室時,系統會列出 Chat 應用程式有權存取的聊天室。列出具有使用者驗證的空間:列出已驗證使用者可存取的空間。

必要條件

Node.js

Python

Java

Apps Script

列出具有使用者驗證的空間

如要列出 Google Chat 中的聊天室,請在要求中傳遞下列項目:

以下範例列出經過驗證的使用者可見的具名聊天室 (但會篩除群組對話和即時訊息):

Node.js

chat/client-libraries/cloud/list-spaces-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];  // This sample shows how to list spaces with user credential async function main() {   // Create a client   const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);    // Initialize request argument(s)   const request = {     // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)     filter: 'space_type = "SPACE"'   };    // Make the request   const pageResult = chatClient.listSpacesAsync(request);    // Handle the response. Iterating over pageResult will yield results and   // resolve additional pages automatically.   for await (const response of pageResult) {     console.log(response);   } }  main().catch(console.error);

Python

chat/client-libraries/cloud/list_spaces_user_cred.py
from authentication_utils import create_client_with_user_credentials from google.apps import chat_v1 as google_chat  SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]  # This sample shows how to list spaces with user credential def list_spaces_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.ListSpacesRequest(         # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)         filter = 'space_type = "SPACE"',         # Number of results that will be returned at once         page_size = 100     )      # Make the request     page_result = client.list_spaces(request)      # Handle the response. Iterating over page_result will yield results and     # resolve additional pages automatically.     for response in page_result:         print(response)  list_spaces_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListSpacesUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.ListSpacesRequest; import com.google.chat.v1.ListSpacesResponse; import com.google.chat.v1.Space;  // This sample shows how to list spaces with user credential. public class ListSpacesUserCred{    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.spaces.readonly";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       ListSpacesRequest.Builder request = ListSpacesRequest.newBuilder()         // Filter spaces by space type (SPACE or GROUP_CHAT or         // DIRECT_MESSAGE).         .setFilter("spaceType = \"SPACE\"")         // Number of results that will be returned at once.         .setPageSize(10);        // Iterate over results and resolve additional pages automatically.       for (Space response :           chatServiceClient.listSpaces(request.build()).iterateAll()) {         System.out.println(JsonFormat.printer().print(response));       }     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to list spaces with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'  * referenced in the manifest file (appsscript.json).  */ function listSpacesUserCred() {   // Initialize request argument(s)   // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)   const filter = 'space_type = "SPACE"';    // Iterate through the response pages using page tokens   let responsePage;   let pageToken = null;   do {     // Request response pages     responsePage = Chat.Spaces.list({       filter: filter,       pageSize: 10,       pageToken: pageToken     });     // Handle response pages     if (responsePage.spaces) {       responsePage.spaces.forEach((space) => console.log(space));     }     // Update the page token to the next one     pageToken = responsePage.nextPageToken;   } while (pageToken); }

Chat API 會傳回分頁列出的空間清單

使用應用程式驗證列出空間

如要列出 Google Chat 中的聊天室,請在要求中傳遞下列項目:

以下範例會列出 Chat 應用程式可見的具名聊天室 (但不包括群組即時通訊和即時訊息):

Node.js

chat/client-libraries/cloud/list-spaces-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';  // This sample shows how to list spaces with app credential async function main() {   // Create a client   const chatClient = createClientWithAppCredentials();    // Initialize request argument(s)   const request = {     // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)     filter: 'space_type = "SPACE"'   };    // Make the request   const pageResult = chatClient.listSpacesAsync(request);    // Handle the response. Iterating over pageResult will yield results and   // resolve additional pages automatically.   for await (const response of pageResult) {     console.log(response);   } }  main().catch(console.error);

Python

chat/client-libraries/cloud/list_spaces_app_cred.py
from authentication_utils import create_client_with_app_credentials from google.apps import chat_v1 as google_chat  # This sample shows how to list spaces with app credential def list_spaces_app_cred():     # Create a client     client = create_client_with_app_credentials()      # Initialize request argument(s)     request = google_chat.ListSpacesRequest(         # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)         filter = 'space_type = "SPACE"',         # Number of results that will be returned at once         page_size = 100     )      # Make the request     page_result = client.list_spaces(request)      # Handle the response. Iterating over page_result will yield results and     # resolve additional pages automatically.     for response in page_result:         print(response)  list_spaces_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListSpacesAppCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.ListSpacesRequest; import com.google.chat.v1.ListSpacesResponse; import com.google.chat.v1.Space;  // This sample shows how to list spaces with app credential. public class ListSpacesAppCred {    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithAppCredentials()) {       ListSpacesRequest.Builder request = ListSpacesRequest.newBuilder()         // Filter spaces by space type (SPACE or GROUP_CHAT or         // DIRECT_MESSAGE).         .setFilter("spaceType = \"SPACE\"")         // Number of results that will be returned at once.         .setPageSize(10);        // Iterate over results and resolve additional pages automatically.       for (Space response :           chatServiceClient.listSpaces(request.build()).iterateAll()) {         System.out.println(JsonFormat.printer().print(response));       }     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to list spaces with app credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'  * used by service accounts.  */ function listSpacesAppCred() {   // Initialize request argument(s)   // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)   const filter = 'space_type = "SPACE"';    // Iterate through the response pages using page tokens   let responsePage;   let pageToken = null;   do {     // Request response pages     responsePage = Chat.Spaces.list({       filter: filter,       pageSize: 10,       pageToken: pageToken     }, getHeaderWithAppCredentials());     // Handle response pages     if (responsePage.spaces) {       responsePage.spaces.forEach((space) => console.log(space));     }     // Update the page token to the next one     pageToken = responsePage.nextPageToken;   } while (pageToken); }

Chat API 會傳回分頁列出的空間清單

自訂分頁或篩選清單

如要在 Google Chat 中列出聊天室,請傳遞下列選用查詢參數,自訂列出聊天室的分頁或篩選條件:

  • pageSize:要傳回的空間數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 100 個空間。最大值為 1,000;超過 1,000 的值會自動變更為 1,000。
  • pageToken:先前呼叫 list spaces 時收到的頁面權杖。 提供此權杖即可擷取後續網頁。進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
  • filter:查詢篩選器。如需支援的查詢詳細資料,請參閱ListSpacesRequest參考資料。