Method: spaces.spaceEvents.list

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

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

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

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

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

    • 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 , где произошли события.

Формат: 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.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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. Для каждого события полезная нагрузка содержит самую последнюю версию ресурса Chat. Например, если вы перечисляете события о новых участниках пространства, сервер возвращает ресурсы Membership , содержащие последние сведения об участниках. Если новые участники были удалены в течение запрошенного периода, полезная нагрузка события содержит пустой ресурс Membership .

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

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

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

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

    • 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 , где произошли события.

Формат: 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.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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

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