REST Resource: customers.configurations
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: הגדרה
מערך הגדרות אישיות אוסף את האפשרויות של ניהול התצורה במכשירי Android. כל הגדרה אישית משלבת את הדברים הבאים:
- בקר מדיניות מכשיר ה-EMM (DPC) שמותקן במכשירים.
- כללי מדיניות EMM שנאכפים במכשירים.
- מטא-נתונים שמוצגים במכשיר כדי לעזור למשתמשים במהלך ההגדרה.
הלקוחות יכולים להוסיף כמה הגדרות שהם רוצים. עם זאת, הרשמה דרך הארגון פועלת בצורה הטובה ביותר כשלקוח מגדיר הגדרת ברירת מחדל שחלה על כל מכשיר חדש שהארגון רוכש.
| ייצוג JSON |
{
"name": string,
"configurationId": string,
"configurationName": string,
"dpcResourcePath": string,
"dpcExtras": string,
"companyName": string,
"contactEmail": string,
"contactPhone": string,
"customMessage": string,
"isDefault": boolean,
"forcedResetTime": string
} |
| שדות |
name |
string
פלט בלבד. השם של משאב ה-API בפורמט customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. הוקצתה על ידי השרת.
|
configurationId |
string (int64 format)
פלט בלבד. מזהה ההגדרה. הוקצתה על ידי השרת.
|
configurationName |
string
חובה. שם קצר שמתאר את מטרת ההגדרה. לדוגמה, צוות מכירות או עובדים זמניים. פורטל ההרשמה דרך הארגון מציג את השם הזה לאדמינים ב-IT.
|
dpcResourcePath |
string
חובה. שם המשאב של ה-DPC שנבחר (בקר מדיניות מכשירים) בפורמט customers/[CUSTOMER_ID]/dpcs/*. כדי לראות את רשימת בקרי ה-DPC הנתמכים, צריך להתקשר אל customers.dpcs.list
|
companyName |
string
חובה. השם של הארגון. הרשמה דרך הארגון מציגה את שם הארגון הזה למשתמשי המכשיר במהלך הקצאת המכשיר.
|
contactEmail |
string
חובה. כתובת האימייל שאליה המשתמשים במכשיר יכולים ליצור קשר כדי לקבל עזרה. הרשמה דרך הארגון מציגה את כתובת האימייל הזו למשתמשי המכשיר לפני הקצאת המכשיר. הערך מאומת בקלט.
|
contactPhone |
string
חובה. מספר הטלפון שאליו המשתמשים יכולים להתקשר באמצעות מכשיר אחר כדי לקבל עזרה. הרשמה דרך הארגון מציגה את המספר הזה למשתמשי המכשירים לפני הקצאת המכשיר. יכול לכלול ספרות, רווחים, סימן פלוס, מקפים וסוגריים.
|
customMessage |
string
הודעה שמכילה משפט אחד או שניים, כדי לעזור למשתמשים לקבל עזרה במכשיר או לתת להם פרטים נוספים על מה שקורה במכשיר שלהם. בהרשמה דרך הארגון מוצגת ההודעה הזו לפני הקצאת המכשיר.
|
isDefault |
boolean
חובה. האם זו הגדרת ברירת המחדל שההרשמה דרך הארגון תחול על כל מכשיר חדש שהארגון ירכוש בעתיד. רק הגדרה אחת של לקוח יכולה להיות ברירת המחדל. אם מגדירים את הערך הזה כ-true, הערך isDefault של ההגדרות האישיות הקודמות כברירת מחדל משתנה ל-false.
|
forcedResetTime |
string (Duration format)
זה שינוי אופציונלי. הזמן הקצוב לתפוגה שלפני אילוץ איפוס המכשיר להגדרות המקוריות לא עובר הקצאת הרשאות ידנית באשף ההגדרה, לרוב בגלל היעדר קישוריות לרשת במהלך אשף ההגדרה. נע בין 0 ל-6 שעות. אם לא מגדירים את ברירת המחדל, הערך שעתיים הוא שעתיים. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".
|
שיטות |
|
|
יצירת מערך הגדרות אישיות חדש. |
|
|
מחיקת מערך של הגדרות אישיות שלא בשימוש. |
|
|
קבלת הפרטים של מערך הגדרות אישיות. |
|
|
בתיבת הדו-שיח הזו מפורטים תצורות הלקוח. |
|
|
עדכון ערכי השדות של הגדרה אישית. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
