使用 Google Chat 中的活動

本頁面說明 Google Chat 應用程式如何接收及回覆 活動。

Google Chat 事件代表 Chat 中的活動或變更。 例如聊天室中的新訊息Chat 應用程式可以使用的 瞭解事件狀況並採取行動或採取有意義的行動 為使用者提供的服務

以下舉例說明事件的使用方式:

  • 監控及回覆聊天室中的新訊息,例如檢查金鑰 或詞組
  • 在使用者加入聊天室時傳送歡迎訊息,說明聊天室內容 或提供有效使用 Chat 應用程式。
  • 追蹤及分析 Chat 活動。舉例來說,假設您要將 每月報表會列出新會員相關資訊,或 回應或回覆。
  • 透過各種訊息平台進行通訊。舉例來說,使用者可以傳送 正常地使用不同的訊息平台接收使用者的訊息 離開 Chat。

事件的運作方式

只要 Google Chat 發生情況,Google Chat API 資源就會 建立、更新或刪除Chat 會使用活動提供相關訊息 傳送給 Chat 應用程式的資訊,以便瞭解 活動,以及受影響的 Chat API 資源。

範例:訊息發布至 Google Chat 聊天室後,會觸發事件。
圖 1.使用者在 Chat 聊天室,會建立 Message 資源。 Chat 隨後就會建立事件,內含新的 訊息。

Chat 會依類型將事件分類。「事件類型」可協助您篩選 僅接收您需要的資訊,您可以處理類似的 管理 Google 活動

下表列出 Chat 中的活動對 相關的 Chat API 資源,以及事件類型 即時通訊應用程式會收到:

活動 Chat API 資源 事件類型
使用者在 Chat 聊天室中張貼訊息 建立 Message 資源。 新訊息
使用者將成為聊天室管理員。 Membership 資源已更新。 已更新成員
使用者回應訊息。 建立 Reaction 資源。 新回應
使用者離開聊天室。 系統會刪除 Membership 資源。 已刪除會員資格

接收 Google Chat 事件

如要接收活動,Chat 應用程式可以使用以下其中一種方式: 包括:

  • 使用 Google Workspace Event API 訂閱事件以接收事件 。
  • 呼叫 Chat API 即可查詢近期事件。

下表說明查詢或 訂閱事件:

訂閱活動 事件查詢
用途
  • 即時處理或回應事件。
  • 監控使用者會員活動,並發掘新聊天室 監控功能
  • 定期或透過觸發條件處理或回應事件。
  • 從訂閱項目擷取錯過的事件 (因為服務中斷, 非使用中的訂閱項目)。
API Google Workspace 事件 API Chat API
事件來源 聊天室和使用者 只有空格
支援的事件
  • 訊息
  • 會員資格
  • 回應
  • 空格

如需支援的事件類型清單,請參閱 用於建立訂閱的事件類型 Google Workspace 事件 API 說明文件。
  • 訊息
  • 會員資格
  • 回應
  • 空格

如需支援的事件類型清單,請參閱 Chat API 中的 spaceEvents 項資源 參考文件
事件格式 Google Cloud Pub/Sub 訊息,格式依據 CloudEvent 規格。詳情請參閱 Google Workspace 事件結構 Chat API 資源 ( spaces.spaceEvent)
事件資料 包含或不含資源資料的 Base64 編碼字串。如需酬載範例,請參閱「事件資料」。 包含資源資料的 JSON 酬載。部分事件類型僅包含特定資源欄位。如需酬載範例,請參閱 參考說明文件

範例:查詢或訂閱聊天室中成員資格的事件

在這個範例中,Chat 擴充應用程式 Chat 聊天室成員異動的相關資訊。於 聊天室時,就會發生以下成員資格活動:

  • 使用者加入聊天室,這會建立 Membership 資源並觸發 新的成員活動。
  • 使用者成為聊天室管理員,負責更新以下帳戶的 Membership 資源: 並觸發更新的成員事件。
  • 使用者離開聊天室,藉此刪除該聊天室的 Membership 資源。 使用者並觸發成員刪除的事件。

訂閱會員活動

如要即時接收事件, 即時通訊應用程式呼叫 Google Workspace Events API subscriptions.create()敬上 方法訂閱聊天室,適用於所有類型的成員資格事件。更新後 建立訂閱項目後,Chat 應用程式可以開始 則會收到會員活動。

這類即時通訊應用程式會使用
      Google Workspace 事件 API。
圖 2.Chat 應用程式 透過訂閱的方式接收會員事件 Google Workspace 事件 API。

圖 2 中,即時通訊應用程式已訂閱 因此,當聊天室中的成員時,應用程式會收到活動 並輸入變更內容接著,Chat 應用程式就能處理或回覆 即時參與任何活動,例如向 加入聊天室的成員。

如要瞭解如何使用 Google Workspace Event API 建立訂閱項目, 請參閱 Google Workspace Event API 說明文件

查詢近期成員資格事件

不會立即收到成員資格事件,而是 Chat 應用程式可以呼叫 Chat API 來列出 與成員活動相關的近期聊天室事件。

會使用以下語言查詢事件的 Chat 擴充應用程式:
        Chat API。
圖 3. A 罩杯 即時通訊應用程式會透過以下方式接收近期的成員資格事件: 查詢聊天室事件。

在圖 3 中,即時通訊應用程式呼叫 Chat API spaces.spaceEvents.list()敬上 方法,並篩選查詢 追蹤新的、更新和已刪除的成員資格活動。Chat API 會傳回 spaceEvent 資源清單,代表每個成員資格變更。 接著,Chat 擴充應用程式就會根據 近期活動,例如每週發布訊息並摘要說明 聊天室過去 7 天的成員活動。

如要使用 Chat API 查詢事件,請參閱 列出 Google Chat 聊天室中的事件

限制

  • 如果是訂閱使用者訂閱,則即時訊息或未命名群組通訊中的新成員事件 (google.workspace.chat.membership.v1.created)、 只會在第一則訊息張貼後觸發。
  • 使用者必須是聊天室的直接成員,才能接收成員資格活動。如果已新增使用者 使用者透過 Google 群組間接更新或移除聊天室,但訂閱作業不會 接收這些會員資格事件如要瞭解 Google 網路論壇成員資格的運作方式,請參閱: 將 Google 群組新增至聊天室