建立 Google Workspace 訂閱方案

Apps Script

• 如要使用本指南中的 Google Cloud CLI 指令，請按照下列指示操作：
  1. 安裝 Google Cloud CLI。
  2. 收件者： 初始化 gcloud CLI，請執行下列指令：

    gcloud init
    

• Google Cloud 專案 並啟用計費功能。如要訂閱 Chat，您必須： 您也會在 Cloud 專案中啟用 Chat API 設定「應用程式名稱」、「顯示圖片網址」和「說明」。 只要使用來自這些領域的 小型資料集訓練即可詳情請參閱 建構 Google Chat 應用程式。
• 需要透過已設定 OAuth 同意畫面進行使用者驗證 應用程式設定同意畫面時，您必須指定 支援訂閱的每個事件類型。設定同意聲明 找出所需的範圍 選擇範圍。

• 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 Cloud CLI 指令，請按照下列指示操作：
  1. 安裝 Google Cloud CLI。
  2. 收件者： 初始化 gcloud CLI，請執行下列指令：

    gcloud init
    

• Google Cloud 專案 並啟用計費功能。如要訂閱 Chat，您必須： 您也會在 Cloud 專案中啟用 Chat API 設定「應用程式名稱」、「顯示圖片網址」和「說明」。 只要使用來自這些領域的 小型資料集訓練即可詳情請參閱 建構 Google Chat 應用程式。
• 需要透過已設定 OAuth 同意畫面進行使用者驗證 應用程式設定同意畫面時，您必須指定 支援訂閱的每個事件類型。設定同意聲明 找出所需的範圍 選擇範圍。

Google Cloud 控制台

在 Google Cloud 控制台中，開啟應用程式的 Google Cloud 專案，並啟用 Google Workspace 事件 API 和 Pub/Sub API：

啟用 API

gcloud

1. 在工作目錄中登入 Google 帳戶：

   gcloud auth login
   

2. 將專案設為應用程式的 Cloud 專案：

   gcloud config set project PROJECT_ID
   

   將 PROJECT_ID 替換為 應用程式的 Cloud 專案的專案 ID。

3. 啟用 Google Workspace Events API 和 Google Cloud Pub/Sub API：

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Google Cloud 控制台

1. 前往 Google Cloud 控制台中的「Pub/Sub」頁面：

   前往 Google Cloud Pub/Sub

   確認已選取應用程式的 Cloud 專案。

2. 按一下「建立主題」圖示 add_box，然後 ：

   1. 輸入主題名稱，例如 workspace-events-topic。
   2. 保持選取「新增預設訂閱項目」。Pub/Sub 會將這個名稱 和主題名稱相似的預設訂閱項目，例如 workspace-events-topic-sub。
   3. 選用步驟：更新或設定其他屬性 找出適合您主題的網站

3. 點選「建立」。完整主題名稱的格式為 projects/PROJECT_ID/topics/TOPIC_ID。 您將在後續步驟中使用這個全名。

4. 授予將 Pub/Sub 訊息發布至主題的權限：

   1. 在你的主題頁面中，前往側邊面板並開啟 「權限」分頁。
   2. 按一下「新增主體」。
   3. 在「新增主體」欄位中，新增要啟用哪個服務帳戶的服務帳戶。 是一種 Google Workspace 應用程式，可將事件傳送到 訂閱：
      1. Chat 事件： chat-api-push@system.gserviceaccount.com。
      2. 針對 Meet 活動， meet-api-event-push@system.gserviceaccount.com。
   4. 在「指派角色」選單中選取 Pub/Sub Publisher。
   5. 按一下 [儲存]。權限更新作業可能需要幾分鐘才能完成 找出適合您主題的網站

gcloud

1. 在 Cloud 專案中，執行下列指令來建立主題 指令：

   gcloud pubsub topics create TOPIC_ID
   

   將 TOPIC_ID 替換成主題的專屬 ID，例如： 使用 workspace-events-topic。

   輸出結果會顯示完整的主題名稱，格式為 projects/PROJECT_ID/topics/TOPIC_ID。 請記下名稱，並確定 PROJECT_ID 是 Cloud 專案 ID 。在下一個步驟中，您將使用主題名稱 Google Workspace 訂閱方案

2. 授予將訊息發布至主題的權限：

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   更改下列內容：

   • TOPIC_NAME：完整主題名稱，也就是 輸出內容採用格式 projects/PROJECT_ID/topics/TOPIC_ID。

   • GOOGLE_WORKSPACE_APPLICATION： 必須傳送事件的 Google Workspace 應用程式 您的訂閱：

     • 如要接收 Chat 事件，請使用 chat-api-push@system.gserviceaccount.com。
     • 如要接收 Meet 的活動，請使用 meet-api-event-push@system.gserviceaccount.com。

   系統可能需要幾分鐘的時間才能更新主題的權限。

3. 為主題建立 Pub/Sub 訂閱項目：

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   更改下列內容：

   • SUBSCRIPTION_NAME：訂閱項目的名稱 例如 workspace-events-subscription
   • TOPIC_NAME：您建立的主題名稱

Apps Script

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

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   更改下列內容：

   • TARGET_RESOURCE：Google Workspace 資源 訂閱項目的完整資源名稱，格式為完整資源名稱。適用對象 例如，若要使用聊天室 ID 訂閱 Google Chat 聊天室 AAAABBBB，使用 //chat.googleapis.com/spaces/AAAABBBB。
   • EVENT_TYPES：一或多個事件類型 您要在目標資源中訂閱的節點。採用 字串陣列，例如 'google.workspace.chat.message.v1.created'。
   • TOPIC_NAME：Pub/Sub 主題的全名 建立 Deployment採用格式 projects/PROJECT_ID/topics/TOPIC_ID。

   • RESOURCE_DATA：布林值，用來指定 訂閱包含酬載中的資源資料：

     • True：包含所有資源資料。限制 已納入，請將 fieldMask ] 欄位，然後為已變更的資源指定至少一個欄位。僅限 訂閱 Chat 資源支援，包括 資源資料
     • False：排除資源資料。

2. 如要建立 Google Workspace 訂閱，請執行函式 createSubscription 位於 Apps Script 專案中。

Python

1. 在工作目錄中，建立名為 create_subscription.py 的檔案 然後加入下列程式碼：

   """Create 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()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   更改下列內容：

   • SCOPES：支援各種事件類型的一或多個 OAuth 範圍 訂閱項目。採用字串陣列的格式。如要列出多個範圍，請以半形逗號分隔。 例如：'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'。
   • TARGET_RESOURCE：Google Workspace 資源 訂閱項目的完整資源名稱，格式為完整資源名稱。適用對象 例如，若要使用聊天室 ID 訂閱 Google Chat 聊天室 AAAABBBB，使用 //chat.googleapis.com/spaces/AAAABBBB。
   • EVENT_TYPES：一或多個事件類型 您要在目標資源中訂閱的節點。採用 字串陣列，例如 'google.workspace.chat.message.v1.created'。
   • TOPIC_NAME：Pub/Sub 主題的全名 建立 Deployment採用格式 projects/PROJECT_ID/topics/TOPIC_ID。

   • RESOURCE_DATA：布林值，用來指定 訂閱包含酬載中的資源資料：

     • True：包含所有資源資料。限制 已納入，請將 fieldMask ] 欄位，然後為已變更的資源指定至少一個欄位。僅限 訂閱 Chat 資源支援，包括 資源資料
     • False：排除資源資料。

2. 如要建立 Google Workspace 訂閱，請在以下位置執行下列指令： 終端機：

   python3 create_subscription.py
   

Google Cloud 控制台

1. 在 Google Workspace 訂閱方案。舉例來說，假設您訂閱了 在 Chat 聊天室中張貼訊息。

2. 前往 Google Cloud 控制台中的「Pub/Sub」頁面：

   前往 Pub/Sub

   確認已選取應用程式的 Cloud 專案。

3. 在「Pub/Sub」選單中，按一下「訂閱」。

4. 在表格中找到所需主題的 Pub/Sub 訂閱項目，然後按一下 訂閱項目名稱。

5. 按一下「Messages」(訊息) 分頁標籤。

6. 按一下「提取」。事件最多可能需要幾分鐘才能生成 Pub/Sub 訊息。

gcloud

1. 在 Google Workspace 訂閱方案。舉例來說，假設您訂閱了 在 Chat 聊天室中張貼訊息。

2. 執行下列指令：

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   更改下列內容：

   • PUBSUB_SUBSCRIPTION_NAME：您的全名 Pub/Sub 訂閱項目，格式為 projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID。
   • MESSAGE_COUNT：要提取的 Pub/Sub 訊息數量上限。

   事件最多可能需要幾分鐘才能產生 Pub/Sub 撰寫新的電子郵件訊息