解決錯誤並重新啟用 Google Workspace 訂閱方案

本頁說明如何解決或排解錯誤，並呼叫 subscriptions.reactivate 方法，重新啟用已暫停的 Google Workspace 訂閱方案。

如果發生錯誤，導致訂閱方案無法接收事件，Google Workspace 訂閱方案就會停用。舉例來說，如果找不到目標資源或通知端點，訂閱項目就會遭到暫停。解決訂閱相關錯誤後，即可重新啟用訂閱，再次接收事件。

如要瞭解遭停權的訂閱方案，請採取下列任一做法：

  • 應用程式會收到有關停權的生命週期事件。如果訂閱方案因端點發生錯誤而遭到停權，您可能無法收到生命週期事件。
  • 您可以使用 subscriptions.get 或 subscriptions.list 方法，查看訂閱項目的 state 欄位是否設為 SUSPENDED。
  • 系統會通知您傳送至通知端點的訊息失敗。如要瞭解如何監控傳送至 Google Cloud Pub/Sub 主題的訊息是否失敗，請參閱「處理訊息傳送失敗」。

重新啟用的訂閱項目會維持原到期日。如要延長訂閱方案的效期，請參閱「更新或續訂 Google Workspace 訂閱方案」。

Apps Script

  • Apps Script 專案：
    • 使用 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

找出並解決錯誤

如要找出訂閱項目的錯誤，請查看訂閱項目的 suspensionReason 欄位。當您收到有關暫停的生命週期事件時，或使用 subscriptions.get 方法查看訂閱項目的所有欄位時，即可找到這個欄位。

下表列出訂閱項目可能發生的錯誤，以及解決方法 (如有)。如果無法解決錯誤，可以刪除訂閱項目，或等待訂閱方案到期。Google Workspace Events API 會自動刪除過期的訂閱項目。

錯誤 說明 解決方法

USER_SCOPE_REVOKED

授權使用者已撤銷訂閱項目所需的一或多個 OAuth 範圍授權。 取得其他存取權杖。詳情請參閱「 從 Google 授權伺服器取得存取權杖」。

RESOURCE_DELETED

訂閱項目的目標資源已刪除。 如果資源已還原，請呼叫 reactivate 方法。否則無需採取任何行動，因為沒有原始目標資源，就無法重新啟用訂閱項目。

USER_AUTHORIZATION_FAILURE

授權使用者已無法存取訂閱項目的資源。 您無須採取行動，由於授權訂閱的使用者無法存取目標資源，因此您無法重新啟用訂閱。

ENDPOINT_PERMISSION_DENIED

Google Workspace 應用程式無法將事件傳送至通知端點。 將存取權授予 Google Workspace 應用程式的服務帳戶，以便傳送事件。

服務帳戶：
  • Google Chat 事件：chat-api-push@system.gserviceaccount.com
  • Google 雲端硬碟活動：drive-api-event-push@system.gserviceaccount.com
  • Google Meet 活動：meet-api-event-push@system.gserviceaccount.com

如果是 Pub/Sub 主題，請將「Pub/Sub 發布者」角色 (roles/pubsub.publisher) ) 授予服務帳戶。

ENDPOINT_NOT_FOUND

通知端點不存在或找不到。 確認端點仍處於有效狀態且正常運作。如要排解 Pub/Sub 主題問題，請參閱疑難排解文件。

ENDPOINT_RESOURCE_EXHAUSTED

通知端點因配額不足或達到頻率限制，無法接收事件。 申請提高配額。

重新啟用訂閱方案

解決導致訂閱項目暫停的問題後，即可使用 reactivate 方法，讓訂閱項目再次接收事件。這個方法會檢查所有錯誤是否都已解決，並將訂閱項目的 state 欄位從 SUSPENDED 變更為 ACTIVE。

如要重新啟用 Google Workspace 訂閱方案，請按照下列步驟操作：

Apps Script

  1. 在 Apps Script 專案中，建立名為 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);
}

    更改下列內容：

    • SUBSCRIPTION_ID：訂閱 ID。如要取得 ID，可以使用下列任一方法：
      • uid 欄位的值。
      • name 欄位中代表的資源名稱 ID。舉例來說，如果資源名稱是 subscriptions/subscription-123，請使用 subscription-123。

  2. 如要重新啟用 Google Workspace 訂閱方案，請在 Apps Script 專案中執行 reactivateSubscription 函式。

Python

  1. 在工作目錄中，建立名為 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('credentials.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，可以使用下列任一方法：
      • uid 欄位的值。
      • name 欄位中代表的資源名稱 ID。舉例來說，如果資源名稱是 subscriptions/subscription-123，請使用 subscription-123。

  2. 請確認工作目錄中已儲存 OAuth 用戶端 ID 憑證，且檔案名為 credentials.json。程式碼範例會使用這個 JSON 檔案向 Google Workspace 進行驗證，並取得使用者憑證。如需操作說明，請參閱「建立 OAuth 用戶端 ID 憑證」。

  3. 如要重新啟用 Google Workspace 訂閱方案，請在終端機中執行下列指令：

    python3 reactivate_subscription.py
Google Workspace Events API 會傳回長時間執行的作業，其中包含 Subscription 資源的執行個體。

如果要求失敗，請參閱下一節，排解其他錯誤。

排解多個錯誤

如果已解決導致訂閱方案遭停用的錯誤，但 reactivate 方法仍失敗，可能是訂閱方案遭停用後發生其他錯誤。

如要找出其他錯誤，請查看失敗要求的輸出內容。輸出內容會顯示仍存在的錯誤。

如果訂閱方案發生多項錯誤，suspensionReason 欄位的值一律會使用導致訂閱方案暫停的原始錯誤。