このページは Cloud Translation API によって翻訳されました。

仕組み

Customer API: デバイスとのプログラムで制御できる Android ゼロタッチ登録の設定について説明します。このドキュメントでは、企業向けモバイル管理（EMM）プロバイダおよび企業 IT への API 開発できます。このドキュメントを読むことで、 API で使用されるリソースとそれらの相互作用について学びました。ゼロタッチを初めて使う場合詳しくは、android.com 概要をご覧ください。

概要

カスタマー API は、Android ゼロタッチ登録を購入する組織に役立ちます。できます。アプリやツールを使用すると、IT 管理者は次のことを行えます。

プロビジョニング構成を作成、編集、削除します。
デバイスに設定を適用または削除する。
今後ゼロタッチ登録に追加するデバイスに適用するデフォルト設定を選択します。

IT 管理者は API を使用して、デバイスのゼロタッチ登録も解除できる登録できます。組織のユーザーを管理したり、利用規約に同意したりするには、 IT 管理者はゼロタッチ登録ポータルを使用します。

この API の一般的なユーザーは、次のとおりです。

EMM プロバイダがゼロタッチ登録のサポートをコンソールに追加する。
ゼロタッチ登録を自動化するツールを作成する企業の IT デベロッパーできます。

コアリソース

構成とデバイスは、API で使用するコアリソースです。「構成やデバイスの作成もできます。登録ポータル

デバイスとお客様のリソースの関係

構成: IT 管理者は、構成を使用してデバイスのプロビジョニングオプションを設定します。表示される EMM モバイルポリシーや連絡先情報役立ちます。構成は API の中心となるため、さまざまな構成であります。詳しくは、以下の構成をご覧ください。
デバイス: 組織が購入したゼロタッチ登録対応の Android デバイス販売パートナーから購入したとします設定を適用してデバイスをゼロタッチに含める登録できます。デバイスにはハードウェア ID とメタデータが添付されています。詳しくは、後述のデバイスをご覧ください。
DPC: EMM の DPC への読み取り専用の参照（デバイスポリシー）あります）。DPC を追加設定に移動して、デバイス向けの EMM ソリューションを選択します。記載されているすべての DPC ゼロタッチ登録に対応しており、Google Play から入手できます。宛先詳しくは、Dpc をご覧ください。

アプリで使用できるすべての API メソッドとリソースを一覧表示するには、 API リファレンス。

構成

Configuration API リソースは、次のとおりです。

デバイスにインストールされている EMM の DPC。
デバイスに適用される EMM ポリシー。
セットアップ中にユーザーをサポートするためにデバイスに表示される連絡先情報。

アプリは API を使用して、IT 管理者向けの構成を管理できます。API を呼び出して、構成の取得、作成、更新、削除を行います。以下の例は、新しい構成を作成します。

Java

// Add metadata to help the device user during provisioning.
Configuration configuration = new Configuration();
configuration.setConfigurationName("Sales team");
configuration.setCompanyName("XYZ Corp.");
configuration.setContactEmail("it-support@example.com");
configuration.setContactPhone("+1 (800) 555-0112");
configuration.setCustomMessage("We're setting up your phone. Call or email for help.");

// Set the DPC that zero-touch enrollment downloads and installs from Google Play.
configuration.setDpcResourcePath(dpc.getName());

// Set the JSON-formatted EMM provisioning extras that are passed to the DPC.
configuration.setDpcExtras("{"
      + "\"android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED\":true,"
      + "\"android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE\":{"
      + "\"default_min_password_length\":6,"
      + "\"company_name\":\"XYZ Corp\","
      + "\"management_server\":\"emm.example.com\","
      + "\"terms_url\":\"https://www.example.com/policies/terms/\","
      + "\"allowed_user_domains\":\"[\\\"example.com\\\", \\\"example.org\\\"]\""
      + "}"
      + "}");

// Create the new configuration on the server.
AndroidProvisioningPartner.Customers.Configurations.Create request =
      service.customers().configurations().create(customerAccount, configuration);
Configuration response = request.execute();

.NET

// Add metadata to help the device user during provisioning.
Configuration configuration = new Configuration
{
    ConfigurationName = "Sales team",
    CompanyName = "XYZ Corp.",
    ContactEmail = "it-support@example.com",
    ContactPhone = "+1 (800) 555-0112",
    CustomMessage = "We're setting up your phone. Call or email for help."
};

// Set the DPC that zero-touch enrollment downloads and installs from Google Play.
configuration.DpcResourcePath = dpc.Name;

// Set the JSON-formatted EMM provisioning extras that are passed to the DPC.
configuration.DpcExtras = @"{
    ""android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED"":true,
    ""android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE"":{
    ""default_min_password_length"":6,
    ""company_name"":""XYZ Corp"",
    ""management_server"":""emm.example.com"",
    ""terms_url"":""https://www.example.com/policies/terms/"",
    ""allowed_user_domains"":""[\""example.com\"", \""example.org\""]""
  }
}";

// Create the new configuration on the server.
var request = service.Customers.Configurations.Create(configuration, customerAccount);
var response = request.Execute();

Python

# Add metadata to help the device user during provisioning.
configuration = {
    'configurationName': 'Sales team',
    'companyName': 'XYZ Corp.',
    'contactEmail': 'it-support@example.com',
    'contactPhone': '+1 (800) 555-0112',
    'customMessage': 'We\'re setting up your phone. Call or email for help.'}

# Set the DPC that zero-touch enrollment installs from Google Play.
configuration['dpcResourcePath'] = dpc['name']

# Set the JSON-formatted EMM provisioning extras that are passed to the DPC.
configuration['dpcExtras'] = '''{
    "android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED":true,
    "android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE":{
      "default_min_password_length":6,
      "company_name":"XYZ Corp",
      "management_server":"emm.example.com",
      "terms_url":"https://www.example.com/policies/terms/",
      "allowed_user_domains":"[\\"example.com\\", \\"example.org\\"]"}
}'''

# Create the new configuration on the server.
response = service.customers().configurations().create(
    parent=customer_account, body=configuration).execute()

パッチ API を使用して構成を更新する場合は、フィールドマスク、または値を、null にしたくないすべての項目に指定します。デフォルトの構成（下記）を例として、構成を更新するのに役立ちます。

構成を削除する

デバイスにまだ適用されている構成は削除できません。エラーを使用中の構成を削除すると、API メソッドは HTTP 400 Bad Request を返します。ステータスコードと、その設定を使用しているデバイスの数を説明するメッセージ。発信 customers.devices.removeConfiguration から設定を削除してから、もう一度お試しください。

デフォルト構成。

ゼロタッチ登録は、組織でデフォルトの組織が購入する新しいデバイスに適用される構成。デフォルト構成が設定されていない場合は、それを設定するよう IT 管理者に伝えることを検討してください。以下の例は、既存の構成をデフォルトにする方法を示しています。 isDefault を true に設定する:

Java

// Send minimal data with the request. Just the 2 required fields.
// targetConfiguration is an existing configuration that we want to make the default.
Configuration configuration = new Configuration();
configuration.setIsDefault(true);
configuration.setConfigurationId(targetConfiguration.getConfigurationId());

// Call the API, including the FieldMask to avoid setting other fields to null.
AndroidProvisioningPartner.Customers.Configurations.Patch request = service
      .customers()
      .configurations()
      .patch(targetConfiguration.getName(), configuration);
request.setUpdateMask("isDefault");
Configuration results = request.execute();

.NET

// Send minimal data with the request. Just the 2 required fields.
// targetConfiguration is an existing configuration that we want to make the default.
Configuration configuration = new Configuration
{
    IsDefault = true,
    ConfigurationId = targetConfiguration.ConfigurationId,
};

// Call the API, including the FieldMask to avoid setting other fields to null.
var request = service.Customers.Configurations.Patch(configuration,
                                                     targetConfiguration.Name);
request.UpdateMask = "IsDefault";
Configuration results = request.Execute();

Python

# Send minimal data with the request. Just the 2 required fields.
# target_configuration is an existing configuration we'll make the default.
configuration = {
    'isDefault': True,
    'configurationId': target_configuration['configurationId']}

# Call the API, including the FieldMask to avoid setting other fields to null.
response = service.customers().configurations().patch(
    name=target_configuration['name'],
    body=configuration, updateMask='isDefault').execute()

デフォルト構成は 1 つだけです。新しいデフォルト構成の作成以前の構成の isDefault フィールドを false に設定します。必要に応じてキャッシュに保存された Configuration インスタンスを更新して、 isDefault フィールド。

デバイスユーザーに案内する

ゼロタッチ構成では、デバイスのセットアップウィザードにカスタマイズされたユーザーガイダンスが表示され、ユーザーをサポートします。デバイスを管理する組織の名前とともに、連絡先の電話番号とメールアドレスを構成に含める必要があります。また、 customMessage フィールドを使用して、ユーザーの状況の詳細を示すダウンロードします

設定しているデバイスからは通話やメールの送信ができないため見やすくするために電話番号やメールアドレスを提供します。

デバイス

お客様がゼロタッチ用にデバイスを購入した場合、販売パートナー様がデバイスを作成します。登録 - IT 管理者はデバイスを作成できません。デバイスを操作するには、デバイスの Device API リソース。検索が必要な場合や、デバイスについては、すべてのデバイスを一覧表示して、アプリで各バッチをローカルでフィルタします。対象例については、下記のページ分けされた結果をご覧ください。

デバイスを構成する

デバイスに設定を適用すると、デバイスがゼロタッチに登録されます登録できます。設定を適用するには、 customers.devices.applyConfiguration。設定を適用すると、デバイスは初期起動、または次回の出荷時設定へのリセットなどです。以下の例は、2 つ目のルールにタグを適用する一連のデバイスの構成に拡張できます。

Java

List<Device> devices = getDevicesToConfigure(service);
Configuration configurationToApply = getConfigurationToApply(service);

// Loop through the collection and apply the configuration to each device. This might
// take some time if the collection contains many devices.
for (Device device : devices) {
    System.out.println(device.getDeviceIdentifier().getImei());

    // Wrap the device ID in a DeviceReference.
    DeviceReference deviceRef = new DeviceReference();
    deviceRef.setDeviceId(device.getDeviceId());

    // Build and send the request to the API.
    CustomerApplyConfigurationRequest body = new CustomerApplyConfigurationRequest();
    body.setConfiguration(configurationToApply.getName());
    body.setDevice(deviceRef);

    AndroidProvisioningPartner.Customers.Devices.ApplyConfiguration request = service
          .customers()
          .devices()
          .applyConfiguration(customerAccount, body);
    request.execute();
}

.NET

IList<Device> devices = GetDevicesToConfigure(service);
Configuration configurationToApply = GetConfigurationToApply(service);

// Loop through the collection and apply the configuration to each device. This might
// take some time if the collection contains many devices.
foreach (Device device in devices)
{
    Console.WriteLine(device.DeviceIdentifier.Imei);

    // Wrap the device ID in a DeviceReference.
    var deviceRef = new DeviceReference
    {
        DeviceId = device.DeviceId
    };

    // Build and send the request to the API.
    CustomerApplyConfigurationRequest body = new CustomerApplyConfigurationRequest
    {
        Configuration = configurationToApply.Name,
        Device = deviceRef
    };
    var request = service.Customers.Devices.ApplyConfiguration(body,
                                                               customerAccount);
    request.Execute();
}

Python

devices = get_devices_to_configure(service)
configuration = get_configuration_to_apply(service)

# Loop through the collection and apply the configuration to each device.
# This might take some time if the collection contains many devices.
for device in devices:
  print(device['deviceIdentifier']['imei'])

  # Wrap the device ID in a DeviceReference.
  device_ref = {'deviceId': device['deviceId']}

  # Build and send the request to the API.
  body = {'configuration': configuration['name'], 'device': device_ref}
  service.customers().devices().applyConfiguration(
      parent=customer_account, body=body).execute()

デバイスから構成を削除するには、customers.devices.removeConfiguration を呼び出します。変更内容は、デバイスを出荷時の設定にリセットした後に有効になります。

デバイスの申請を解除

IT 管理者は、デバイスの申請を解除してゼロタッチ登録から削除できます。IT 管理者は、別のアカウントに移行、販売、販売パートナーへの返品を希望するデバイスの所有権を放棄できます。メソッドを呼び出す customers.devices.unclaim: デバイスの申請を解除します管理することはできません。

以下の例は、IMEI 番号からデバイスの申請を解除する方法を示しています。メーカー名:

Java

// Wrap the hardware ID and manufacturer values in a DeviceIdentifier.
// Then wrap the DeviceIdentifier in a DeviceReference.
DeviceIdentifier identifier = new DeviceIdentifier();
identifier.setImei("123456789012347");
identifier.setManufacturer("Google");
DeviceReference reference = new DeviceReference();
reference.setDeviceIdentifier(identifier);

// Create the body of the request.
CustomerUnclaimDeviceRequest body = new CustomerUnclaimDeviceRequest();
body.setDevice(reference);

// Call the API method to unclaim the device from the organization.
service.customers().devices().unclaim(customerAccount, body).execute();

.NET

// Wrap the hardware ID and manufacturer values in a DeviceIdentifier.
// Then wrap the DeviceIdentifier in a DeviceReference.
DeviceIdentifier identifier = new DeviceIdentifier
{
    Imei = "123456789012347",
    Manufacturer = "Google"
};
DeviceReference reference = new DeviceReference();
reference.DeviceIdentifier = identifier;

// Create the body of the request.
CustomerUnclaimDeviceRequest body = new CustomerUnclaimDeviceRequest();
body.Device = reference;

// Call the API method to unclaim the device from the organization.
service.Customers.Devices.Unclaim(body, customerAccount).Execute();

Python

# Wrap the hardware ID and manufacturer values in a DeviceIdentifier.
# Then wrap the DeviceIdentifier in a DeviceReference.
identifier = {'imei': '123456789012347', 'manufacturer': 'Google'}
reference = {'deviceIdentifier': identifier}

# Create the body of the request.
body = {'device': reference}

# Call the API method to unclaim the device from the organization.
service.customers().devices().unclaim(
    parent=customer_account, body=body).execute()

デバイスメタデータ

IT 管理者は、販売パートナーがデバイスに適用したメタデータを確認できます。ディスプレイ IT 管理者がデバイスを認識できるように、アプリのこのデバイスメタデータを追加します。

表示されるメタデータについて詳しくは、デバイスのメタデータガイドをご覧ください。

ページングされた結果

customers.devices.list API メソッドが次を返すことがあります。デバイスのリストが表示されています。レスポンスのサイズを小さくするために、この API やメソッド（customers.list など）はページングされた結果をサポートします。ありページングされた結果の場合、アプリケーションは大きなリストを繰り返しリクエストして処理できます。一度に 1 つのページずつ表示します。

API メソッドを呼び出した後、レスポンスに nextPageToken。nextPageToken が null さん、アプリはこれを使用して、メソッドを再度使用します。pageSize パラメータでデバイス数の上限を設定する必要があります。nextPageToken が null の場合、アプリは最後のページです

次のメソッドの例は、アプリでデバイスのリストを 1 ページずつ出力する方法を示しています。

Java

private void printDevices(AndroidProvisioningPartner service, String customerAccount,
      String pageToken) throws IOException {

    // Call the API to get a page of Devices. Send a page token from the method argument.
    // If the page token is null, the API returns the first page.
    AndroidProvisioningPartner.Customers.Devices.List request =
          service.customers().devices().list(customerAccount);
    request.setPageSize(50L);
    request.setPageToken(pageToken);
    CustomerListDevicesResponse response = request.execute();

    // Print the devices included in this page of results.
    for (Device device : response.getDevices()) {
        System.out.format("Device: %s\n", device.getName());
    }
    System.out.println("---");

    // Check to see if another page of devices is available. If yes, fetch & print the devices.
    if (response.getNextPageToken() != null) {
        this.printDevices(service, customerAccount, response.getNextPageToken());
    }
}

.NET

private void PrintDevices(AndroidProvisioningPartnerService service, String customerAccount,
                          String pageToken)
{
    // Call the API to get a page of Devices. Send a page token from the method argument.
    // If the page token is null, the API returns the first page.
    var request = service.Customers.Devices.List(customerAccount);
    request.PageSize = 50;
    request.PageToken = pageToken;
    var response = request.Execute();

    // Print the devices included in this page of results.
    foreach (Device device in response.Devices)
    {
        Console.WriteLine("Device: {0}", device.Name);
    }
    Console.WriteLine("---");

    // Check to see if another page of devices is available. If yes, fetch and print the devices.
    if (response.NextPageToken != null)
    {
        this.PrintDevices(service, customerAccount, response.NextPageToken);
    }
}

Python

def print_devices(service, customer_account, page_token):
  """Demonstrates how to loop through paginated lists of devices."""

  # Call the API to get a page of Devices. Send a page token from the method
  # argument. If the page token is None, the API returns the first page.
  response = service.customers().devices().list(
      parent=customer_account, pageSize=50, pageToken=page_token).execute()

  # Print the devices included in this page of results.
  for device in response['devices']:
    print('Device: {0}'.format(device['name']))
  print('---')

  # Check to see if another page of devices is available. If yes,
  # fetch and print the devices.
  if 'nextPageToken' in response:
    print_devices(service, customer_account, response['nextPageToken'])

始める

次に、承認で API 呼び出しを認可する方法を確認します。目標詳細については、クイックスタートガイドをご覧ください。 Java、 .NET、 Python。こちらの colab API 呼び出しの例を確認し、ご自身で API の呼び出しを試してください。

仕組み

概要

コアリソース

構成

Java

.NET

Python

構成を削除する

デフォルト構成。

Java

.NET

Python

デバイス ユーザーに案内する

デバイス

デバイスを構成する

Java

.NET

Python

デバイスの申請を解除

Java

.NET

Python

デバイス メタデータ

ページングされた結果

Java

.NET

Python

始める

デバイスユーザーに案内する

デバイスメタデータ