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/* . Чтобы получить список поддерживаемых ЦОД, вызовите 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 "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. 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. |"]]
