列出 Google Workspace 訂閱方案

Apps Script

• Google Workspace 訂閱方案。如要建立訂閱項目，請參閱「建立訂閱項目」一文。

• 必須使用一或多個支援訂閱項目所有事件類型的範圍進行使用者驗證。

• 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 應用程式)。

Apps Script

1. 在 Apps Script 專案中，建立名為 listSubscriptions 的新指令碼檔案，並新增下列程式碼：

   function listSubscriptions() {
     // Filter for event type (required).
     const eventType = 'EVENT_TYPE';
   
     // Filter for target resource (optional).
     const targetResource = 'TARGET_RESOURCE';
   
     const filter = `event_types:"${eventType}" AND target_resource="${targetResource}"`
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.list({ filter });
     console.log(response);
   }
   

   更改下列內容：

   • EVENT_TYPE：符合 CloudEvents 規格的事件類型格式。舉例來說，如要篩選會在 Google Chat 聊天室 google.workspace.chat.message.v1.created 中收到新成員相關事件的訂閱項目。
   • TARGET_RESOURCE：目標資源，格式為其完整的資源名稱。舉例來說，如要依 Google Chat 聊天室的訂閱項目進行篩選，請使用 //chat.googleapis.com/spaces/SPACE_ID，其中 spaces/SPACE_ID 代表 Space 資源的 name 欄位。

2. 如要列出訂閱項目，請在 Apps Script 專案中執行 listSubscriptions 函式。

Python

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

   """List subscriptions."""
   
   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,
   )
   
   # Filter for event type (required).
   EVENT_TYPE = 'EVENT_TYPE'
   
   # Filter for target resource (optional).
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   FILTER = f'event_types:"{EVENT_TYPE}" AND target_resource="{TARGET_RESOURCE}"'
   response = service.subscriptions().list(filter=FILTER).execute()
   print(response)
   

   更改下列內容：

   • SCOPE：支援訂閱中至少一個事件類型的 OAuth 範圍。舉例來說，如果訂閱項目收到更新過的 Chat 聊天室事件，則為 https://www.googleapis.com/auth/chat.spaces.readonly。
   • EVENT_TYPE：符合 CloudEvents 規格的事件類型格式。舉例來說，如要篩選會在 Google Chat 聊天室 google.workspace.chat.message.v1.created 中收到新成員相關事件的訂閱項目。
   • TARGET_RESOURCE：目標資源，格式為其完整的資源名稱。舉例來說，如要依 Google Chat 聊天室的訂閱項目進行篩選，請使用 //chat.googleapis.com/spaces/SPACE_ID，其中 spaces/SPACE_ID 代表 Space 資源的 name 欄位。

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

3. 如要列出訂閱項目，請在終端機中執行下列指令：

   python3 list_subscriptions.py