本指南說明如何使用 Google Chat API 的 Space
資源中的 create()
方法,建立具名聊天室。
具名聊天室 (顯示 spaceType
圖示 SPACE
) 是用來傳送訊息、共用檔案及協作的空間。具名聊天室可包含 Chat 擴充應用程式。具名聊天室有聊天室管理員,可套用管理設定、說明,以及新增或移除使用者和應用程式。
如要建立不同類型的 Chat 聊天室 (包括即時訊息或群組訊息),請使用 Space
資源的 setUp()
方法建立聊天室,並同時新增成員。詳情請參閱「設定空間」一文。
建立具名聊天室後,只有經過驗證的使用者會成為聊天室成員。如要將成員加入聊天室,請針對要加入的每位使用者或應用程式,呼叫 Membership
資源的 create()
方法。或者,您可以使用 setUp()
方法建立具名空間,並同時新增成員。
必要條件
Node.js
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Python
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Java
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Apps Script
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 建立獨立的 Apps Script 專案,並開啟進階 Chat 服務。
- 在本指南中,您必須使用使用者或應用程式驗證。如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證。如需相關步驟,請參閱「以 Google Chat 擴充應用程式的身分驗證及授權」。
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
以使用者身分建立具名空間
如要建立具名的空間並驗證使用者,請在要求中傳遞下列項目:
- 指定
chat.spaces.create
或chat.spaces
授權範圍。 - 呼叫
CreateSpace()
方法,將space
做為Space
的執行個體傳遞,並包含下列欄位:spaceType
已設為SPACE
。displayName
設為使用者可見的空間名稱。- 視需要設定其他屬性,例如:
spaceDetails
- 聊天室的說明和規範,會向使用者顯示。predefinedPermissionSettings
:聊天室的預先定義權限。 舉例來說,您可以設定只有聊天室管理員或所有成員可以發布訊息。
如要建立具名空間,請按照下列步驟操作:
Node.js
Python
Java
Apps Script
以 Chat 應用程式建立具名的聊天室
應用程式驗證需要管理員核准一次。
如要邀請或新增使用者至具有應用程式驗證的空間,請在要求中傳遞下列項目:
- 指定
chat.app.spaces.create
或chat.app.spaces
授權範圍。 - 呼叫
Space
資源的create
方法。 - 將
spaceType
設為SPACE
。 - 將
displayName
設為使用者可見的空間名稱。在以下範例中,displayName
會設為API-made
。 - 使用
customer
欄位指定 Google Workspace 網域的客戶 ID。 - 視需要設定其他聊天室屬性,例如
spaceDetails
(使用者可見的說明和聊天室規範)。
建立 API 金鑰
如要呼叫開發人員預先發布版 API 方法,您必須使用非公開的開發人員預先發布版 API 探索文件。如要驗證要求,您必須傳遞 API 金鑰。
如要建立 API 金鑰,請開啟應用程式的 Google Cloud 專案,然後執行下列操作:
- 在 Google Cloud 控制台中,依序前往「選單」圖示 >「API 和服務」 >「憑證」。
- 依序按一下「建立憑證」>「API 金鑰」。
- 系統會顯示新的 API 金鑰。
- 按一下「複製」圖示 ,即可複製 API 金鑰,在應用程式的程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
- 按一下「限制金鑰」,即可更新進階設定並限制 API 金鑰的使用方式。詳情請參閱「套用 API 金鑰限制」一文。
編寫呼叫 Chat API 的指令碼
如要建立具名空間,請按照下列步驟操作:
Python
- 在工作目錄中,建立名為
chat_space_create_named_app.py
的檔案。 在
chat_space_create_named_app.py
中加入下列程式碼:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
在程式碼中,請替換下列項目:
API_KEY
:您建立的 API 金鑰,用於建構 Chat API 的服務端點。CUSTOMER
:空間網域的客戶 ID,格式為customer/{customer}
,其中{customer}
是ID
Admin SDK 客戶資源。如要在與 Chat 應用程式相同的 Google Workspace 機構中建立聊天室,請使用customers/my_customer
。
在工作目錄中,建構並執行範例:
python3 chat_space_create_named_app.py
在 Google Chat 中開啟聊天室
如要前往該空間,請使用空間的資源 ID 建構空間的網址。您可以在 Google Chat 回應主體中找到聊天室的資源 ID name
。舉例來說,如果聊天室的 name
為 spaces/1234567
,您可以使用下列網址前往該聊天室:https://mail.google.com/chat/u/0/#chat/space/1234567
。
限制和注意事項
- 使用應用程式驗證建立聊天室時,通過驗證的 Chat 應用程式會新增為聊天室成員,但與使用者驗證不同,不會新增為聊天室管理員。根據預設,所有聊天室成員都可以移除 Chat 應用程式。如要只允許聊天室管理員移除 Chat 應用程式,請將
permissionSettings.manageApps
設為managersAllowed
。