快速入門導覽課程說明如何設定及執行呼叫 Google Workspace API 的應用程式。
Google Workspace 快速入門導覽課程使用 API 用戶端程式庫處理驗證和授權流程的一些詳細資料。建議您在自己的應用程式中使用用戶端程式庫。本快速入門導覽課程採用適用於測試環境的簡化驗證方法。如果是實際工作環境,建議先瞭解驗證與授權,再選擇適合應用程式的存取憑證。
建立 JavaScript 網頁應用程式向 Gmail API 發出要求。
目標
- 設定環境。
- 設定範例。
- 執行範例。
必要條件
- 已安裝 Node.js & npm。
- Google Cloud 專案。
- 已啟用 Gmail 的 Google 帳戶。
設定環境
如要完成本快速入門導覽課程,請設定環境。
啟用 API
使用 Google API 前,您必須在 Google Cloud 專案中啟用 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中啟用 Gmail 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」。
- 依序點選「應用程式類型」>「網頁應用程式」。
- 在「Name」(名稱) 欄位中,輸入憑證名稱。這個名稱只會顯示在 Google Cloud 控制台中。
- 新增與應用程式相關的授權 URI:
- 用戶端應用程式 (JavaScript):在「已授權的 JavaScript 來源」下方,按一下「新增 URI」。接著,輸入要用於瀏覽器要求的 URI。這會識別應用程式可將 API 要求傳送至 OAuth 2.0 伺服器的網域。
- 伺服器端應用程式 (Java、Python 等):在「已授權的重新導向 URI」下方,按一下「新增 URI」。接著輸入 OAuth 2.0 伺服器可將回應傳送至哪個端點 URI。
- 按一下「建立」,系統隨即會顯示 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 應用程式會執行並呼叫 Gmail API。