刪除 Google Workspace 訂閱方案

本頁說明如何使用 subscriptions.delete() 方法刪除 Google Workspace 訂閱項目。

刪除訂閱項目後,應用程式就不會再收到任何事件。如果訂閱項目到期,Google Workspace Events API 會自動刪除該項目。

必要條件

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
      
  • 訂閱 Google Workspace。如要建立訂閱項目,請參閱「建立訂閱項目」。

  • 需要驗證

    • 針對使用者驗證,需要至少支援訂閱項目的一種事件類型的範圍。如要瞭解如何識別範圍,請參閱「依事件類型劃分的範圍」。
    • 如要進行應用程式驗證,需要 chat.bot 範圍 (僅限 Google Chat 應用程式)。

刪除使用者授權的訂閱項目

以下程式碼範例會使用使用者驗證功能刪除 Subscription 資源。

如要刪除訂閱項目,請按照下列步驟操作:

Apps Script

  1. 在 Apps 指令碼專案中,建立名為 deleteSubscription 的新指令碼檔案,然後加入下列程式碼:

    function deleteSubscription() {
      // The name of the subscription to delete.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.remove(name);
      console.log(response);
    }
    

    更改下列內容:

    • SUBSCRIPTION_ID:訂閱項目 ID。如要取得 ID,您可以使用下列任一方法:
      • uid 欄位的值。
      • name 欄位中代表資源名稱的 ID。舉例來說,如果資源名稱為 subscriptions/subscription-123,請使用 subscription-123
  2. 如要刪除訂閱項目,請在 Apps Script 專案中執行 deleteSubscription 函式。

Python

  1. 在工作目錄中建立名為 delete_subscription.py 的檔案,並新增下列程式碼:

    """Delete subscription."""
    
    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,
    )
    
    NAME = 'subscriptions/SUBSCRIPTION_ID'
    response = service.subscriptions().delete(name=NAME).execute()
    print(response)
    

    更改下列內容:

    • SCOPE支援訂閱項目中至少一種事件類型的 OAuth 範圍。舉例來說,如果訂閱項目收到事件 (更新的 Chat 聊天室),https://www.googleapis.com/auth/chat.spaces.readonly
    • SUBSCRIPTION_ID:訂閱項目 ID。如要取得 ID,您可以使用下列任一方法:
      • uid 欄位的值。
      • name 欄位中代表資源名稱的 ID。舉例來說,如果資源名稱為 subscriptions/subscription-123,請使用 subscription-123
  2. 請確認您已在工作目錄中儲存 OAuth 用戶端 ID 憑證,並將檔案命名為 client_secrets.json。程式碼範例會使用這個 JSON 檔案,透過 Google Workspace 進行驗證並取得使用者憑證。如需操作說明,請參閱「建立 OAuth 用戶端 ID 憑證」。

  3. 如要刪除訂閱項目,請在終端機中執行下列指令:

    python3 delete_subscription.py
Google Workspace Events API 會傳回長時間執行作業,其中包含 Subscription 資源的例項。