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

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

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

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

Цели

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

Предпосылки

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

• Учетная запись Google с включенным Google Keep.

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

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

Включить API

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

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

  Включить API

Создать учетную запись службы

Учётная запись службы — это особый тип учётной записи, используемый приложением, а не пользователем. Вы можете использовать учётную запись службы для доступа к данным или выполнения действий с учётной записью робота, а также для доступа к данным от имени пользователей Google Workspace или Cloud Identity. Подробнее см. в разделе «Общие сведения об учётных записях службы» .

Консоль Google Cloud

1. В консоли Google Cloud перейдите в menu > IAM и администрирование > Учетные записи служб .

   Перейти к учетным записям служб

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 > IAM и администрирование > Учетные записи служб .

   Перейти к учетным записям служб

2. Выберите свою учетную запись службы.
3. Нажмите Ключи > Добавить ключ > Создать новый ключ .
4. Выберите JSON , затем нажмите Создать .

   Ваша новая пара открытого и закрытого ключей будет сгенерирована и загружена на ваш компьютер в виде нового файла. Сохраните загруженный JSON-файл как credentials.json в вашем рабочем каталоге. Этот файл — единственная копия данного ключа. Сведения о безопасном хранении ключа см. в разделе Управление ключами учётной записи службы .

5. Нажмите «Закрыть» .

Настройте делегирование на уровне домена для учетной записи службы

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

1. В консоли Google Cloud перейдите в menu > IAM и администрирование > Учетные записи служб .

   Перейти к учетным записям служб

2. Выберите свою учетную запись службы.
3. Нажмите Показать дополнительные настройки .
4. В разделе «Делегирование на уровне домена» найдите «Идентификатор клиента» вашей учётной записи службы. Нажмите «Копировать content_copy , чтобы скопировать значение идентификатора клиента в буфер обмена.

5. Если у вас есть права суперадминистратора к соответствующей учетной записи Google Workspace, нажмите «Просмотреть консоль администратора Google Workspace» , затем войдите в систему, используя учетную запись суперадминистратора, и продолжите выполнение следующих шагов.

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

1. В консоли администратора Google перейдите в menu > Безопасность > Управление доступом и данными > Элементы управления API .

   Перейти к элементам управления API

2. Нажмите «Управление делегированием на уровне домена» .
3. Нажмите Добавить новый .
4. В поле «Идентификатор клиента» вставьте скопированный ранее идентификатор клиента.
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 с именем, соответствующим значению mainClassName в файле build.gradle .

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. Нажмите «Принять» .

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

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

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

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