REST Resource: customers.configurations
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Configuration
Una configuración recopila las opciones de aprovisionamiento para dispositivos Android. Cada configuración combina lo siguiente:
- El controlador de política de dispositivo (DPC) de EMM instalado en los dispositivos
- Políticas de EMM aplicadas en los dispositivos
- Son metadatos que se muestran en el dispositivo para ayudar a los usuarios durante la configuración.
Los clientes pueden agregar todas las configuraciones que necesiten. Sin embargo, la inscripción automática funciona mejor cuando un cliente establece una configuración predeterminada que se aplica a todos los dispositivos nuevos que compra la organización.
Representación JSON |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
Campos |
name |
string
Solo salida. El nombre del recurso de la API en el formato customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . El servidor lo asigna.
|
configurationId |
string (int64 format)
Solo salida. El ID de la configuración. El servidor lo asigna.
|
configurationName |
string
Obligatorio. Un nombre corto que describe el propósito de la configuración. Por ejemplo, Equipo de ventas o Empleados temporales. El portal de inscripción automática muestra este nombre a los administradores de TI.
|
dpcResourcePath |
string
Obligatorio. El nombre del recurso del DPC (controlador de política de dispositivo) seleccionado en el formato customers/[CUSTOMER_ID]/dpcs/* . Para enumerar los DPC admitidos, llama a customers.dpcs.list .
|
companyName |
string
Obligatorio. Es el nombre de la organización. La inscripción automática les muestra el nombre de esta organización a los usuarios de los dispositivos durante el aprovisionamiento de dispositivos.
|
contactEmail |
string
Obligatorio. Es la dirección de correo electrónico con la que los usuarios del dispositivo pueden comunicarse para obtener ayuda. La inscripción automática muestra esta dirección de correo electrónico a los usuarios de los dispositivos antes de aprovisionarlos. El valor se valida cuando se ingresa.
|
contactPhone |
string
Obligatorio. Número de teléfono al que los usuarios del dispositivo pueden llamar desde otro dispositivo para obtener ayuda. La inscripción automática muestra este número a los usuarios de los dispositivos antes de aprovisionarlos. Acepta números, espacios, el signo más, guiones y paréntesis.
|
customMessage |
string
Un mensaje, que contiene una o dos oraciones, para ayudar a los usuarios de dispositivos a obtener ayuda o brindarles más detalles sobre lo que le ocurre a su dispositivo. La inscripción automática muestra este mensaje antes de que se aprovisione el dispositivo.
|
isDefault |
boolean
Obligatorio. Si esta es la configuración predeterminada que la inscripción automática aplica a cualquier dispositivo nuevo que la organización compre en el futuro. Solo una configuración de cliente puede ser la predeterminada. Establecer este valor en true cambia el valor de isDefault de la configuración predeterminada anterior a false .
|
forcedResetTime |
string (Duration format)
Opcional. Es el tiempo de espera antes de forzar el restablecimiento de la configuración de fábrica del dispositivo si este no se aprovisionó con el asistente de configuración, por lo general, debido a una falta de conectividad de red durante el asistente de configuración. Va de 0 a 6 horas y, si no se configura, el valor predeterminado es 2 horas. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s ”. Ejemplo: "3.5s" .
|
Métodos |
|
Crea una configuración nueva. |
|
Borra una configuración que no se usa. |
|
Obtiene los detalles de una configuración. |
|
Enumera las configuraciones de un cliente. |
|
Actualiza los valores de campo de una configuración. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]