列出 Google Workspace 订阅

Apps 脚本

• Google Workspace 订阅。如需创建订阅，请参阅创建订阅。

• 需要使用一个或多个支持订阅的所有事件类型的镜重对用户进行身份验证。

• Apps 脚本项目：
  • 使用您的 Google Cloud 项目，而不是 Apps Script 自动创建的默认项目。
  • 对于您添加以配置 OAuth 同意屏幕的任何范围，您还必须将这些范围添加到 Apps Script 项目中的 appsscript.json 文件。 例如：

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • 启用 Google Workspace Events 高级服务。

Python

• Python 3.6 或更高版本
• pip 软件包管理工具
• 最新的 Python 版 Google 客户端库。如需安装或更新这些软件包，请在命令行界面中运行以下命令：

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• Google Workspace 订阅。如需创建订阅，请参阅创建订阅。

• 需要身份验证：

  • 对于用户身份验证，需要一个范围，该范围支持订阅的至少一种事件类型。如需识别范围，请参阅按事件类型划分的范围。
  • 对于应用身份验证，需要 chat.bot 权限范围（仅限 Google Chat 应用）。

Apps 脚本

1. 在 Apps 脚本项目中，创建一个名为 listSubscriptions 的新脚本文件，并添加以下代码：

   function listSubscriptions() {
     // Filter for event type (required).
     const eventType = 'EVENT_TYPE';
   
     // Filter for target resource (optional).
     const targetResource = 'TARGET_RESOURCE';
   
     const filter = `event_types:"${eventType}" AND target_resource="${targetResource}"`
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.list({ filter });
     console.log(response);
   }
   

   替换以下内容：

   • 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 字段。

2. 如需列出订阅，请在 Apps 脚本项目中运行函数 listSubscriptions。

Python

1. 在工作目录中，创建一个名为 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 字段。

2. 在工作目录中，确保您已存储 OAuth 客户端 ID 凭据并将文件命名为 client_secrets.json。该代码示例使用此 JSON 文件通过 Google Workspace 进行身份验证并获取用户凭据。如需了解相关说明，请参阅创建 OAuth 客户端 ID 凭据。

3. 如需列出订阅，请在终端中运行以下命令：

   python3 list_subscriptions.py