本页面介绍了如何通过解决或排查错误并调用 subscriptions.reactivate()
方法来重新激活已暂停的 Google Workspace 订阅。
每当错误导致 Google Workspace 订阅无法接收事件时,该订阅就会被暂停。例如,如果找不到订阅的目标资源或通知端点,系统会暂停该订阅。解决订阅的所有错误后,您可以重新激活订阅,以便重新开始接收事件。
您可以通过以下方式了解已中止的订阅:
- 您的应用会收到有关暂停的生命周期事件。如果您的订阅因其端点出错而被暂停,您可能不会收到生命周期事件。
- 您可以使用
subscriptions.get()
或subscriptions.list()
方法查看订阅的state
字段是否设置为SUSPENDED
。 - 您会收到通知,告知您的通知端点递送失败。如需了解如何监控向 Google Cloud Pub/Sub 主题传送失败的消息,请参阅处理消息失败情况。
重新激活的订阅会保留原始的到期日期。如需延长订阅的到期时间,请参阅更新或续订订阅。
Apps 脚本
- Google Workspace 订阅。如需创建订阅,请参阅创建订阅。
需要使用一个或多个支持订阅的所有事件类型的镜重对用户进行身份验证。
- Apps 脚本项目:
- 使用您的 Google Cloud 项目,而不是由 Apps Script 自动创建的默认项目。
- 对于您添加以配置 OAuth 同意屏幕的任何范围,您还必须将这些范围添加到 Apps Script 项目中的
appsscript.json
文件。 例如: - 启用
Google Workspace Events
高级服务。
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
Python
- Python 3.6 或更高版本
- pip 软件包管理工具
- 适用于 Python 的最新 Google 客户端库。如需安装或更新这些软件包,请在命令行界面中运行以下命令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Workspace 订阅。如需创建订阅,请参阅创建订阅。
需要通过一个或多个支持订阅的所有事件类型的作用域进行用户身份验证。
找出并解决错误
如需识别订阅的错误,请查看订阅的 suspensionReason
字段。您可以在收到有关暂停的生命周期事件时找到此字段,也可以使用 subscriptions.get()
方法查看订阅的所有字段。
下表显示了订阅可能出现的错误,以及可能的情况下如何解决错误。如果您无法解决此错误,可以删除订阅,或等待订阅到期。Google Workspace Events API 会自动删除已过期的订阅。
错误 | 说明 | 解决方法 |
---|---|---|
|
授权用户已撤消对订阅所需的一个或多个 OAuth 范围的授予。 | 获取另一个访问令牌。如需了解详情,请参阅从 Google 授权服务器获取访问令牌。 |
|
订阅的目标资源已被删除。 | 如果资源已恢复,请调用 reactivate() 方法。否则,您无需采取任何行动,因为您无法在没有原始目标资源的情况下重新激活订阅。 |
|
授权用户无权再访问订阅的资源。 | 无需执行任何操作。由于授权该订阅的用户无法访问目标资源,因此您无法重新启用该订阅。 |
|
Google Workspace 应用无权向您的通知端点提交事件。 | 为传送事件的 Google Workspace 应用授予对服务账号的访问权限。 对于 Google Chat 活动,服务账号为 chat-api-push@system.gserviceaccount.com 。对于 Google Meet 事件,服务账号为 meet-api-event-push@system.gserviceaccount.com 。对于 Pub/Sub 主题,请向服务账号授予 Pub/Sub Publisher ( roles/pubsub.publisher)
) 的角色。 |
|
通知端点不存在或找不到。 | 检查端点是否仍处于有效状态并正常运行。如需排查 Pub/Sub 主题问题,请参阅问题排查文档。 |
|
由于配额不足或达到速率限制,通知端点未能接收事件。 | 申请增加配额。 |
重新激活订阅
解决导致订阅被暂停的错误后,您可以使用 reactivate()
方法让订阅重新接收事件。该方法会检查是否已解决所有错误,并将订阅的 state
字段从 SUSPENDED
更改为 ACTIVE
。
如需重新激活 Google Workspace 订阅,请执行以下操作:
Apps 脚本
在 Apps 脚本项目中,创建一个名为
reactivateSubscription
的新脚本文件,并添加以下代码:function reactivateSubscription() { // The name of the subscription to reactivate. const name = 'subscriptions/SUBSCRIPTION_ID'; // Call the Workspace Events API using the advanced service. const response = WorkspaceEvents.Subscriptions.reactivate({}, name); console.log(response); }
替换以下内容:
如需重新激活 Google Workspace 订阅,请在 Apps 脚本项目中运行函数
reactivateSubscription
。
Python
在工作目录中,创建一个名为
reactivate_subscription.py
的文件,并添加以下代码:"""Reactivate 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('client_secrets.json', SCOPES) CREDENTIALS = flow.run_local_server() # Call the Workspace Events API using the service endpoint. service = build( 'workspaceevents', 'v1', credentials=CREDENTIALS, ) NAME = 'subscriptions/SUBSCRIPTION_ID' response = service.subscriptions().reactivate(name=NAME).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,您可以使用以下任一方法:
在工作目录中,确保您已存储 OAuth 客户端 ID 凭据并将文件命名为
client_secrets.json
。此代码示例使用此 JSON 文件进行 Google Workspace 身份验证,并获取用户凭据。如需了解相关说明,请参阅创建 OAuth 客户端 ID 凭据。如需重新激活 Google Workspace 订阅,请在终端中运行以下命令:
python3 reactivate_subscription.py
Subscription
资源实例的长时间运行的操作。
如果请求失败,请参阅下一部分以排查其他错误。
排查多个错误
如果您已解决导致订阅被暂停的错误,但 reactivate()
方法仍会失败,则说明订阅被暂停后可能发生了另一个错误。
如需识别其他错误,请查看失败请求的输出。输出包含仍存在的所有错误。
如果您的订阅存在多个错误,suspensionReason
字段的值始终使用导致您的订阅被暂停的原始错误。