Method: subscriptions.list

列出 Google Workspace 订阅。如需了解如何使用此方法，请参阅列出 Google Workspace 订阅。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

可选。要返回的最大订阅数。服务返回的订阅的数量可能小于此值。

如果未指定或设为 0，则最多返回 50 个订阅。

最大值为 100。如果您指定的值大于 100，系统只会返回 100 个订阅。
pageToken

string

可选。从之前的 list subscriptions 调用接收的页面令牌。提供此参数以检索后续页面。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
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

如需了解详情，请参阅授权指南。