REST Resource: customers.configurations
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: Configuration
構成では、Android デバイスのプロビジョニング オプションを収集します。各設定の構成は次のとおりです。
- デバイスにインストールされている EMM Device Policy Controller(DPC)
- デバイスに適用される EMM ポリシー。
- セットアップ中にユーザーをサポートするためにデバイスに表示されるメタデータ。
構成は必要な数だけ追加できます。ただし、ゼロタッチ登録が最適に機能するのは、組織が購入する新しいデバイスに適用されるデフォルト設定をお客様が設定している場合です。
JSON 表現 |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
フィールド |
name |
string
出力専用。customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] 形式の API リソース名。サーバーによって割り当てられます。
|
configurationId |
string (int64 format)
出力専用。構成の ID。サーバーによって割り当てられます。
|
configurationName |
string
必須。構成の目的を説明する短い名前。たとえば、「営業チーム」や「臨時従業員」などです。ゼロタッチ登録ポータルでは、この名前が IT 管理者に表示されます。
|
dpcResourcePath |
string
必須。選択した DPC(Device Policy Controller)のリソース名(customers/[CUSTOMER_ID]/dpcs/* 形式)。サポートされている DPC を一覧表示するには、customers.dpcs.list を呼び出します。
|
companyName |
string
必須。組織の名前。ゼロタッチ登録では、デバイスのプロビジョニング時にデバイスのユーザーにこの組織名が表示されます。
|
contactEmail |
string
必須。デバイスのユーザーからのサポート リクエストを受け付けるメールアドレスです。ゼロタッチ登録では、端末のプロビジョニング前に端末のユーザーにこのメールアドレスが表示されます。値は入力時に検証されます。
|
contactPhone |
string
必須。デバイス ユーザーが別のデバイスを使用してサポートを受けることができる電話番号。ゼロタッチ登録では、デバイスのプロビジョニング前にデバイスのユーザーにこの番号が表示されます。使用できるのは、数字、スペース、プラス記号、ハイフン、丸かっこです。
|
customMessage |
string
デバイスのユーザーがサポートを受けたり、デバイスの状況について詳しい情報を提供したりする際に役立つ、1 ~ 2 文のメッセージ。ゼロタッチ登録では、デバイスのプロビジョニング前にこのメッセージが表示されます。
|
isDefault |
boolean
必須。これが、今後組織が購入する新しいデバイスにゼロタッチ登録を適用するデフォルト設定であるかどうかを示します。デフォルトにできる顧客設定は 1 つのみです。この値を true に設定すると、以前のデフォルト構成の isDefault 値が false に変更されます。
|
forcedResetTime |
string (Duration format)
省略可。デバイスが設定ウィザードでプロビジョニングされない場合に、デバイスを強制的に出荷時設定にリセットする前のタイムアウト。通常は、設定ウィザードでネットワーク接続がないことが原因です。値の範囲は 0 ~ 6 時間で、設定しなかった場合のデフォルトは 2 時間です。 s で終わる小数 9 桁までの秒単位の期間。例: "3.5s" 。
|
メソッド |
|
新しい構成を作成します。 |
|
未使用の構成を削除します。 |
|
構成の詳細を取得します。 |
|
お客様の構成を一覧表示します。 |
|
構成のフィールド値を更新します。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eA configuration combines the EMM device policy controller, enforced policies, and setup metadata for Android devices.\u003c/p\u003e\n"],["\u003cp\u003eCustomers can create multiple configurations, but setting a default configuration is recommended for newly purchased devices.\u003c/p\u003e\n"],["\u003cp\u003eEach configuration includes details like the configuration name, DPC resource path, company information, and contact details for user assistance.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a configuration details its properties such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003econfigurationId\u003c/code\u003e, \u003ccode\u003econfigurationName\u003c/code\u003e, \u003ccode\u003edpcResourcePath\u003c/code\u003e, \u003ccode\u003edpcExtras\u003c/code\u003e, \u003ccode\u003ecompanyName\u003c/code\u003e, \u003ccode\u003econtactEmail\u003c/code\u003e, \u003ccode\u003econtactPhone\u003c/code\u003e, \u003ccode\u003ecustomMessage\u003c/code\u003e, \u003ccode\u003eisDefault\u003c/code\u003e, and \u003ccode\u003eforcedResetTime\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eMethods are available to create, delete, get, list, and update device configurations.\u003c/p\u003e\n"]]],["Configurations are used to manage Android device provisioning, combining the EMM device policy controller (DPC), EMM policies, and setup metadata. Key information includes the `configurationName`, `dpcResourcePath`, `companyName`, `contactEmail`, `contactPhone`, and `customMessage`. The `isDefault` field designates the default configuration. Methods allow to create, delete, get, list, and patch configurations. A configuration uses a `forcedResetTime` for factory reset if the device does not get provisioned.\n"],null,["# REST Resource: customers.configurations\n\n- [Resource: Configuration](#Configuration)\n - [JSON representation](#Configuration.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Configuration\n-----------------------\n\nA configuration collects the provisioning options for Android devices. Each configuration combines the following:\n\n- The EMM device policy controller (DPC) installed on the devices.\n- EMM policies enforced on the devices.\n- Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch enrollment works best when a customer sets a default configuration that's applied to any new devices the organization purchases.\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"configurationId\": string, \"configurationName\": string, \"dpcResourcePath\": string, \"dpcExtras\": string, \"companyName\": string, \"contactEmail\": string, \"contactPhone\": string, \"customMessage\": string, \"isDefault\": boolean, \"forcedResetTime\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The API resource name in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by the server. |\n| `configurationId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The ID of the configuration. Assigned by the server. |\n| `configurationName` | `string` Required. A short name that describes the configuration's purpose. For example, *Sales team* or *Temporary employees*. The zero-touch enrollment portal displays this name to IT admins. |\n| `dpcResourcePath` | `string` Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call [`customers.dpcs.list`](/zero-touch/reference/customer/rest/v1/customers.dpcs/list#google.android.device.provisioning.v1.customer.DeviceProvisioningCustomerService.ListDpcs). |\n| `dpcExtras` | `string` The JSON-formatted EMM provisioning extras that are passed to the DPC. |\n| `companyName` | `string` Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning. |\n| `contactEmail` | `string` Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input. |\n| `contactPhone` | `string` Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses. |\n| `customMessage` | `string` A message, containing one or two sentences, to help device users get help or give them more details about what's happening to their device. Zero-touch enrollment shows this message before the device is provisioned. |\n| `isDefault` | `boolean` Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`. |\n| `forcedResetTime` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------|-----------------------------------------|\n| ### [create](/zero-touch/reference/customer/rest/v1/customers.configurations/create) | Creates a new configuration. |\n| ### [delete](/zero-touch/reference/customer/rest/v1/customers.configurations/delete) | Deletes an unused configuration. |\n| ### [get](/zero-touch/reference/customer/rest/v1/customers.configurations/get) | Gets the details of a configuration. |\n| ### [list](/zero-touch/reference/customer/rest/v1/customers.configurations/list) | Lists a customer's configurations. |\n| ### [patch](/zero-touch/reference/customer/rest/v1/customers.configurations/patch) | Updates a configuration's field values. |"]]