Method: subscriptions.list

Выводит список подписок Google Workspace. Чтобы узнать, как использовать этот метод, см. раздел Вывод списка подписок Google Workspace .

HTTP-запрос

GET https://workspaceevents.googleapis.com/v1/subscriptions

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

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

Параметры
pageSize

integer

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

Если не указано или установлено значение 0 , возвращается до 50 подписок.

Максимальное значение — 100. Если указать значение больше 100, система вернет только 100 подписок.

pageToken

string

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

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

filter

string

Обязательно. Фильтр запроса.

Вы можете фильтровать подписки по типу события ( event_types ) и целевому ресурсу ( target_resource ).

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

Чтобы отфильтровать как по типу события, так и по целевому ресурсу, используйте оператор AND и укажите полное имя ресурса, например //chat.googleapis.com/spaces/{space} .

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

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

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

Текст запроса

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

Тело ответа

Ответное сообщение для SubscriptionsService.ListSubscriptions .

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

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

object ( Subscription )

Список подписок.

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.bot
  • 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.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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