Java のクイックスタート

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。

Google Workspace クイックスタートでは、API クライアント ライブラリを使用して認証と認可フローの詳細を処理します。独自のアプリではクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡略化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について確認することをおすすめします。

Google Drive Activity API にリクエストを送信する Java コマンドライン アプリケーションを作成します。

目標

• 環境を設定する。
• サンプルをセットアップします。
• サンプルを実行します。

前提条件

• Java 1.8 以降。
• Gradle 7.0 以降。
• Google Cloud プロジェクト。

• Google アカウント

環境を設定する

このクイックスタートを完了するには、環境を設定します。

API を有効にする

Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

• Google Cloud コンソールで、Google Drive Activity API を有効にします。

  API を有効にする

OAuth 同意画面を構成する

新しい Google Cloud プロジェクトを使用してこのクイックスタートを完了するには、OAuth 同意画面を構成して、自分自身をテストユーザーとして追加します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。

1. Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。

   OAuth 同意画面に移動

2. [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
3. アプリ登録フォームに入力し、[保存して次へ] をクリックします。

4. 現時点では、スコープの追加をスキップして、[Save and Continue] をクリックします。今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更してから、アプリに必要な認証スコープを追加する必要があります。

5. アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリ登録に問題がない場合は、[Back to Dashboard] をクリックします。

デスクトップ アプリケーションの認証情報を承認する

エンドユーザーを認証し、アプリ内でユーザーデータにアクセスするには、1 つ以上の 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

   GitHub で表示

   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

   GitHub で表示

   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
   

2. サンプルを初めて実行すると、アクセスの承認を求められます。
   1. Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、認証に使用するアカウントを 1 つ選択してください。
   2. [Accept] をクリックします。

   Java アプリケーションが Google Drive Activity API を実行し、呼び出します。

   認可情報はファイル システムに保存されるため、サンプルコードを次回実行するときに、認可を求められません。

次のステップ

• 認証と認可に関する問題のトラブルシューティング
• Drive Activity API のリファレンス ドキュメント
• Java 用 Google API クライアントのドキュメント
• Google Drive Activity API Javadoc ドキュメント