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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

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