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

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

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

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

Цели

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

Предпосылки

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

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

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

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

Включить API

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

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

  Включить API

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

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

1. В консоли Google Cloud перейдите в > > Брендинг .

   Перейти к брендингу

2. Если вы уже настроили , вы можете настроить следующие параметры экрана согласия OAuth в разделе Брендинг , Аудитория и Доступ к данным . Если вы видите сообщение, в котором говорится пока не настроено , нажмите «Начать» :
1. В разделе «Информация о приложении» в поле «Имя приложения » введите имя приложения.
2. В поле Адрес электронной почты службы поддержки пользователей выберите адрес электронной почты службы поддержки, по которому пользователи могут связаться с вами, если у них возникнут вопросы относительно их согласия.
3. Нажмите Далее .
4. В разделе «Аудитория» выберите «Внутренняя» .
5. Нажмите Далее .
6. В разделе «Контактная информация» введите адрес электронной почты , на который вы можете получать уведомления о любых изменениях в вашем проекте.
7. Нажмите Далее .
8. В разделе «Готово » ознакомьтесь с Политикой использования пользовательских данных служб API Google и, если вы согласны, выберите «Я согласен с Политикой использования пользовательских данных служб API Google» .
9. Нажмите «Продолжить» .
10. Нажмите «Создать» .
3. На данный момент вы можете пропустить добавление областей действия. В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вы должны будете изменить тип пользователя на External . Затем добавьте области действия авторизации, которые требуются вашему приложению. Чтобы узнать больше, см. полное руководство по настройке согласия OAuth .

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

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

1. В консоли Google Cloud перейдите в > > Клиенты .

   Перейти к клиентам

2. Нажмите «Создать клиента» .
3. Нажмите Тип приложения > Настольное приложение .
4. В поле Имя введите имя для учетных данных. Это имя отображается только в консоли Google Cloud.
5. Нажмите «Создать» .

   Новые учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».

6. Сохраните загруженный файл 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 по умолчанию и замените его содержимое следующим кодом:

   appsScript/быстрый старт/сборка.gradle

   Посмотреть на GitHub
   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'AppsScriptQuickstart'
   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-script:v1-rev20220323-2.0.0'
   }

Настройте образец

1. В каталоге src/main/java/ создайте новый файл Java с именем, соответствующим значению mainClassName в файле build.gradle .

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

   appsScript/quickstart/src/main/java/AppsScriptQuickstart.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.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.script.Script;
   import com.google.api.services.script.model.Content;
   import com.google.api.services.script.model.CreateProjectRequest;
   import com.google.api.services.script.model.File;
   import com.google.api.services.script.model.Project;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.security.GeneralSecurityException;
   import java.util.Arrays;
   import java.util.Collections;
   import java.util.List;
   
   public class AppsScriptQuickstart {
     private static final String APPLICATION_NAME = "Apps Script API Java Quickstart";
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart.
      * If modifying these scopes, delete your previously saved credentials folder at /secret.
      */
     private static final List<String> SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/script.projects");
     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 If the credentials.json file cannot be found.
      */
     private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT)
         throws IOException {
       // Load client secrets.
       InputStream in = AppsScriptQuickstart.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(new FileDataStoreFactory(new java.io.File(TOKENS_DIRECTORY_PATH)))
           .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();
       Script service =
           new Script.Builder(HTTP_TRANSPORT, JSON_FACTORY, getCredentials(HTTP_TRANSPORT))
               .setApplicationName(APPLICATION_NAME)
               .build();
       Script.Projects projects = service.projects();
   
       // Creates a new script project.
       Project createOp = projects.create(new CreateProjectRequest().setTitle("My Script")).execute();
   
       // Uploads two files to the project.
       File file1 = new File()
           .setName("hello")
           .setType("SERVER_JS")
           .setSource("function helloWorld() {\n  console.log(\"Hello, world!\");\n}");
       File file2 = new File()
           .setName("appsscript")
           .setType("JSON")
           .setSource("{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}");
       Content content = new Content().setFiles(Arrays.asList(file1, file2));
       Content updatedContent = projects.updateContent(createOp.getScriptId(), content).execute();
   
       // Logs the project URL.
       System.out.printf("https://script.google.com/d/%s/edit\n", updatedContent.getScriptId());
     }
   }

Запустите образец

1. Запустите образец:

   gradle run
   

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

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

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

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

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