刪除 Google Workspace 訂閱方案

本頁面將說明如何使用 subscriptions.delete()敬上 方法。

刪除訂閱項目後,應用程式就不會再收到任何事件。如果 訂閱到期,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
      

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

下列程式碼範例會刪除 Subscription 資源 以及運用使用者驗證服務

如要刪除訂閱項目:

Apps Script

  1. 在 Apps Script 專案中建立新的指令碼檔案 名為 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 欄位。舉例來說,如果資源名稱是 subscriptions/subscription-123,使用 subscription-123
  2. 如要刪除訂閱項目,請在以下項目中執行 deleteSubscription 函式: Apps Script 專案。

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

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

    python3 delete_subscription.py
    
Google Workspace 事件 API 會傳回 長時間執行的作業 包含 Subscription 資源的執行個體。