REST Resource: customers.configurations
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Risorsa: configurazione
Una configurazione raccoglie le opzioni di provisioning per i dispositivi Android. Ogni configurazione combina i seguenti elementi:
- Il controller dei criteri dei dispositivi (DPC) EMM installato sui dispositivi.
- Criteri EMM applicati ai dispositivi.
- Metadati visualizzati sul dispositivo per aiutare gli utenti durante la configurazione.
I clienti possono aggiungere tutte le configurazioni di cui hanno bisogno. Tuttavia, la registrazione zero-touch funziona al meglio quando un cliente imposta una configurazione predefinita da applicare a tutti i nuovi dispositivi acquistati dall'organizzazione.
Rappresentazione JSON |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
Campi |
name |
string
Solo output. Il nome della risorsa API nel formato customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . Assegnato dal server.
|
configurationId |
string (int64 format)
Solo output. L'ID della configurazione. Assegnato dal server.
|
configurationName |
string
Obbligatorio. Un nome breve che descrive lo scopo della configurazione. Ad esempio, team di vendita o dipendenti temporanei. Il portale della registrazione zero-touch mostra questo nome agli amministratori IT.
|
dpcResourcePath |
string
Obbligatorio. Il nome della risorsa del DPC (controller dei criteri dei dispositivi) selezionato nel formato customers/[CUSTOMER_ID]/dpcs/* . Per elencare i DPC supportati, chiama customers.dpcs.list .
|
companyName |
string
Obbligatorio. Il nome dell'organizzazione. La registrazione zero-touch mostra questo nome dell'organizzazione agli utenti del dispositivo durante il provisioning dispositivo.
|
contactEmail |
string
Obbligatorio. L'indirizzo email che gli utenti del dispositivo possono contattare per richiedere assistenza. La registrazione senza intervento mostra questo indirizzo agli utenti del dispositivo prima del provisioning. Il valore viene convalidato all'input.
|
contactPhone |
string
Obbligatorio. Il numero di telefono che gli utenti del dispositivo possono chiamare, utilizzando un altro dispositivo, per richiedere assistenza. La registrazione zero-touch mostra questo numero agli utenti dei dispositivi prima del provisioning dispositivo. Accetta numeri, spazi, segno più, trattini e parentesi.
|
customMessage |
string
Un messaggio contenente una o due frasi per aiutare gli utenti del dispositivo a ricevere aiuto o fornire loro maggiori dettagli su ciò che sta succedendo al dispositivo. La registrazione zero-touch mostra questo messaggio prima del provisioning del dispositivo.
|
isDefault |
boolean
Obbligatorio. Indica se si tratta della configurazione predefinita che la registrazione zero-touch verrà applicata a tutti i nuovi dispositivi acquistati dall'organizzazione in futuro. Può essere impostata come predefinita una sola configurazione cliente. Se questo valore è impostato su true , il valore isDefault della configurazione predefinita precedente viene modificato in false .
|
forcedResetTime |
string (Duration format)
(Facoltativo) Timeout prima del ripristino dei dati di fabbrica del dispositivo nel caso in cui il dispositivo non venga sottoposto al provisioning nella configurazione guidata, generalmente a causa della mancanza di connettività di rete durante la configurazione guidata. Varia da 0 a 6 ore; se il criterio non viene configurato, 2 ore sono il valore predefinito. Durata in secondi con un massimo di nove cifre frazionarie e termina con "s ". Esempio: "3.5s" .
|
Metodi |
|
Crea una nuova configurazione. |
|
Elimina una configurazione inutilizzata. |
|
Recupera i dettagli di una configurazione. |
|
Elenca le configurazioni di un cliente. |
|
Aggiorna i valori dei campi di una configurazione. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]