Java 快速入門導覽課程

快速入門說明如何設定及執行呼叫 Google Workspace API 的應用程式。

Google Workspace 快速入門會使用 API 用戶端程式庫處理驗證和授權流程的部分細節。建議您為自家應用程式使用用戶端程式庫。本快速入門導覽課程會使用簡化的驗證方法，適合測試環境使用。如要使用正式環境，建議您先瞭解驗證和授權，再選擇適合應用程式的存取憑證。

建立向 Google Keep API 提出要求的 Java 指令列應用程式。

目標

• 設定環境。
• 設定範例。
• 執行範例。

必要條件

• Java 1.8 以上版本。
• Gradle 7.0 以上版本。
• Google Cloud 專案。

• 已啟用 Google Keep 的 Google 帳戶。

設定環境

如要完成本快速入門課程，請設定環境。

啟用 API

使用 Google API 前，您必須先在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。

• 在 Google Cloud 控制台中啟用 Google Keep API。

  啟用 API

建立服務帳戶

服務帳戶是一種特殊的帳戶，由應用程式 (而非使用者) 所使用。您可以使用服務帳戶，透過機器人帳戶存取資料或執行動作，也可以代表 Google Workspace 或 Cloud Identity 使用者存取資料。詳情請參閱「瞭解服務帳戶」一文。

Google Cloud 控制台

1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) menu >「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。

   前往「Service Accounts」(服務帳戶) 頁面

2. 按一下「建立服務帳戶」。
3. 填寫服務帳戶詳細資料，然後按一下「建立並繼續」。
4. 選用：將角色指派給服務帳戶，授予 Google Cloud 專案資源的存取權。詳情請參閱「授予、變更及撤銷資源的存取權」。
5. 按一下「繼續」。
6. 選用：輸入可管理這個服務帳戶並執行相關動作的使用者或群組。詳情請參閱「管理服務帳戶模擬功能」。
7. 按一下「完成」，請記下服務帳戶的電子郵件地址。

gcloud CLI

1. 建立服務帳戶：

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
     --display-name="SERVICE_ACCOUNT_NAME"

2. 選用：將角色指派給服務帳戶，授予 Google Cloud 專案資源的存取權。詳情請參閱「授予、變更及撤銷資源的存取權」。

為服務帳戶建立憑證

您必須以公開/私密金鑰組的形式取得憑證。程式碼會使用這些憑證，在應用程式中授權服務帳戶的動作。

1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) menu >「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。

   前往「Service Accounts」(服務帳戶) 頁面

2. 選取服務帳戶。
3. 依序點選「金鑰」>「新增金鑰」>「建立新的金鑰」。
4. 選取「JSON」，然後按一下「建立」。

   系統會產生新的公開/私密金鑰組，並下載至您的電腦中做為新檔案。將下載的 JSON 檔案儲存為工作目錄中的 credentials.json。這個檔案是這組金鑰的唯一副本。如要瞭解如何安全儲存金鑰，請參閱「管理服務帳戶金鑰」。

5. 按一下「關閉」。

為服務帳戶設定全網域委派

如要代表 Google Workspace 機構中的使用者呼叫 API，您的服務帳戶必須由超級管理員帳戶在 Google Workspace 管理控制台中授予網域層級委派權限。詳情請參閱「將網域層級的權限委派給服務帳戶」。

1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) menu >「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。

   前往「Service Accounts」(服務帳戶) 頁面

2. 選取服務帳戶。
3. 按一下 [顯示進階設定]。
4. 在「全網域委派」下方，找出服務帳戶的「用戶端 ID」。按一下「複製」content_copy，將用戶端 ID 值複製到剪貼簿。

5. 如果您有相關 Google Workspace 帳戶的超級管理員存取權，請按一下「查看 Google Workspace 管理控制台」，然後使用超級管理員使用者帳戶登入，並繼續按照這些步驟操作。

   如果您沒有相關 Google Workspace 帳戶的超級管理員存取權，請與該帳戶的超級管理員聯絡，並將您的服務帳戶客戶端 ID 和 OAuth 範圍清單傳送給對方，讓對方在管理控制台中完成下列步驟。

1. 在 Google 管理控制台中，依序點選「選單」圖示 menu >「安全性」 >「存取權與資料控管」 >「API 控制項」。

   前往 API 控制項

2. 按一下「管理全網域委派設定」。
3. 點選「新增」。
4. 在「用戶端 ID」欄位中，貼上先前複製的用戶端 ID。
5. 在「OAuth 範圍」欄位中，輸入應用程式所需範圍的清單，並以半形逗號分隔。這與您在設定 OAuth 同意畫面時定義的範圍相同。
6. 按一下「授權」。

準備工作區

1. 在工作目錄中建立新的專案結構：

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. 在 src/main/resources/ 目錄中，複製先前下載的 credentials.json 檔案。

3. 開啟預設的 build.gradle 檔案，然後將內容替換為下列程式碼：

     apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'KeepQuickstart'
   sourceCompatibility = 1.8
   targetCompatibility = 1.8
   version = '1.0'
   
   sourceCompatibility = 1.8
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.api-client:google-api-client:1.23.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
       implementation 'com.google.apis:google-api-services-keep:v1-rev20210528-1.31.0'
   }
   

設定範例

1. 在 src/main/java/ 目錄中，建立新的 Java 檔案，其名稱必須與 build.gradle 檔案中的 mainClassName 值相符。

2. 在新 Java 檔案中加入下列程式碼：

   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.javanet.NetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.keep.v1.Keep;
   import com.google.api.services.keep.v1.model.Note;
   import com.google.api.services.keep.v1.model.Section;
   import com.google.api.services.keep.v1.model.TextContent;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Collections;
   import java.util.List;
   
   public class KeepQuickstart {
   
     private static final String APPLICATION_NAME = "Google Keep API Java Quickstart";
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
   
     /**
      * Global instance of the scopes required by this quickstart. If modifying these scopes, delete
      * your previously saved tokens/ folder.
      */
     private static final List<String> KEEP_SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/keep");
   
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Creates an authorized Credential object.
      *
      * @param HTTP_TRANSPORT The network HTTP Transport.
      * @return An authorized Credential object.
      * @throws IOException
      */
     private static Credential getOAuthCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = KeepQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (in == null) {
         throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));
   
       // Build flow and trigger user authorization request.
       GoogleAuthorizationCodeFlow flow =
           new GoogleAuthorizationCodeFlow.Builder(
                   HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, KEEP_SCOPES)
               .setDataStoreFactory(new FileDataStoreFactory(new java.io.File("tokens")))
               .setAccessType("offline")
               .build();
       LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
       return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
     }
   
     public static void main(String... args) throws IOException, GeneralSecurityException {
       // Build a new authorized API client service.
       final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
       Keep service =
           new Keep.Builder(HTTP_TRANSPORT, JSON_FACTORY, getOAuthCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
   
       Section noteBody =
           new Section().setText(new TextContent().setText("Finish preparations by tomorrow!"));
       Note newNote = new Note().setTitle("Customer call next week").setBody(noteBody);
   
       // Creates a new text note.
       service.notes().create(newNote).execute();
     }
   }
   
   

執行範例

1. 執行範例：

   gradle run
   

2. 第一次執行範例時，系統會提示您授權存取權：
   1. 如果尚未登入 Google 帳戶，請在系統提示時登入。如果您登入了多個帳戶，請選取要用於授權的帳戶。
   2. 然後點選 [Accept]。

   Java 應用程式會執行並呼叫 Google Keep API。

   授權資訊會儲存在檔案系統中，因此下次執行範例程式碼時，系統不會提示您授權。

後續步驟

• 排解驗證和授權問題
• Google Keep API 參考說明文件
• Java 適用的 Google API 用戶端程式庫說明文件
• Google Keep API Javadoc 說明文件