REST Resource: customers.configurations
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: Konfiguration
Eine Konfiguration erfasst die Bereitstellungsoptionen für Android-Geräte. Sie besteht aus den folgenden Komponenten:
- Der auf den Geräten installierte EMM Device Policy Controller (DPC).
- Auf den Geräten erzwungene EMM-Richtlinien.
- Metadaten, die auf dem Gerät angezeigt werden, um Nutzern bei der Einrichtung zu helfen.
Kunden können beliebig viele Konfigurationen hinzufügen. Die Zero-Touch-Registrierung funktioniert jedoch am besten, wenn ein Kunde eine Standardkonfiguration festlegt, die auf alle neuen Geräte angewendet wird, die die Organisation erwirbt.
JSON-Darstellung |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
Felder |
name |
string
Nur Ausgabe. Der API-Ressourcenname im Format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] . Vom Server zugewiesen.
|
configurationId |
string (int64 format)
Nur Ausgabe. Die ID der Konfiguration. Vom Server zugewiesen.
|
configurationName |
string
Erforderlich. Ein Kurzname, der den Zweck der Konfiguration beschreibt. Beispiele: Vertriebsteam, Temporäre Mitarbeiter Im Portal für die Zero-Touch-Registrierung wird IT-Administratoren dieser Name angezeigt.
|
dpcResourcePath |
string
Erforderlich. Der Ressourcenname des ausgewählten DPC (Device Policy Controller) im Format customers/[CUSTOMER_ID]/dpcs/* . Rufen Sie customers.dpcs.list auf, um die unterstützten DPCs aufzulisten.
|
companyName |
string
Erforderlich. Der Name der Organisation Bei der Zero-Touch-Registrierung wird Gerätenutzern während der Gerätebereitstellung dieser Organisationsname angezeigt.
|
contactEmail |
string
Erforderlich. Die E-Mail-Adresse, an die Gerätenutzer wenden können, um Hilfe zu erhalten. Bei der kontaktlosen Registrierung wird Gerätenutzern diese E-Mail-Adresse vor der Gerätebereitstellung angezeigt. Der Wert wird bei der Eingabe validiert.
|
contactPhone |
string
Erforderlich. Die Telefonnummer, unter der Gerätenutzer mit einem anderen Gerät anrufen können, um Hilfe zu erhalten. Bei der Zero-Touch-Registrierung wird Gerätenutzern diese Nummer vor der Gerätebereitstellung angezeigt. Akzeptiert Ziffern, Leerzeichen, Pluszeichen, Bindestriche und Klammern.
|
customMessage |
string
Eine Nachricht mit ein bis zwei Sätzen, um Gerätenutzern zu helfen, Hilfe zu erhalten oder ihnen mehr Informationen darüber zu geben, was mit ihrem Gerät geschieht. Bei der Zero-Touch-Registrierung wird diese Nachricht angezeigt, bevor das Gerät bereitgestellt wird.
|
isDefault |
boolean
Erforderlich. Gibt an, ob dies die Standardkonfiguration ist, die die Zero-Touch-Registrierung auf alle neuen Geräte angewendet, die die Organisation künftig kauft. Es kann nur eine Kundenkonfiguration als Standard festgelegt werden. Wenn Sie diesen Wert auf true setzen, wird der isDefault -Wert der vorherigen Standardkonfiguration in false geändert.
|
forcedResetTime |
string (Duration format)
Optional. Zeitlimit vor dem Erzwingen des Zurücksetzens auf die Werkseinstellungen, wenn das Gerät nicht im Einrichtungsassistenten bereitgestellt wird. Dies ist in der Regel auf eine fehlende Netzwerkverbindung während des Einrichtungsassistenten zurückzuführen. Der Bereich liegt zwischen 0 und 6 Stunden, wobei 2 Stunden als Standardeinstellung verwendet werden, wenn kein Wert festgelegt wird. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s ". Beispiel: "3.5s" .
|
Methoden |
|
Erstellt eine neue Konfiguration. |
|
Löscht eine nicht verwendete Konfiguration. |
|
Ruft die Details einer Konfiguration ab. |
|
Listet die Konfigurationen eines Kunden auf. |
|
Aktualisiert die Feldwerte einer Konfiguration. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]