REST Resource: customers.configurations
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: configuração
Uma configuração coleta as opções de provisionamento para dispositivos Android. Cada configuração combina:
- O controlador de política de dispositivo (DPC) do EMM instalado nos dispositivos.
- Políticas de EMM aplicadas nos dispositivos.
- Metadados mostrados no dispositivo para ajudar os usuários durante a configuração.
Os clientes podem adicionar quantas configurações precisarem. No entanto, o registro sem toque funciona melhor quando um cliente define uma configuração padrão aplicada a todos os novos dispositivos comprados pela organização.
Representação 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
Apenas saída. O nome do recurso da API no formato customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . Atribuído pelo servidor.
|
configurationId |
string (int64 format)
Apenas saída. O ID da configuração. Atribuído pelo servidor.
|
configurationName |
string
Obrigatório. Um nome curto que descreve a finalidade da configuração. Por exemplo, Equipe de vendas ou Funcionários temporários. O portal de registro sem toque mostra esse nome para os administradores de TI.
|
dpcResourcePath |
string
Obrigatório. O nome do recurso do DPC (controlador de política do dispositivo) selecionado no formato customers/[CUSTOMER_ID]/dpcs/* . Para listar os DPCs compatíveis, chame customers.dpcs.list .
|
companyName |
string
Obrigatório. É o nome da organização. O registro sem toque mostra o nome da organização para os usuários durante o provisionamento do dispositivo.
|
contactEmail |
string
Obrigatório. O endereço de e-mail com que os usuários do dispositivo podem entrar em contato para receber ajuda. O registro sem toque mostra esse endereço de e-mail para os usuários antes do provisionamento de dispositivo. O valor é validado na entrada.
|
contactPhone |
string
Obrigatório. O número de telefone para o qual os usuários de dispositivos podem ligar, de outro dispositivo, para receber ajuda. O registro sem toque mostra esse número para os usuários antes do provisionamento do dispositivo. Aceita numerais, espaços, o sinal de adição, hifens e parênteses.
|
customMessage |
string
Uma mensagem com uma ou duas frases para ajudar os usuários do dispositivo a receber ajuda ou dar mais detalhes sobre o que está acontecendo com o dispositivo. O registro sem toque vai mostrar essa mensagem antes do provisionamento do dispositivo.
|
isDefault |
boolean
Obrigatório. Define se essa é a configuração padrão que o registro sem toque vai aplicar a todos os novos dispositivos que a organização comprar no futuro. Apenas uma configuração de cliente pode ser o padrão. Definir esse valor como true muda o valor de isDefault da configuração padrão anterior para false .
|
forcedResetTime |
string (Duration format)
Opcional. O tempo limite antes de forçar a redefinição para a configuração original do dispositivo se ele não passar pelo provisionamento no assistente de configuração, geralmente devido à falta de conectividade de rede durante esse processo. Varia de 0 a 6 horas, com 2 horas sendo o padrão se não definido. Duração em segundos com até nove dígitos fracionários, terminando em "s ". Exemplo: "3.5s" .
|
Métodos |
|
Cria uma nova configuração. |
|
Exclui uma configuração não utilizada. |
|
Recebe os detalhes de uma configuração. |
|
Lista as configurações de um cliente. |
|
Atualiza os valores dos campos de uma configuração. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]