Краткое руководство по Java для клиентов

Следуйте инструкциям в этом руководстве, и примерно через 10 минут у вас будет простое приложение Java для командной строки, которое отправляет запросы к API для клиентов, использующих автоматическую настройку.

Требования

Чтобы запустить этот быстрый старт, вам необходимо:

Шаг 1. Включите API автоматической настройки

  1. Используйте этот мастер, чтобы создать или выбрать проект в Google Developers Console и автоматически включить API. Нажмите Продолжить, а затем – Перейти к учетным данным.
  2. Нажмите Отмена в окне "Создать учетные данные".
  3. В верхней части страницы выберите вкладку Окно запроса доступа OAuth. Выберите Адрес электронной почты, введите Название товара, если оно ещё не указано, и нажмите кнопку Сохранить.
  4. Перейдите на вкладку Учетные данные, нажмите кнопку Создать учетные данные и выберите Идентификатор клиента OAuth.
  5. Выберите тип приложения Other (Другое), введите название Quickstart и нажмите кнопку Create (Создать).
  6. Нажмите ОК, чтобы закрыть панель Клиент OAuth.
  7. Нажмите Скачать JSON.
  8. Переместите файл в рабочий каталог и переименуйте его в client_secret.json.

Шаг 2. Подготовьте проект

Чтобы настроить проект Gradle, выполните следующие действия:

  1. Чтобы создать проект в рабочем каталоге, выполните следующую команду:

    gradle init --type basic
    mkdir -p src/main/java src/main/resources
    
  2. Скопируйте файл client_secret.json, скачанный на шаге 1, в каталог src/main/resources/, созданный выше.

  3. Откройте файл build.gradle по умолчанию и замените его содержимое следующим кодом:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'CustomerQuickstart'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:2.2.0'
    compile 'com.google.apis:google-api-services-androiddeviceprovisioning:v1-rev20230509-2.0.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
}

Шаг 3. Настройте образец

Создайте файл с названием src/main/java/CustomerQuickstart.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.androiddeviceprovisioning.v1.AndroidProvisioningPartner;
import com.google.api.services.androiddeviceprovisioning.v1.model.Company;
import com.google.api.services.androiddeviceprovisioning.v1.model.CustomerListCustomersResponse;
import com.google.api.services.androiddeviceprovisioning.v1.model.CustomerListDpcsResponse;
import com.google.api.services.androiddeviceprovisioning.v1.model.Dpc;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Arrays;
import java.util.List;

/** This class forms the quickstart introduction to the zero-touch enrollment customer API. */
public class CustomerQuickstart {

  // A single auth scope is used for the zero-touch enrollment customer API.
  private static final List<String> SCOPES =
      Arrays.asList("https://www.googleapis.com/auth/androidworkzerotouchemm");
  private static final String APP_NAME = "Zero-touch Enrollment Java Quickstart";
  private static final java.io.File DATA_STORE_DIR =
      new java.io.File(System.getProperty("user.home"), ".credentials/zero-touch.quickstart.json");

  // Global shared instances
  private static FileDataStoreFactory DATA_STORE_FACTORY;
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  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 a Credential object with the correct OAuth2 authorization for the user calling the
   * customer API. The service endpoint invokes this method when setting up a new service instance.
   *
   * @return an authorized Credential object.
   * @throws IOException
   */
  public static Credential authorize() throws IOException {
    // Load client secrets.
    InputStream in = CustomerQuickstart.class.getResourceAsStream("/client_secret.json");

    GoogleClientSecrets clientSecrets =
        GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in, "UTF-8"));

    // Ask the user to authorize the request using their Google Account
    // in their browser.
    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("Credential file saved to: " + DATA_STORE_DIR.getAbsolutePath());
    return credential;
  }

  /**
   * Build and return an authorized zero-touch enrollment API client service. Use the service
   * endpoint to call the API methods.
   *
   * @return an authorized client service endpoint
   * @throws IOException
   */
  public static AndroidProvisioningPartner getService() throws IOException {
    Credential credential = authorize();
    return new AndroidProvisioningPartner.Builder(HTTP_TRANSPORT, JSON_FACTORY, credential)
        .setApplicationName(APP_NAME)
        .build();
  }

  /**
   * Runs the zero-touch enrollment quickstart app.
   *
   * @throws IOException
   */
  public static void main(String[] args) throws IOException {

    // Create a zero-touch enrollment API service endpoint.
    AndroidProvisioningPartner service = getService();

    // Get the customer's account. Because a customer might have more
    // than one, limit the results to the first account found.
    AndroidProvisioningPartner.Customers.List accountRequest = service.customers().list();
    accountRequest.setPageSize(1);
    CustomerListCustomersResponse accountResponse = accountRequest.execute();
    if (accountResponse.getCustomers().isEmpty()) {
      // No accounts found for the user. Confirm the Google Account
      // that authorizes the request can access the zero-touch portal.
      System.out.println("No zero-touch enrollment account found.");
      System.exit(-1);
    }
    Company customer = accountResponse.getCustomers().get(0);
    String customerAccount = customer.getName();

    // Send an API request to list all the DPCs available using the customer account.
    AndroidProvisioningPartner.Customers.Dpcs.List request =
        service.customers().dpcs().list(customerAccount);
    CustomerListDpcsResponse response = request.execute();

    // Print out the details of each DPC.
    java.util.List<Dpc> dpcs = response.getDpcs();
    for (Dpc dpcApp : dpcs) {
      System.out.format("Name:%s  APK:%s\n", dpcApp.getDpcName(), dpcApp.getPackageName());
    }
  }
}

Шаг 4. Запустите пример

Чтобы запустить скрипт в файле, воспользуйтесь справкой по операционной системе. На компьютерах UNIX и Mac выполните в терминале следующую команду:

gradle -q run

При первом запуске приложения необходимо разрешить доступ:

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

Примечания

  • Поскольку клиентская библиотека API Google хранит данные авторизации в файловой системе, при последующих запусках авторизация не требуется.
  • Чтобы сбросить данные авторизации приложения, удалите файл ~/.credentials/zero-touch.quickstart.json и запустите приложение снова.
  • Процесс авторизации, описанный в этом руководстве, идеально подходит для приложения командной строки. Чтобы узнать, как добавить авторизацию в веб-приложение, ознакомьтесь со статьей Использование OAuth 2.0 для веб-серверных приложений.

Устранение неполадок

Вот несколько распространенных причин. Расскажите, что пошло не так, и мы постараемся это исправить.

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

Подробнее…