本指南將說明如何使用
setUp()
方法,Space
有關設定 Google Chat 的 Google Chat API 資源
空白鍵。設定聊天室會建立聊天室,並將指定使用者加入其中。
Space
資源代表使用者和 Chat 應用程式可用於傳送訊息、共用檔案和協作的空間。聊天室分為以下幾種類型:
- 即時訊息 (DM) 是指兩位使用者或使用者與 Chat 應用程式之間的對話。
- 群組通訊是 3 位以上使用者的對話, Chat 擴充應用程式。
- 命名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案和協作。
設定聊天室時,請考量下列事項:
- 呼叫端 (已驗證) 使用者會自動加入聊天室,因此您不需要在要求中指定使用者的會員資格。
- 建立即時訊息 (DM) 時,如果兩位使用者之間存在即時訊息 系統便會傳回即時訊息否則系統會建立即時訊息。
- 建立群組即時通訊時 (如果要求中未提供任何成員資格) 已成功加入群組通訊 (例如權限問題),然後 系統可能會建立空白的群組通訊 (包括僅限通話的使用者)。
- 您無法設定有回覆串的聊天室,也無法新增 Google Workspace 以外的使用者。
- 在要求中提供的重複會員資格 (包括呼叫使用者) 會遭到篩除,而不會導致要求錯誤。
必要條件
Node.js
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Node.js Cloud 用戶端程式庫。
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要執行本指南中的範例,請將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至本機目錄。
- 選擇支援使用者驗證的授權範圍。
Python
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Python Cloud 用戶端程式庫。
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例
指引,將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至 本機目錄
- 選擇支援使用者驗證的授權範圍。
Java
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
-
為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例
指引,將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至 本機目錄
- 選擇支援使用者驗證的授權範圍。
Apps Script
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境: 如要瞭解設定環境的步驟,請完成這個快速入門。
- 選擇支援使用者驗證的授權範圍。
設定聊天室
如要設定聊天室,請在要求中傳遞以下內容:
- 指定
chat.spaces.create
或chat.spaces
授權範圍。 - 呼叫
SetUpSpace()
方法。 - 將
space
傳遞為Space
的例項,並附上所有必要欄位,例如displayName
或spaceType
。 - 將
memberships
做為以下陣列傳遞:Membership
執行個體。請針對每個執行個體執行下列操作:- 指定
users/{user}
即可將真人使用者新增為聊天室成員,其中{user}
是person
的{person_id}
從 People API 擷取的 IDuser
。舉例來說,如果 People API 使用者resourceName
是people/123456789
,您可以加入會員,並將users/123456789
設為member.name
,藉此將使用者加入聊天室。 - 指定
groups/{group}
即可將群組新增為聊天室成員,其中{group}
是您要建立成員資格的群組 ID。群組 ID 可透過 Cloud Identity API。 舉例來說, Cloud Identity API 會傳回名為groups/123456789
的群組,然後設定membership.groupMember.name
到groups/123456789
。無法新增 Google 網路論壇 系統會將你加入群組通訊或即時訊息,但只會在已命名的聊天室中加入。
- 指定
如要在發出呼叫的使用者和其他真人使用者之間建立即時訊息,請指定 您要求中非真人使用者的成員資格
如要在發起通話的使用者和通話應用程式之間建立即時訊息,請設定
space.singleUserBotDm
變更為 true
,而且不指定任何成員資格。您只能使用這個方法,透過呼叫應用程式設定私訊。如要將呼叫應用程式新增為空間的成員,或新增兩位使用者之間現有的私訊,請參閱「建立會員資格」一文。
以下範例會建立命名空間,並為兩位使用者 (已驗證使用者和其他使用者) 建立一個會員資格。
Node.js
Python
Java
Apps Script
如要執行範例,請替換以下內容:
DISPLAY_NAME
:新空間的顯示名稱。USER_NAME
:要加入其他使用者的 ID 會員。
如要前往聊天室,請使用聊天室的資源 ID 建構聊天室網址。您可以從 Google Chat 回應內容中的聊天室 name
取得資源 ID。舉例來說,如果聊天室的 name
為 spaces/1234567
,您可以使用以下網址前往聊天室:https://mail.google.com/chat/u/0/#chat/space/1234567
。
相關主題
- 建立聊天室。
- 取得聊天室的詳細資料。
- 列出聊天室。
- 更新聊天室。
- 刪除聊天室。
- 尋找即時訊息聊天室。
- 讓特定使用者可發現聊天室。