快速入門說明如何設定及執行呼叫 Google Workspace API 的應用程式。
Google Workspace 快速入門會使用 API 用戶端程式庫處理驗證和授權流程的部分細節。建議您為自家應用程式使用用戶端程式庫。本快速入門導覽課程會使用簡化的驗證方法,適合測試環境使用。在正式環境中,建議您瞭解 驗證與授權 再 選擇存取認證 挑選適合您應用程式的語言版本
撰寫 Google Apps Script 這個 API 會向 Google Chat API 發出要求。
目標
- 設定環境。
- 建立並設定指令碼。
- 執行指令碼。
必要條件
- 可存取 Google Chat 的 Google Workspace Business 或 Enterprise 帳戶。
設定 Cloud 專案
以新 Google Cloud 專案完成本快速入門導覽課程: ,然後將自己新增為測試使用者。如果您已為 Cloud 專案完成這些步驟,請跳至下一節。
在 Google Cloud 控制台中開啟 Cloud 專案
如果尚未開啟,請開啟要用於本範例的 Cloud 專案:
- 在 Google Cloud 控制台中,前往「選取專案」頁面。
- 選取要使用的 Google Cloud 專案。或者,按一下「建立專案」,然後按照畫面上的指示操作。如要建立 Google Cloud 專案,您可能需要開啟該專案的計費功能。
開啟 Chat API
使用 Google API 前,您必須先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中,啟用 Google Chat API。
設定 OAuth 同意畫面
- 在 Google Cloud 控制台中,依序前往「選單」>「API 和服務」 >「OAuth 同意畫面」。
- 在「使用者類型」部分選取「內部」,然後按一下「建立」。
- 填寫應用程式註冊表單,然後按一下「Save and Continue」。
您現在可以略過新增範圍的步驟,然後按一下「儲存並繼續」。 日後您可以製作並使用應用程式 Google Workspace 機構,您必須將「使用者類型」變更為「外部」, 新增應用程式所需的授權範圍。
- 查看應用程式註冊摘要。如要修改資訊,請按一下「編輯」。如果應用程式註冊看起來沒問題,請按一下「返回資訊主頁」。
設定 Google Chat 應用程式
如要呼叫 Google Chat API,您必須設定 Google Chat 應用程式。對於任何寫入要求,Google Chat 會使用下列資訊,在 UI 中歸屬 Google Chat 應用程式。
在 Google Cloud 控制台中,前往「Chat API 設定」頁面:
在「Application info」(應用程式資訊) 下方輸入下列資訊:
- 在「App name」(應用程式名稱) 欄位中輸入
Chat API quickstart app
。 - 在「顯示圖片」欄位中輸入
https://developers.google.com/chat/images/quickstart-app-avatar.png
。 - 在「Description」欄位中輸入
Quickstart for calling the Chat API
。
- 在「App name」(應用程式名稱) 欄位中輸入
在「互動功能」下方,按一下「啟用互動功能」。 切換至關閉位置,即可停用 Chat 應用程式。
按一下 [儲存]。
建立指令碼
- 前往 script.google.com/create 建立新指令碼。
- 使用下列程式碼取代指令碼編輯器的內容:
- 按一下 [儲存 ]。
- 按一下「無標題的專案」,輸入「Quickstart」,然後點選「Rename」。
設定指令碼
複製 Cloud 專案編號
- 在 Google Cloud 控制台中,前往「選單」圖示 > IAM 與管理員 >「設定」。
- 複製「Project number」欄位中的值。
連結 Google Cloud 專案
- 開啟 Apps Script 專案。
- 按一下「Project Settings」圖示 。
- 在「Google Cloud Platform (GCP) Project」(Google Cloud Platform (GCP) 專案) 下方,按一下 [變更專案]。
- 在「GCP 專案編號」中,貼上 Google Cloud 專案編號。
- 按一下「設定專案」。
啟用 Google Chat API
- 開啟 Apps Script 專案。
- 按一下「專案設定」圖示 。
- 啟用「一般設定」下方的「顯示 appsscript.json」資訊清單檔案 在編輯器中新增
- 按一下「Editor」圖示
appscript.json
,然後將內容替換為以下程式碼:
,然後選取
檔案
執行範例
在 Apps Script 編輯器中,按一下「執行」。
第一次執行範例時,系統會提示您授予存取權:
- 按一下「查看權限」。
- 選擇所需帳戶。
- 按一下「允許」。
指令碼的執行記錄會顯示在視窗底部。