本页介绍如何使用 subscriptions.list()
方法列出 Google Workspace 订阅。
当您使用用户身份验证功能调用此方法时,此方法会返回用户授权的订阅列表。当您使用应用身份验证时,该方法可以返回一个列表,其中包含应用的任何订阅。
前提条件
Python
- Python 3.6 或更高版本
- pip 软件包管理工具
- 适用于 Python 的最新 Google 客户端库。如需安装或更新它们,请在命令行界面中运行以下命令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
列出用户授权的订阅
如需列出订阅,您必须按至少一种事件类型进行过滤。您还可以按一个或多个目标资源过滤查询。如需了解受支持的查询过滤条件,请参阅 list()
方法文档。
以下代码示例返回按事件类型和目标资源过滤的 Subscription
对象数组。在以用户的身份进行身份验证时,该方法仅返回经用户授权应用创建的订阅列表。
如需列出指定事件类型和目标资源的订阅,请执行以下操作:
Python
在工作目录中,创建一个名为
list_subscriptions.py
的文件,并添加以下代码:"""List subscriptions.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Specify required scopes. SCOPES = ['SCOPE'] # Authenticate with Google Workspace and get user authentication. flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES) CREDENTIALS = flow.run_local_server() # Call the Workspace Events API using the service endpoint. service = build( 'workspaceevents', 'v1', credentials=CREDENTIALS, ) # Filter for event type (required). EVENT_TYPE = 'EVENT_TYPE' # Filter for target resource (optional). TARGET_RESOURCE = 'TARGET_RESOURCE' FILTER = f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"' response = service.subscriptions().list(filter=FILTER).execute() print(response)
替换以下内容:
SCOPE
:支持订阅中的至少一种事件类型的 OAuth 范围。例如,如果您的订阅在更新后的 Chat 聊天室中接收事件,则使用https://www.googleapis.com/auth/chat.spaces.readonly
。EVENT_TYPE
:根据 CloudEvents 规范设置的事件类型。例如,如需过滤接收接收 Google Chat 聊天室新成员资格相关事件的订阅,请使用google.workspace.chat.message.v1.created
。TARGET_RESOURCE
:目标资源,格式为完整资源名称。例如,如需按 Google Chat 聊天室的订阅进行过滤,请使用//chat.googleapis.com/spaces/SPACE_ID
,其中spaces/SPACE_ID
表示Space
资源的name
字段。
在工作目录中,确保您已存储 OAuth 客户端 ID 凭据并将文件命名为
client_secrets.json
。此代码示例使用此 JSON 文件进行 Google Workspace 身份验证并获取用户凭据。有关说明,请参阅创建 OAuth 客户端 ID 凭据。如需列出订阅,请在终端中运行以下命令:
python3 list_subscriptions.py
Google Workspace Events API 会返回与查询的过滤条件匹配的 Subscription
对象的分页数组。