Method: subscriptions.list
HTTP 请求
GET https://workspaceevents.googleapis.com/v1/subscriptions
网址采用 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 错误。
|
响应正文
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
有关详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-22。
[null,null,["最后更新时间 (UTC):2024-08-22。"],[[["Lists existing Google Workspace subscriptions, allowing retrieval of details like event types and target resources."],["Enables filtering of subscriptions by event types and target resource using query parameters, requiring at least one event type for filtering."],["Uses pagination to retrieve large lists of subscriptions, providing a `nextPageToken` for accessing subsequent pages."],["Requires specific OAuth scopes for authorization, such as `https://www.googleapis.com/auth/chat.bot` or `https://www.googleapis.com/auth/chat.spaces`, to access and manage subscriptions."],["Returns a response body containing a list of subscriptions and a token for pagination if further pages exist."]]],["This document outlines how to list Google Workspace subscriptions using a `GET` request to `https://workspaceevents.googleapis.com/v1/subscriptions`. Key parameters include `pageSize` (max 100) to limit results, `pageToken` for pagination, and a mandatory `filter` to specify event types and/or target resources using `OR` and `AND` operators. The request body is empty. The response body contains a list of `subscriptions` and an optional `nextPageToken` for subsequent pages. Specific OAuth scopes are required for authorization.\n"]]