設定 Google Chat API

您建立的每個 Google Chat 應用程式都需要專屬的 Google Cloud 專案，並且已啟用及設定 Chat API。本頁面說明如何設定 Chat API。

必要條件

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

啟用 Chat API 時，您可以設定 Chat 應用程式在 Chat 中顯示給使用者的詳細資料，包括顯示名稱、顯示圖片和說明。這些詳細資料只會顯示在 Chat 中。如要將 Chat 應用程式發布至 Marketplace，您還必須指定 Chat 應用程式 Marketplace 資訊中顯示的詳細資料。

如要呼叫 Chat API，您必須設定 Google Chat 應用程式，並提供以下資訊：

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

Chat 應用程式的名稱、顯示圖片和說明會顯示在 Chat UI 中，供使用者查看。對於某些 Chat API 寫入要求，Chat 會使用這項資訊，將 Chat 應用程式在 Chat 中採取的動作歸因給該應用程式。

舉例來說，如果您呼叫 spaces.create() 方法，Chat 會在聊天室建立者說明中加入 Chat 應用程式名稱，如以下圖片所示：

Google Chat 應用程式為使用者建立聊天室。
圖 1. 使用 spaces.create() 方法代表使用者建立聊天室時，Chat 顯示的歸屬訊息。

如要與 Chat 應用程式互動，使用者也可以透過下列方式查看或使用這類資訊：

  • 透過 @提及 Chat 應用程式名稱來啟動該應用程式。
  • 使用 Chat 應用程式尋找並開始即時訊息對話。在「應用程式」選單中，即時訊息會顯示 Chat 應用程式的名稱和顯示圖片。
  • 使用者可透過撰寫列瀏覽 Chat 應用程式，並查看名稱、顯示圖片和說明。

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

取得 Chat 應用程式詳細資料後，請開啟 Cloud 專案並設定 Chat API：

  1. 在 Google Cloud 控制台中，前往 Chat API 頁面，然後按一下「Configuration」頁面：

    前往 Chat API 設定頁面

  2. 在「應用程式資訊」下方，填寫「應用程式名稱」、「顯示圖片網址」和「說明」欄位。

  3. 在「互動功能」下方，將「啟用互動功能」切換鈕切換為關閉位置，即可停用 Chat 應用程式的互動功能。您可以稍後再設定這項功能。如要瞭解如何設定及建構互動式功能，請參閱「接收及回應使用者互動」。

  4. 選用步驟：在「Logs」下方，選取「Log errors to Logging」核取方塊，即可使用 Google Cloud Logging。詳情請參閱「查詢 Chat 應用程式的錯誤記錄」。

  5. 按一下 [儲存]。

授予其他使用者設定 Chat API 的權限

您可以授予特定使用者 Google Cloud Identity and Access Management (IAM) 角色，具備這些角色的使用者無法透過「API 和服務」資訊主頁前往 Chat 應用程式設定頁面，但可以前往 Chat 應用程式主機 Cloud 專案的 Google Cloud 主控台，如以下所示：

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

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