REST Resource: customers.configurations
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: Konfigurasi
Konfigurasi mengumpulkan opsi penyediaan untuk perangkat Android. Setiap konfigurasi menggabungkan hal berikut:
- Pengontrol kebijakan perangkat (DPC) EMM yang diinstal di perangkat.
- Kebijakan EMM diterapkan pada perangkat.
- Metadata yang ditampilkan di perangkat untuk membantu pengguna selama penyiapan.
Pelanggan dapat menambahkan konfigurasi sebanyak yang diperlukan. Namun, pendaftaran zero-touch berfungsi optimal jika pelanggan menetapkan konfigurasi default yang diterapkan ke perangkat baru yang dibeli organisasi.
| Representasi JSON |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
| Kolom |
name |
string
Hanya output. Nama resource API dalam format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Ditetapkan oleh server.
|
configurationId |
string (int64 format)
Hanya output. ID konfigurasi. Ditetapkan oleh server.
|
configurationName |
string
Wajib. Nama pendek yang menjelaskan tujuan konfigurasi. Misalnya, Tim penjualan atau Karyawan magang. Portal pendaftaran zero-touch menampilkan nama ini kepada admin IT.
|
dpcResourcePath |
string
Wajib. Nama resource DPC (pengontrol kebijakan perangkat) yang dipilih dalam format customers/[CUSTOMER_ID]/dpcs/*. Untuk menampilkan DPC yang didukung, panggil customers.dpcs.list
|
companyName |
string
Wajib. Nama organisasi. Pendaftaran zero-touch menampilkan nama organisasi ini kepada pengguna perangkat selama penyediaan perangkat.
|
contactEmail |
string
Wajib. Alamat email yang dapat dihubungi pengguna perangkat untuk mendapatkan bantuan. Pendaftaran zero-touch menampilkan alamat email ini kepada pengguna perangkat sebelum proses penyediaan perangkat. Nilai divalidasi saat dimasukkan.
|
contactPhone |
string
Wajib. Nomor telepon yang dapat dihubungi pengguna perangkat, yang menggunakan perangkat lain, untuk mendapatkan bantuan. Pendaftaran zero-touch menampilkan nomor ini kepada pengguna perangkat sebelum penyediaan perangkat. Menerima angka, spasi, tanda plus, tanda hubung, dan tanda kurung.
|
customMessage |
string
Pesan, yang berisi satu atau dua kalimat, untuk membantu pengguna perangkat mendapatkan bantuan atau memberi mereka detail lebih lanjut tentang apa yang terjadi pada perangkat mereka. Pendaftaran zero-touch menampilkan pesan ini sebelum perangkat disediakan.
|
isDefault |
boolean
Wajib. Apakah ini merupakan konfigurasi default yang diterapkan pendaftaran zero-touch untuk setiap perangkat baru yang dibeli organisasi di masa mendatang. Hanya satu konfigurasi pelanggan yang dapat menjadi default. Menyetel nilai ini ke true, akan mengubah nilai isDefault konfigurasi default sebelumnya menjadi false.
|
forcedResetTime |
string (Duration format)
Opsional. Waktu tunggu sebelum memaksa reset ke setelan pabrik jika perangkat tidak melalui penyediaan di wizard penyiapan, biasanya karena kurangnya konektivitas jaringan selama wizard penyiapan. Rentang dari 0-6 jam, dengan 2 jam menjadi default jika tidak disetel. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
|
Metode |
|
|
Membuat konfigurasi baru. |
|
|
Menghapus konfigurasi yang tidak digunakan. |
|
|
Mendapatkan detail konfigurasi. |
|
|
Mencantumkan konfigurasi pelanggan. |
|
|
Memperbarui nilai kolom konfigurasi. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
