本指南說明如何在 Google Chat API 的 Space
資源上使用 create()
方法,建立命名空間。
Space
資源代表使用者和 Chat 應用程式可用於傳送訊息、共用檔案及協作的空間。聊天室分為以下幾種類型:
- 即時訊息 (DM) 是指兩位使用者或使用者與 Chat 應用程式之間的對話。
- 群組通訊是指三位以上使用者與 Chat 應用程式之間的對話。
- 命名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案和協作。
已命名空間是使用者可以傳送訊息、分享檔案及協同合作的空間。命名聊天室可包含 Chat 應用程式。已命名聊天室包含未命名的群組對話和即時訊息沒有的額外功能,例如聊天室管理員,可以套用管理設定、說明,以及新增或移除使用者和應用程式。建立具名聊天室後,聊天室唯一的成員是通過驗證的使用者。聊天室不包含其他使用者或應用程式,甚至連建立聊天室的 Chat 應用程式也不例外。如要在聊天室中新增成員,請參閱「建立成員資格」。
如要建立包含多位成員的已命名聊天室 (例如三位以上的未命名群組通訊,或兩位使用者與呼叫 Chat API 的即時通訊應用程式進行即時訊息對話),請改為設定聊天室。
必要條件
Node.js
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 使用 Chat 應用程式的名稱、圖示和說明啟用並設定 Google Chat API。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中進行驗證的方式,建立存取憑證:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分進行驗證, 選擇授權範圍。
Python
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分驗證, 選擇授權範圍。
Java
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分進行驗證, 選擇授權範圍。
Apps Script
- 具備 Google Chat 存取權的 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 金鑰
如要呼叫 Developer Preview API 方法,您必須使用 API 探索文件非公開的開發人員預覽版本。如要驗證要求,您必須傳遞 API 金鑰。
如要建立 API 金鑰,請開啟應用程式的 Google Cloud 專案,然後執行下列操作:
- 在 Google Cloud 控制台中,依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。
- 依序按一下「建立憑證」>「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
:您為建構 Chat API 服務端點而建立的 API 金鑰。CUSTOMER
:以customer/{customer}
格式表示的空間網域客戶 ID,其中{customer}
是 Admin SDK 客戶資源中的ID
。如要在與 Chat 應用程式相同的 Google Workspace 機構中建立聊天室,請使用customers/my_customer
。
在工作目錄中建構並執行範例:
python3 chat_space_create_named_app.py
在 Google Chat 中開啟聊天室
如要前往聊天室,請使用聊天室的資源 ID 建構聊天室網址。您可以在 Google Chat 回應主體中找到聊天室 name
的資源 ID。舉例來說,如果聊天室的 name
是 spaces/1234567
,您可以使用以下網址前往聊天室:https://mail.google.com/chat/u/0/#chat/space/1234567
。
相關主題
- 建立成員,將使用者和應用程式新增至聊天室。
- 建立訊息,在聊天室中張貼訊息。
- 取得聊天室詳細資料。
- 列出聊天室。
- 更新聊天室。
- 刪除聊天室。
- 設定聊天室。
- 尋找即時訊息聊天室。
- 讓特定使用者可自由加入聊天室。