Список пространств

В этом руководстве объясняется, как использовать метод list() ресурса Space API Google Chat для вывода списка зон. В результате возвращается постраничный, фильтруемый список зон.

Ресурс Space представляет собой место, где пользователи и чат-приложения могут отправлять сообщения, обмениваться файлами и работать вместе. Существует несколько типов пространств:

  • Прямые сообщения (ЛС) — это беседы между двумя пользователями или пользователем и приложением чата.
  • Групповые чаты — это беседы между тремя и более пользователями и приложениями чата.
  • Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

В списке пространств с аутентификацией приложения перечислены пространства, к которым имеет доступ приложение Chat. В списке пространств с аутентификацией пользователя перечислены пространства, к которым имеет доступ аутентифицированный пользователь.

Предпосылки

Node.js

Питон

Ява

Скрипт приложений

Список пространств с аутентификацией пользователя

Чтобы вывести список пространств в 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);

Питон

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

Ява

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));       }     }   } }

Скрипт приложений

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); }

API чата возвращает постраничный список пространств .

Список пространств с аутентификацией приложения

Чтобы вывести список пространств в Google Chat, передайте в запрос следующее:

В следующем примере перечислены именованные пространства (но не групповые чаты и личные сообщения), видимые приложению Chat:

Node.js

чат/клиентские-библиотеки/облако/список-пространств-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);

Питон

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

Ява

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));       }     }   } }

Скрипт приложений

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); }

API чата возвращает постраничный список пространств .

Настройте пагинацию или отфильтруйте список

Чтобы составить список пространств в Google Chat, передайте следующие необязательные параметры запроса для настройки пагинации или фильтрации перечисленных пространств:

  • pageSize : Максимальное количество возвращаемых пробелов. Сервис может вернуть меньше этого значения. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000; значения выше 1000 автоматически изменяются на 1000.
  • pageToken : токен страницы, полученный из предыдущего вызова listspaces. Предоставьте этот токен для получения следующей страницы. При пагинации значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам.
  • filter : Фильтр запроса. Подробную информацию о поддерживаемых запросах см. в справочнике ListSpacesRequest .