Получение списка событий из чата Google

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

Ресурс SpaceEvent представляет собой изменение целевого пространства, включая дочерние ресурсы пространства, такие как сообщения, реакции и членство. Дополнительные сведения о списке типов событий и поддерживаемых полезных данных событий см. в полях eventType и payload справочной документации по ресурсам SpaceEvent .

Вы можете перечислить события, произошедшие за 28 дней до момента запроса. Сервер возвращает события, содержащие самую последнюю версию затронутого ресурса. Например, если вы перечислите события о новых участниках пространства, сервер вернет ресурсы Membership , содержащие последние сведения о членстве. Если новые участники были удалены в течение запрошенного периода, полезные данные события будут содержать пустой ресурс Membership .

Для вызова этого метода необходимо использовать аутентификацию пользователя . Чтобы составить список событий из пространства, аутентифицированный пользователь должен быть членом пространства.

Предварительные условия

Node.js

Список космических событий

Чтобы перечислить космические события из чат-группы, передайте в своем запросе следующее:

  • Укажите одну или несколько областей авторизации для поддержки каждого типа событий в вашем запросе. Рекомендуется выбирать наиболее ограничительную область, которая по-прежнему позволяет вашему приложению функционировать. Чтобы выбрать область, см. Обзор аутентификации и авторизации .

  • Вызовите метод ListSpaceEvents() , передав в список filter типов событий. Вы должны указать хотя бы один тип события, а также можете фильтровать по дате. Список поддерживаемых типов событий см. в поле eventType справочной документации по ресурсам SpaceEvent .

В следующем примере перечислены события о новом членстве и сообщениях в пространстве:

Node.js

чат/клиент-библиотеки/облако/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly'
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter: 'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"'
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(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);

Чтобы запустить этот пример, замените SPACE_NAME идентификатором из name пространства. Вы можете получить идентификатор, вызвав метод ListSpaces() или по URL-адресу пространства.

API чата возвращает список пространственных событий с разбивкой на страницы о новых членствах и сообщениях.