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

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

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

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

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

Предпосылки

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

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

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

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

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

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 чата возвращает постраничный список событий в пространстве, касающихся новых участников и сообщений.

Похожие темы

• Работа с событиями из Google Chat
• Получите подробную информацию о космическом событии