Method: spaces.spaceEvents.list

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

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

Пример см. в разделе Список событий из чата Google .

HTTP-запрос

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Название ресурса пространства Google Chat , в котором произошли события.

Формат: spaces/{space} .

Параметры запроса

Параметры
pageSize

integer

Необязательный. Возвращено максимальное количество космических событий. Служба может вернуть меньше этого значения.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

pageToken

string

Токен страницы, полученный в результате предыдущего вызова событий пространства списка. Предоставьте это, чтобы получить следующую страницу.

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

filter

string

Необходимый. Фильтр запроса.

Вы должны указать хотя бы один тип события ( eventType ), используя оператор has : Для фильтрации по нескольким типам событий используйте оператор OR . Исключите типы пакетных событий в фильтре. Запрос автоматически возвращает все связанные пакетные события. Например, если вы фильтруете по новым реакциям ( google.workspace.chat.reaction.v1.created ), сервер также возвращает пакетные события новых реакций ( google.workspace.chat.reaction.v1.batchCreated ). Список поддерживаемых типов событий см. в справочной документации SpaceEvents .

При желании вы также можете фильтровать по времени начала ( startTime ) и времени окончания ( endTime ):

  • startTime : эксклюзивная временная метка, с которой начинается список космических событий. Вы можете перечислить события, произошедшие не более 28 дней назад. Если не указано, перечисляет космические события за последние 28 дней.
  • endTime : включающая временная метка, до которой будут перечислены космические события. Если не указано, выводит список событий до момента запроса.

Чтобы указать время начала или окончания, используйте оператор равенства = и формат в RFC-3339 . Чтобы фильтровать как по startTime , так и endTime , используйте оператор AND .

Например, допустимы следующие запросы:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Следующие запросы недействительны:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Недействительные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответное сообщение для перечисления космических событий.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Поля
spaceEvents[]

object ( SpaceEvent )

Результаты возвращаются в хронологическом порядке (сначала самое старое событие).

nextPageToken

string

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

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Дополнительную информацию см. в руководстве по авторизации .