Краткое руководство по Java

В кратких руководствах объясняется, как настроить и запустить приложение, вызывающее API Google Workspace.

В кратких руководствах по Google Workspace клиентские библиотеки API используются для обработки некоторых деталей процесса аутентификации и авторизации. Мы рекомендуем вам использовать клиентские библиотеки для ваших собственных приложений. В этом кратком руководстве используется упрощенный подход к аутентификации, подходящий для среды тестирования. В производственной среде мы рекомендуем изучить аутентификацию и авторизацию, прежде чем выбирать учетные данные доступа , подходящие для вашего приложения.

Создайте приложение командной строки Java, которое отправляет запросы к API активности Google Диска.

Цели

• Настройте свою среду.
• Настройте образец.
• Запустите образец.

Предварительные условия

• Java 1.8 или выше.
• Gradle 7.0 или выше .
• Проект Google Cloud .

• Аккаунт Google.

Настройте свою среду

Чтобы завершить это краткое руководство, настройте свою среду.

Включить API

Прежде чем использовать API Google, вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

• В консоли Google Cloud включите API активности Google Диска.

  Включить API

Настройка экрана согласия OAuth

Если вы используете новый проект Google Cloud для выполнения этого краткого руководства, настройте экран согласия OAuth и добавьте себя в качестве тестового пользователя. Если вы уже выполнили этот шаг для своего облачного проекта, перейдите к следующему разделу.

1. В консоли Google Cloud выберите > API и службы > Экран согласия OAuth .

   Перейдите на экран согласия OAuth.

2. В качестве типа пользователя выберите «Внутренний» , затем нажмите «Создать» .
3. Заполните форму регистрации приложения, затем нажмите «Сохранить и продолжить» .

4. На данный момент вы можете пропустить добавление областей и нажать «Сохранить и продолжить» . В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний , а затем добавить области авторизации, необходимые вашему приложению.

5. Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .

Авторизация учетных данных для настольного приложения

Чтобы аутентифицировать конечных пользователей и получить доступ к пользовательским данным в вашем приложении, вам необходимо создать один или несколько идентификаторов клиентов OAuth 2.0. Идентификатор клиента используется для идентификации одного приложения на серверах Google OAuth. Если ваше приложение работает на нескольких платформах, вам необходимо создать отдельный идентификатор клиента для каждой платформы.

1. В консоли Google Cloud выберите > API и службы > Учетные данные .

   Перейти к учетным данным

2. Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth ».
3. Нажмите Тип приложения > Приложение для ПК .
4. В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
5. Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
6. Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
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 по умолчанию и замените его содержимое следующим кодом:

   диск/активность-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/ создайте новый файл Java с именем, соответствующим значению mainClassName в вашем файле build.gradle .

2. Включите следующий код в новый файл Java:

   диск/активность-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, войдите в систему, когда будет предложено. Если вы вошли в несколько учетных записей, выберите одну учетную запись, которая будет использоваться для авторизации.
   2. Нажмите Принять .

   Ваше Java-приложение запускается и вызывает API активности Google Диска.

   Информация об авторизации хранится в файловой системе, поэтому при следующем запуске примера кода вам не будет предложено авторизоваться.

Следующие шаги

• Устранение проблем с аутентификацией и авторизацией
• Справочная документация по API действий на диске
• Документация по клиенту API Google для Java
• Документация Javadoc по API активности Google Диска