設定 Google Chat API

您建立的每個 Google Chat 應用程式都必須具備專屬的 已啟用 Chat API 的 Google Cloud 專案。這個頁面 ,示範如何設定 Chat API

必要條件

選擇 Chat 應用程式的顯示名稱、顯示圖片和說明

如要呼叫 Chat API,您必須設定 含有下列資訊的 Google Chat 應用程式:

欄位 說明 格式
應用程式名稱 Chat 應用程式的顯示名稱。 最多 25 個英數字元
顯示圖片網址 做為 Chat 應用程式使用者 顯示圖片。 指向正方形圖形圖片 (PNG 或 JPEG) 的 HTTPS 網址。 建議大小至少為 256 x 256 像素。
說明 簡短說明 Chat 應用程式。 最多 40 個英數字元

Chat 應用程式的名稱、顯示圖片和說明: 向 Chat 使用者顯示。適用於某些 Chat API 寫入要求,Chat 會使用這項資訊 以及 Chat 應用程式在 Chat 中執行的動作

舉例來說,如果您呼叫 spaces.create() 方法,系統會傳送 Chat 也會加入 Chat 擴充應用程式的名稱 聊天室建立者的說明,如下圖所示:

Google Chat 應用程式會為使用者建立聊天室。
圖 1. Chat 的歸因訊息 使用 spaces.create() 方法建立 儲存空間

如要與 Chat 擴充應用程式互動,使用者也可以查看或使用這個應用程式 以下列方式獲取資訊:

  • 使用 @號提及 Chat 應用程式的名稱即可叫用 Chat 應用程式。
  • 在 Chat 應用程式中尋找並發起即時訊息。 在「應用程式」選單中,即時訊息會顯示 Chat 應用程式的名稱和顯示圖片。
  • 在撰寫列中,使用者可以瀏覽 Chat 擴充應用程式,並查看 包括名稱、顯示圖片和說明

在 Google Cloud 控制台中設定 Chat 應用程式

取得 Chat 應用程式詳細資料後,請開啟 在 Cloud 專案中設定 Chat API:

  1. 前往 Google Cloud 控制台中的「Chat API」頁面,然後按一下 「Configuration」(設定) 頁面:

    前往 Chat API 設定頁面

  2. 在「應用程式資訊」下方,填入「應用程式名稱」、「顯示圖片網址」。 和「Description」欄位

  3. 在「互動功能」下方,按一下「啟用互動功能」切換按鈕 即可停用 Chat 應用程式。你可以稍後再設定。如要瞭解 設定及建構互動功能,請參閱 接收及回覆使用者互動

  4. 選用:勾選「記錄檔」下的「將錯誤記錄到 Logging」核取方塊,然後 請使用 Google Cloud Logging若需更多資訊,請參閲 查詢 Chat 擴充應用程式的錯誤記錄

  5. 按一下 [儲存]

授權他人設定 Chat 擴充應用程式

你可以 授予特定使用者存取權 前往 Chat 應用程式設定頁面。使用 Chat 應用程式擁有者Chat 應用程式檢視者 IAM 角色。具備這些角色的使用者無法瀏覽 Chat 應用程式 API 和「服務」資訊主頁,但可以 請前往 Google Cloud 控制台 Chat 應用程式的主專案,如下所示:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

其中 PROJECT_ID 是 託管 Chat 應用程式的 Google Cloud 專案。