Java 快速入門導覽課程

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

Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫，處理驗證和授權流程的一些細節。建議您針對自己的應用程式使用用戶端程式庫。本快速入門導覽課程採用適用於測試環境的簡化驗證方式。對於實際工作環境，建議您先瞭解驗證和授權，再選擇應用程式適用的存取憑證。

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

目標

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

必要條件

  • Google 帳戶。

設定環境

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

啟用 API

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

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

    啟用 API

如果您使用新的 Google Cloud 專案來完成本快速入門導覽課程，請設定 OAuth 同意畫面，然後將您自己新增為測試使用者。如果您已完成 Cloud 專案的這個步驟，請跳到下一節。

  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「OAuth 同意畫面」。

    前往 OAuth 同意畫面

  2. 在「使用者類型」部分，選取「內部」，然後按一下「建立」。
  3. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。

  4. 目前，您可以略過新增範圍，然後按一下「儲存並繼續」。日後建立用於 Google Workspace 機構外部的應用程式時，必須將「使用者類型」變更為「外部」，然後新增應用程式所需的授權範圍。

  5. 查看您的應用程式註冊摘要。如要變更，請按一下「編輯」。如果應用程式註冊正確無誤，請按一下「Back to Dashboard」(返回資訊主頁)。

為桌面應用程式授權憑證

如要驗證使用者並存取應用程式中的使用者資料，您必須建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用來向 Google 的 OAuth 伺服器識別單一應用程式。如果您的應用程式是在多個平台上執行，您就必須為每個平台建立個別的用戶端 ID。
  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「憑證」。

    前往「憑證」頁面

  2. 依序按一下「建立憑證」>「OAuth 用戶端 ID」。
  3. 依序按一下「應用程式類型」>「電腦版應用程式」。
  4. 在「名稱」欄位中，輸入憑證名稱。這個名稱只會顯示在 Google Cloud 控制台中。
  5. 按一下「建立」，畫面上會顯示 OAuth 用戶端已建立的畫面，顯示您的新用戶端 ID 與用戶端密鑰。
  6. 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」下方。
  7. 將下載的 JSON 檔案儲存為 credentials.json，然後將檔案移至工作目錄。

準備工作區

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

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

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

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

    drive/activity-v2/quickstart/build.gradle
    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'DriveActivityQuickstart'
sourceCompatibility = 11
targetCompatibility = 11
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.api-client:google-api-client:2.0.0'
    implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
    implementation 'com.google.apis:google-api-services-driveactivity:v2-rev20220926-2.0.0'
}

設定範例

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

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

    drive/activity-v2/quickstart/src/main/java/DriveActivityQuickstart.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.HttpTransport;
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.driveactivity.v2.DriveActivityScopes;
import com.google.api.services.driveactivity.v2.model.*;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.AbstractMap;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.stream.Collectors;

public class DriveActivityQuickstart {
  /**
   * Application name.
   */
  private static final String APPLICATION_NAME = "Drive Activity API Java Quickstart";

  /**
   * Directory to store authorization tokens for this application.
   */
  private static final java.io.File DATA_STORE_DIR = new java.io.File("tokens");
  /**
   * Global instance of the JSON factory.
   */
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  /**
   * Global instance of the scopes required by this quickstart.
   *
   * <p>If modifying these scopes, delete your previously saved tokens/ folder.
   */
  private static final List<String> SCOPES =
      Arrays.asList(DriveActivityScopes.DRIVE_ACTIVITY_READONLY);
  private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
  /**
   * Global instance of the {@link FileDataStoreFactory}.
   */
  private static FileDataStoreFactory DATA_STORE_FACTORY;
  /**
   * Global instance of the HTTP transport.
   */
  private static HttpTransport HTTP_TRANSPORT;

  static {
    try {
      HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
      DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
    } catch (Throwable t) {
      t.printStackTrace();
      System.exit(1);
    }
  }

  /**
   * Creates an authorized Credential object.
   *
   * @return an authorized Credential object.
   * @throws IOException
   */
  public static Credential authorize() throws IOException {
    // Load client secrets.
    InputStream in = DriveActivityQuickstart.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, SCOPES)
            .setDataStoreFactory(DATA_STORE_FACTORY)
            .setAccessType("offline")
            .build();
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver())
            .authorize("user");
    System.out.println("Credentials saved to " + DATA_STORE_DIR.getAbsolutePath());
    return credential;
  }

  /**
   * Build and return an authorized Drive Activity client service.
   *
   * @return an authorized DriveActivity client service
   * @throws IOException
   */
  public static com.google.api.services.driveactivity.v2.DriveActivity getDriveActivityService()
      throws IOException {
    Credential credential = authorize();
    com.google.api.services.driveactivity.v2.DriveActivity service =
        new com.google.api.services.driveactivity.v2.DriveActivity.Builder(
            HTTP_TRANSPORT, JSON_FACTORY, credential)
            .setApplicationName(APPLICATION_NAME)
            .build();
    return service;
  }

  public static void main(String[] args) throws IOException {
    // Build a new authorized API client service.
    com.google.api.services.driveactivity.v2.DriveActivity service = getDriveActivityService();

    // Print the recent activity in your Google Drive.
    QueryDriveActivityResponse result =
        service.activity().query(new QueryDriveActivityRequest().setPageSize(10)).execute();
    List<DriveActivity> activities = result.getActivities();
    if (activities == null || activities.size() == 0) {
      System.out.println("No activity.");
    } else {
      System.out.println("Recent activity:");
      for (DriveActivity activity : activities) {
        String time = getTimeInfo(activity);
        String action = getActionInfo(activity.getPrimaryActionDetail());
        List<String> actors =
            activity.getActors().stream()
                .map(DriveActivityQuickstart::getActorInfo)
                .collect(Collectors.toList());
        List<String> targets =
            activity.getTargets().stream()
                .map(DriveActivityQuickstart::getTargetInfo)
                .collect(Collectors.toList());
        System.out.printf(
            "%s: %s, %s, %s\n", time, truncated(actors), action, truncated(targets));
      }
    }
  }

  /**
   * Returns a string representation of the first elements in a list.
   */
  private static String truncated(List<String> array) {
    return truncatedTo(array, 2);
  }

  /**
   * Returns a string representation of the first elements in a list.
   */
  private static String truncatedTo(List<String> array, int limit) {
    String contents = array.stream().limit(limit).collect(Collectors.joining(", "));
    String more = array.size() > limit ? ", ..." : "";
    return "[" + contents + more + "]";
  }

  /**
   * Returns the name of a set property in an object, or else "unknown".
   */
  private static <T> String getOneOf(AbstractMap<String, T> obj) {
    Iterator<String> iterator = obj.keySet().iterator();
    return iterator.hasNext() ? iterator.next() : "unknown";
  }

  /**
   * Returns a time associated with an activity.
   */
  private static String getTimeInfo(DriveActivity activity) {
    if (activity.getTimestamp() != null) {
      return activity.getTimestamp();
    }
    if (activity.getTimeRange() != null) {
      return activity.getTimeRange().getEndTime();
    }
    return "unknown";
  }

  /**
   * Returns the type of action.
   */
  private static String getActionInfo(ActionDetail actionDetail) {
    return getOneOf(actionDetail);
  }

  /**
   * Returns user information, or the type of user if not a known user.
   */
  private static String getUserInfo(User user) {
    if (user.getKnownUser() != null) {
      KnownUser knownUser = user.getKnownUser();
      Boolean isMe = knownUser.getIsCurrentUser();
      return (isMe != null && isMe) ? "people/me" : knownUser.getPersonName();
    }
    return getOneOf(user);
  }

  /**
   * Returns actor information, or the type of actor if not a user.
   */
  private static String getActorInfo(Actor actor) {
    if (actor.getUser() != null) {
      return getUserInfo(actor.getUser());
    }
    return getOneOf(actor);
  }

  /**
   * Returns the type of a target and an associated title.
   */
  private static String getTargetInfo(Target target) {
    if (target.getDriveItem() != null) {
      return "driveItem:\"" + target.getDriveItem().getTitle() + "\"";
    }
    if (target.getDrive() != null) {
      return "drive:\"" + target.getDrive().getTitle() + "\"";
    }
    if (target.getFileComment() != null) {
      DriveItem parent = target.getFileComment().getParent();
      if (parent != null) {
        return "fileComment:\"" + parent.getTitle() + "\"";
      }
      return "fileComment:unknown";
    }
    return getOneOf(target);
  }
}

執行範例

  1. 執行範例：

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

    您的 Java 應用程式會執行並呼叫 Google Drive Activity API，

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

後續步驟