REST Resource: customers.configurations
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: پیکربندی
یک پیکربندی، گزینه‌های تأمین را برای دستگاه‌های Android جمع‌آوری می‌کند. هر پیکربندی موارد زیر را ترکیب می کند:
- کنترل‌کننده خط مشی دستگاه EMM (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 فقط خروجی نام منبع API در قالب customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . توسط سرور اختصاص داده شده است. |
configurationId | string ( int64 format) فقط خروجی شناسه پیکربندی توسط سرور اختصاص داده شده است. |
configurationName | string مورد نیاز. نام کوتاهی که هدف پیکربندی را توصیف می کند. به عنوان مثال، تیم فروش یا کارمندان موقت . پورتال ثبت نام بدون لمس این نام را برای مدیران فناوری اطلاعات نمایش می دهد. |
dpcResourcePath | string مورد نیاز. نام منبع DPC انتخابی (کنترل کننده خط مشی دستگاه) در قالب customers/[CUSTOMER_ID]/dpcs/* . برای فهرست کردن DPC های پشتیبانی شده، با customers.dpcs.list |
companyName | string مورد نیاز. نام سازمان. ثبت نام بدون لمس این نام سازمان را در حین تهیه دستگاه به کاربران دستگاه نشان می دهد. |
contactEmail | string مورد نیاز. آدرس ایمیلی که کاربران دستگاه می توانند برای دریافت راهنمایی با آن تماس بگیرند. ثبت نام بدون لمس این آدرس ایمیل را قبل از تهیه دستگاه به کاربران دستگاه نشان می دهد. مقدار در ورودی تایید می شود. |
contactPhone | string مورد نیاز. شماره تلفنی که کاربران دستگاه می توانند با استفاده از دستگاه دیگری برای دریافت راهنمایی با آن تماس بگیرند. ثبت نام بدون لمس این عدد را قبل از تهیه دستگاه به کاربران دستگاه نشان می دهد. اعداد، فاصله، علامت مثبت، خط فاصله و پرانتز را می پذیرد. |
customMessage | string پیامی حاوی یک یا دو جمله برای کمک به کاربران دستگاه برای دریافت کمک یا ارائه جزئیات بیشتر در مورد اتفاقاتی که برای دستگاهشان می‌افتد. ثبت نام بدون لمس این پیام را قبل از تهیه دستگاه نشان می دهد. |
isDefault | boolean مورد نیاز. آیا این پیکربندی پیش‌فرض است که ثبت‌نام بدون لمس برای هر دستگاه جدیدی که سازمان در آینده خریداری می‌کند اعمال می‌شود. فقط یک پیکربندی مشتری می تواند پیش فرض باشد. با تنظیم این مقدار روی true ، مقدار isDefault پیکربندی پیش فرض قبلی را به false تغییر می دهد. |
forcedResetTime | string ( Duration format) اختیاری. مهلت زمانی قبل از بازنشانی اجباری دستگاه در صورتی که دستگاه در جادوگر راه‌اندازی آماده‌سازی نشود، معمولاً به دلیل عدم اتصال به شبکه در حین جادوگر راه‌اندازی. از 0 تا 6 ساعت متغیر است و در صورت تنظیم نشدن، 2 ساعت پیش‌فرض است. مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" . |
روش ها |
|---|
| یک پیکربندی جدید ایجاد می کند. |
| یک پیکربندی استفاده نشده را حذف می کند. |
| جزئیات یک پیکربندی را دریافت می کند. |
| پیکربندی های مشتری را فهرست می کند. |
| مقادیر فیلد پیکربندی را به روز می کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خط‌مشی‌های سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]
