Google Chat API 總覽

本節說明 Google Chat 應用程式如何呼叫 Chat API,讓 Chat 應用程式可以在不被 Chat 應用程式互動事件提示的情況下,建立聊天室、新增使用者以及張貼訊息等。

驗證

以非同步方式呼叫 Chat API 需要驗證。每種 Chat API 方法都需要進行使用者驗證 (代表使用者執行動作或存取資料) 或應用程式驗證 (能以 Chat 應用程式的形式執行動作或存取資料)。部分方法同時支援使用者驗證和應用程式驗證。

如要進一步瞭解 Chat 中的驗證作業,請參閱驗證總覽

API 資源和方法

REST 資源和方法可授予 Chat 聊天室、聊天室成員、訊息、訊息回應和訊息附件的非同步存取權。

聊天室

聊天室是使用者與應用程式對話並共用檔案的地方。空格分為幾種類型。即時訊息 (DM) 是兩個使用者或使用者與 Chat 應用程式之間的 1:1 對話。群組即時通訊是三位以上使用者與 Chat 應用程式之間的對話。已命名的聊天室是永久的存放空間,可供使用者傳送訊息、分享檔案及協同合作。

spaces 資源代表空格。

聊天室支援下列方法:

  • 建立空間,讓使用者和應用程式可以對其對話及分享檔案。
  • 設定聊天室以建立聊天室,然後將使用者和 Chat 應用程式新增至該聊天室。
  • 取得聊天室以查看聊天室的詳細資料。
  • 列出空格,即可查看經過分頁處理的可篩選空格清單。
  • 更新聊天室即可變更聊天室的屬性,例如使用者可見的顯示名稱、說明和規範。
  • 如果不再需要聊天室,請刪除空格
  • 尋找即時訊息 (DM) 以傳回兩個使用者之間的即時訊息,或是使用者與呼叫 Chat 應用程式之間的即時訊息。
成員

成員是指已加入或受邀加入聊天室的使用者和 Chat 應用程式。

spaces.members 資源代表成員。

計畫成員支援下列方法:

訊息

訊息包含張貼在聊天室中的文字卡片通訊。訊息可以附加檔案。 使用者可以為訊息加上表情符號來回應訊息。

spaces.messages 資源代表訊息。

「訊息」應用程式支援下列方法:

反應

「回應」代表使用者用來回應訊息的表情符號,例如 👍?、🚲?, 和 ♀。

spaces.messages.reactions 資源代表回應。

回應支援下列方法:

  • 建立回應以在訊息中附加表情符號。
  • 清單回應,查看以分頁方式對訊息的回應,並以分頁方式呈現回應。
  • 刪除回應即可從訊息中移除表情符號。
媒體與附件

「Media」代表上傳至 Google Chat 的檔案,例如圖片、影片和文件。

media 資源代表附加在訊息的媒體。

附件是附加媒體 (檔案) 的例項。

spaces.messages.attachments 資源代表連結。附件包含訊息中附加的媒體和相關中繼資料。

媒體和附件支援下列方法:

使用者讀取狀態 (開發人員預覽版)

使用者讀取狀態是一種單例模式資源,代表指定使用者在 Google Chat 聊天室或訊息討論串中的最後讀取訊息詳細資料。

users.spaces 資源代表使用者在聊天室中的讀取狀態。

users.spaces.threads 資源代表使用者在訊息執行緒中的讀取狀態。

使用者讀取狀態支援下列方法: