Method: spaces.spaceEvents.list

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

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

  • Аутентификация приложения с одобрением администратора в Developer Preview с одной из следующих областей авторизации:

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

  • Аутентификация пользователя с одной из следующих областей авторизации:

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

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

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

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 )

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

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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

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

,

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

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

  • Аутентификация приложения с одобрением администратора в Developer Preview с одной из следующих областей авторизации:

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

  • Аутентификация пользователя с одной из следующих областей авторизации:

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

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

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

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 )

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

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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

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