快速入門導覽課程說明如何設定及執行呼叫 Google Workspace API 的應用程式。
Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫,處理驗證和授權流程的部分細節。建議您為自己的應用程式採用用戶端程式庫。本快速入門導覽課程採用適用於測試環境的簡易驗證方法。如果是實際工作環境,建議您先瞭解驗證與授權,再選擇適合應用程式的存取憑證。
建立 Java 指令列應用程式,向 Google Vault API 提出要求。
目標
- 設定環境。
- 設定範例。
- 執行範例。
先備知識
- Java 1.8 以上版本。
- Gradle 7.0 以上版本。
- Google Cloud 專案。
- Google 帳戶。
設定環境
如要完成本快速入門導覽課程,請設定環境。
啟用 API
使用 Google API 前,您必須先在 Google Cloud 專案中啟用 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。在 Google Cloud 控制台中,啟用 Google Vault 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 控制台中。
- 按一下「建立」,系統隨即會顯示已建立 OAuth 用戶端的畫面,並顯示您的新用戶端 ID 和用戶端密鑰。
- 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。
- 將下載的 JSON 檔案儲存為
credentials.json
,然後將檔案移至工作目錄。
準備工作區
在工作目錄中建立新的專案結構:
gradle init --type basic mkdir -p src/main/java src/main/resources
在
src/main/resources/
目錄中,複製先前下載的credentials.json
檔案。開啟預設的
build.gradle
檔案,將其內容替換為以下程式碼:
設定範例
在
src/main/java/
目錄中,使用與build.gradle
檔案中的mainClassName
值相符的名稱建立新的 Java 檔案。在您的新的 Java 檔案中加入下列程式碼:
執行範例
執行範例:
gradle run
-
第一次執行範例時,系統會提示您授予存取權:
- 如果尚未登入 Google 帳戶,請在系統提示時登入。如果您登入了多個帳戶,請選取一個要用於授權的帳戶。
- 然後點選 [Accept]。
您的 Java 應用程式會執行並呼叫 Google Vault API。
授權資訊會儲存在檔案系統中,因此下次執行程式碼範例時,系統不會提示授權。