快速入門導覽課程說明如何設定及執行呼叫 Google Workspace API 的應用程式。
Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫,處理驗證和授權流程的部分細節。建議您為自己的應用程式採用用戶端程式庫。本快速入門導覽課程採用適用於測試環境的簡易驗證方法。如果是實際工作環境,建議您先瞭解驗證與授權,再選擇適合應用程式的存取憑證。
建立 JavaScript 網頁應用程式,向 Google Docs API 提出要求。
目標
- 設定環境。
- 設定範例。
- 執行範例。
先備知識
- 已安裝 Node.js 與 npm。
- Google Cloud 專案。
- Google 帳戶
設定環境
如要完成本快速入門導覽課程,請設定環境。
啟用 API
使用 Google API 前,您必須先在 Google Cloud 專案中啟用 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中,啟用 Google Docs API。
設定 OAuth 同意畫面
如果您使用新的 Google Cloud 專案完成本快速入門導覽課程,請設定 OAuth 同意畫面,並將自己新增為測試使用者。如果您已經為 Cloud 專案完成這個步驟,請跳到下一部分。
- 在 Google Cloud 控制台中,依序前往「選單」圖示 >「API 和服務」>「OAuth 同意畫面」。
- 在「使用者類型」部分選取「內部」,然後按一下「建立」。
- 填寫應用程式註冊表單,然後按一下「儲存並繼續」。
您現在可以略過新增範圍的步驟,然後按一下「儲存並繼續」。 日後建立要在 Google Workspace 機構外部使用的應用程式時,您必須將「使用者類型」變更為「外部」,再新增應用程式所需的授權範圍。
- 查看應用程式註冊摘要。如要修改資訊,請按一下「編輯」。如果應用程式註冊正確無誤,請按一下「Back to Dashboard」(返回資訊主頁)。
授權網頁應用程式的憑證
如要驗證使用者及存取應用程式中的使用者資料,您必須建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用於向 Google 的 OAuth 伺服器識別單一應用程式。如果您的應用程式在多個平台上執行,就必須為每個平台分別建立用戶端 ID。- 在 Google Cloud 控制台中,依序前往「選單」圖示 >「API 和服務」>「憑證」>
- 依序點選「建立憑證」>「OAuth 用戶端 ID」。
- 依序點選「應用程式類型」>「網頁應用程式」。
- 在「名稱」欄位中輸入憑證的名稱。這個名稱只會顯示在 Google Cloud 控制台中。
- 新增與應用程式相關的已授權 URI:
- 用戶端應用程式 (JavaScript):按一下「授權的 JavaScript 來源」下方的「新增 URI」。然後輸入瀏覽器要求的 URI。可識別應用程式可以從哪些網域傳送 API 要求至 OAuth 2.0 伺服器。
- 伺服器端應用程式 (Java、Python 等):按一下「已授權的重新導向 URI」下方的「新增 URI」。然後輸入端點 URI,讓 OAuth 2.0 伺服器傳送回應。
- 按一下「建立」,畫面上會顯示 OAuth 用戶端建立的畫面,其中顯示新的用戶端 ID 和用戶端密鑰。
記下用戶端 ID。用戶端密碼不適用於網頁應用程式,
- 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。
請記下這些憑證,因為本快速入門導覽課程稍後會用到。
建立 API 金鑰
- 在 Google Cloud 控制台中,依序點選「選單」圖示 >「API 和服務」>「憑證」>
- 依序按一下「建立憑證」>「API 金鑰」。
- 畫面上會顯示新的 API 金鑰。
- 按一下「複製」圖示 ,即可複製 API 金鑰,以便用於應用程式的程式碼。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
- 按一下「限制金鑰」,即可更新進階設定並限制 API 金鑰的使用情形。詳情請參閱「套用 API 金鑰限制」一節。
設定範例
- 在工作目錄中,建立名為
index.html
的檔案。 在
index.html
檔案中,貼上下列程式碼:更改下列內容:
YOUR_CLIENT_ID
:您在網頁應用程式的授權憑證時建立的用戶端 ID。YOUR_API_KEY
:您所建立的 API 金鑰,做為必備條件。
執行範例
在工作目錄中,安裝 http-server 套件:
npm install http-server
在工作目錄中啟動網路伺服器:
npx http-server -p 8000
- 透過瀏覽器前往
http://localhost:8000
。 -
系統會提示您授予存取權:
- 如果尚未登入 Google 帳戶,請在系統提示時登入。如果您登入了多個帳戶,請選取一個要用於授權的帳戶。
- 然後點選 [Accept]。
您的 JavaScript 應用程式會執行並呼叫 Google Docs API。