更新或续订 Google Workspace

Apps 脚本

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

• Apps 脚本项目：
  • 使用您的 Google Cloud 项目，而不是 Apps 脚本自动创建的默认项目。
  • 对于您为配置 OAuth 权限请求页面而添加的所有范围，您还必须将这些范围添加到 Apps 脚本项目中的 appsscript.json 文件。例如，如果您指定了 chat.messages 范围，请添加以下内容：

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

  • 启用 Google Workspace Events 高级服务。

• 需要针对订阅中的每种事件类型进行身份验证并使用适当的授权范围：

  • 对于用户身份验证，需要一个或多个范围，这些范围至少支持订阅的一种事件类型。如需确定范围，请参阅按事件类型划分的范围。
  • 如需以 Chat 应用的身份订阅 Chat 事件，需要进行 应用身份验证并获得管理员的一次性批准。

Python

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

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

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

• 需要针对订阅中的每种事件类型进行身份验证并使用适当的授权范围：

  • 对于用户身份验证，需要一个或多个范围，这些范围至少支持订阅的一种事件类型。如需确定范围，请参阅按事件类型划分的范围。
  • 如需以 Chat 应用的身份订阅 Chat 事件，需要进行 应用身份验证并获得管理员的一次性批准。

Apps 脚本

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

   function updateSubscription() {
     // The name of the subscription to update.
     const name = 'subscriptions/SUBSCRIPTION_ID';
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.patch({
       ttl: '0s',
     }, name);
     console.log(response);
   }
   

   替换以下内容：

   • SUBSCRIPTION_ID：订阅的 ID。如需获取 ID，您可以使用以下任一方法：
     • uid 字段的值。
     • name 字段中表示的资源名称的 ID。例如，如果资源名称为 subscriptions/subscription-123，请使用subscription-123。

2. 如需更新 Google Workspace 订阅，请在您的 Apps 脚本项目中运行函数 updateSubscription。

Python

1. 在工作目录中，创建一个名为 update_subscription.py 的文件，并添加以下代码：

   """Update subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('credentials.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
     )
   
   BODY = {
       'ttl': {'seconds': 0},
   }
   NAME = 'subscriptions/SUBSCRIPTION_ID'
   response = (
       service.subscriptions()
       .patch(name=NAME, updateMask='ttl', body=BODY)
       .execute()
   )
   print(response)
   

   替换以下内容：

   • SCOPES：支持订阅的每种事件类型的一个或多个 OAuth 范围 。格式为字符串数组。如需列出多个范围，请用英文逗号分隔。 例如，'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'。
   • SUBSCRIPTION_ID：订阅的 ID。如需获取 ID，您可以使用以下任一方法：
     • uid 字段的值。
     • name 字段中表示的资源名称的 ID。例如，如果资源名称为 subscriptions/subscription-123，请使用subscription-123。

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

3. 如需更新 Google Workspace 订阅，请在终端中运行以下命令：

   python3 update_subscription.py

Python

  """Update subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = [SCOPES]

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # Call the Workspace Events API using the service endpoint.
  service = build(
      'workspaceevents',
      'v1beta',
      credentials=CREDENTIALS,
  )

  BODY = {
      'ttl': {'seconds': 0},
  }
  NAME = 'subscriptions/SUBSCRIPTION_ID'
  response = (
      service.subscriptions()
      .patch(name=NAME, updateMask='ttl', body=BODY)
      .execute()
  )
  print(response)