このクイックスタート ガイドの手順に沿って操作すると、ゼロタッチ登録のカスタマー API にリクエストを送信するシンプルな Java コマンドライン アプリが約 10 分で作成できます。
前提条件
このクイックスタートを実行するには、以下のものが必要です。
- ゼロタッチ登録のお客様のアカウントのメンバーである Google アカウント。スタートガイドをご覧ください。
- Java 1.7 以降。
- Gradle 2.3 以降。
- インターネット アクセスとウェブブラウザ。
ステップ 1: ゼロタッチ登録 API を有効にする
- このウィザードを使用して、Google Developers Console でプロジェクトを作成または選択し、API を自動的に有効にします。[続行]、[認証情報に進む] の順にクリックします。
- [認証情報を作成] で [キャンセル] をクリックします。
- ページ上部の [OAuth 同意画面] タブを選択します。メールアドレスを選択し、[ユーザーに表示するサービス名] が設定されていない場合はサービス名を入力して、[保存] ボタンをクリックします。
- [認証情報] タブを選択し、[認証情報を作成] ボタンをクリックして、[OAuth クライアント ID] を選択します。
- アプリケーション タイプとして [Other] を選択し、「Quickstart」という名前を入力して [作成] ボタンをクリックします。
- [OK] をクリックして [OAuth クライアント] パネルを閉じます。
- [JSON をダウンロード] をクリックします。
- ファイルを作業ディレクトリに移動し、名前を
client_secret.json
に変更します。
ステップ 2: プロジェクトを準備する
Gradle プロジェクトを設定する手順は次のとおりです。
次のコマンドを実行して、作業ディレクトリに新しいプロジェクトを作成します。
gradle init --type basic mkdir -p src/main/java src/main/resources
手順 1 でダウンロードした
client_secret.json
ファイルを、上記で作成したsrc/main/resources/
ディレクトリにコピーします。デフォルトの
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 enrollemnt 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
アプリを初めて実行するときに、アクセスを承認する必要があります。
- アプリはデフォルトのブラウザで新しいタブを開こうとします。失敗した場合は、コンソールから URL をコピーしてブラウザで開きます。Google アカウントにまだログインしていない場合は、ログインするよう求められます。複数の Google アカウントにログインしている場合は、承認に使用するアカウントを選択するよう求められます。
- [Accept] をクリックします。
- ブラウザタブを閉じても、アプリは引き続き実行されます。
メモ
- Google API クライアント ライブラリは承認データをファイル システムに保存するため、その後の起動時に承認を求めるメッセージは表示されません。
- アプリの認可データをリセットするには、
~/.credentials/zero-touch.quickstart.json
ファイルを削除してアプリを再度実行します。 - このクイックスタートの認可フローは、コマンドライン アプリに最適です。ウェブアプリに認可を追加する方法については、OAuth 2.0 ウェブサーバー アプリケーションをご覧ください。
トラブルシューティング
確認すべき一般的な事項は次のとおりです。 クイックスタートの 問題点をお知らせいただければ、解決に向けて取り組んでまいります。
- ゼロタッチ登録のお客様アカウントのメンバーである同じ Google アカウントで API 呼び出しを承認していることを確認します。同じ Google アカウントを使用してゼロタッチ登録のポータルにログインし、アクセスをテストします。
- アカウントがポータルで最新の利用規約に同意していることを確認します。顧客アカウントをご覧ください。