快速入門導覽課程說明如何設定及執行會呼叫 Google Workspace API
Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫 驗證和授權流程的詳細資訊建議做法 您為自己的應用程式使用用戶端程式庫本快速入門導覽課程會使用 適合用於測試的簡易驗證方式 環境。在正式環境中,建議您瞭解 驗證與授權 再 選擇存取認證 挑選適合您應用程式的語言版本
建立 JavaScript 網頁應用程式,向 Google Docs API 提出要求。
目標
- 設定環境。
- 設定範例。
- 執行範例。
必要條件
- Node.js 與npm 已安裝。
- Google Cloud 專案。
- Google 帳戶
設定環境
如要完成本快速入門導覽課程,請設定環境。
啟用 API
您必須先在 Google Cloud 專案中啟用這些 Google API,才能使用這些 API。 您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中,啟用 Google Docs API。
設定 OAuth 同意畫面
如要使用新的 Google Cloud 專案完成本快速入門導覽課程,請設定 將自己新增為測試使用者。如果您已 為 Cloud 專案完成這個步驟,請直接跳到下一節。
- 在 Google Cloud 控制台中,前往「選單」圖示 > API 與服務 >「OAuth 同意畫面」。
- 在「使用者類型」部分選取「內部」,然後按一下「建立」。
- 填寫應用程式註冊表單,然後按一下「儲存並繼續」。
您現在可以略過新增範圍的步驟,然後按一下「儲存並繼續」。 日後您可以製作並使用應用程式 Google Workspace 機構,您必須將「使用者類型」變更為「外部」, 新增應用程式所需的授權範圍。
- 查看應用程式註冊摘要。如要修改資訊,請按一下「編輯」。如果應用程式 註冊看起來沒有問題,請按一下 [返回資訊主頁]。
授權網頁應用程式的憑證
如要驗證使用者及存取應用程式中的使用者資料,您必須: 建立一或多個 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。