REST Resource: customers.configurations
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: konfiguracja
Konfiguracja zbiera opcje obsługi administracyjnej urządzeń z Androidem. Każda konfiguracja obejmuje te elementy:
- kontroler zasad dotyczących urządzeń EMM (DPC) zainstalowany na urządzeniach;
- Zasady EMM egzekwowane na urządzeniach.
- Metadane wyświetlane na urządzeniu, które ułatwiają użytkownikom konfigurację.
Klienci mogą dodać dowolną liczbę konfiguracji. Rejestracja typu zero-touch działa jednak najlepiej, gdy klient ustawi domyślną konfigurację stosowaną na wszystkich nowych urządzeniach kupionych przez organizację.
| Zapis JSON |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
| Pola |
name |
string
Tylko dane wyjściowe. Nazwa zasobu interfejsu API w formacie customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Przypisana przez serwer.
|
configurationId |
string (int64 format)
Tylko dane wyjściowe. Identyfikator konfiguracji. Przypisana przez serwer.
|
configurationName |
string
Wymagane. Krótka nazwa opisująca przeznaczenie konfiguracji. Na przykład Zespół sprzedaży lub Pracownicy tymczasowi. W portalu rejestracji typu zero-touch ta nazwa jest wyświetlana administratorom IT.
|
dpcResourcePath |
string
Wymagane. Nazwa zasobu wybranego DPC (kontrolera zasad urządzeń) w formacie customers/[CUSTOMER_ID]/dpcs/*. Aby wyświetlić listę obsługiwanych platform DPC, wywołaj customers.dpcs.list
|
companyName |
string
Wymagane. Nazwa organizacji. Rejestracja typu zero-touch będzie wyświetlać tę nazwę organizacji użytkownikom urządzenia podczas obsługi administracyjnej urządzenia.
|
contactEmail |
string
Wymagane. Adres e-mail, z którego użytkownicy urządzeń mogą się kontaktować, aby uzyskać pomoc. Rejestracja typu Zero-Touch wyświetla ten adres e-mail użytkownikom przed rozpoczęciem obsługi administracyjnej urządzenia. Wartość jest weryfikowana na podstawie wpisanej wartości.
|
contactPhone |
string
Wymagane. Numer telefonu, pod który użytkownicy mogą zadzwonić z innego urządzenia, aby uzyskać pomoc. Rejestracja typu zero-touch wyświetla ten numer użytkownikom przed rozpoczęciem obsługi administracyjnej urządzenia. Może zawierać cyfry, spacje, znak plusa, łączniki i nawiasy.
|
customMessage |
string
Komunikat składający się z 1 lub 2 zdań, który ma pomóc użytkownikom urządzenia uzyskać pomoc lub przekazać więcej informacji o tym, co dzieje się z urządzeniem. Rejestracja typu zero-touch wyświetla tę wiadomość przed rozpoczęciem obsługi administracyjnej urządzenia.
|
isDefault |
boolean
Wymagane. Określa, czy jest to domyślna konfiguracja, którą rejestracja typu zero-touch będzie stosować na wszystkich nowych urządzeniach, które kupi organizacja w przyszłości. Domyślną może być tylko jedna konfiguracja klienta. Ustawienie tej wartości na true zmienia wartość isDefault poprzedniej konfiguracji domyślnej na false.
|
forcedResetTime |
string (Duration format)
Opcjonalnie: Czas oczekiwania przed wymuszeniem przywrócenia urządzenia do ustawień fabrycznych, jeśli nie zostanie przeprowadzona obsługa administracyjna urządzenia w kreatorze konfiguracji, zazwyczaj z powodu braku połączenia sieciowego podczas tworzenia kreatora konfiguracji. Ma zakres od 0 do 6 godzin. Jeśli nie jest skonfigurowana, wartością domyślną jest 2 godziny. Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
|
Metody |
|
|
Tworzy nową konfigurację. |
|
|
Usuwa nieużywaną konfigurację. |
|
|
Pobiera szczegóły konfiguracji. |
|
|
Wyświetla listę konfiguracji klienta. |
|
|
Aktualizuje wartości pól konfiguracji. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
