REST Resource: customers.configurations
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
المورد: الإعداد
تجمع الإعدادات خيارات إدارة الحسابات لأجهزة Android. ويضم كل إعداد ما يلي:
- وحدة التحكّم بسياسة الجهاز لإدارة الخدمات الجوّالة للمؤسسات (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]. تم تعيينها من قِبل الخادم.
|
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 ساعات، وتكون المدة التلقائية لساعتَين في حال ترك السياسة بدون ضبط. مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام "s" مثال: "3.5s"
|
الطُرق |
|
|
تنشئ عملية ضبط جديدة. |
|
|
يؤدي هذا الإجراء إلى حذف إعدادات غير مستخدَمة. |
|
|
الحصول على تفاصيل عملية الضبط. |
|
|
يسرد إعدادات العميل. |
|
|
تُعدِّل قيم حقول الإعدادات. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة 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. |"]]
