REST Resource: customers.configurations
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
ทรัพยากร: การกำหนดค่า
การกำหนดค่าจะรวบรวมตัวเลือกการจัดสรรสำหรับอุปกรณ์ Android ซึ่งการกำหนดค่าแต่ละแบบจะประกอบด้วยรายการต่อไปนี้
- เครื่องมือควบคุมนโยบายด้านอุปกรณ์ (DPC) ของ EMM ที่ติดตั้งในอุปกรณ์
- นโยบายของ 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
ต้องระบุ ชื่อย่อที่อธิบายวัตถุประสงค์ของการกำหนดค่า เช่น ทีมขายหรือพนักงานชั่วคราว พอร์ทัลการตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะแสดงชื่อนี้แก่ผู้ดูแลระบบไอที
|
dpcResourcePath |
string
ต้องระบุ ชื่อทรัพยากรของ DPC ที่เลือก (เครื่องมือควบคุมนโยบายด้านอุปกรณ์) ในรูปแบบ customers/[CUSTOMER_ID]/dpcs/* โทรติดต่อ customers.dpcs.list เพื่อแสดง DPC ที่รองรับ
|
companyName |
string
ต้องระบุ ชื่อขององค์กร การตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะแสดงชื่อองค์กรนี้ต่อผู้ใช้อุปกรณ์ในระหว่างการจัดเตรียมอุปกรณ์
|
contactEmail |
string
ต้องระบุ อีเมลที่ผู้ใช้อุปกรณ์สามารถติดต่อเพื่อขอความช่วยเหลือได้ ซึ่งการตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะแสดงที่อยู่อีเมลนี้ต่อผู้ใช้อุปกรณ์ก่อนการจัดเตรียมอุปกรณ์ ระบบจะตรวจสอบค่าในอินพุต
|
contactPhone |
string
ต้องระบุ หมายเลขโทรศัพท์ที่ผู้ใช้อุปกรณ์โทรหาได้โดยใช้อุปกรณ์อื่นเพื่อขอความช่วยเหลือ การตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะแสดงหมายเลขนี้ต่อผู้ใช้อุปกรณ์ก่อนการจัดเตรียมอุปกรณ์ ยอมรับตัวเลข การเว้นวรรค เครื่องหมายบวก ขีดกลาง และวงเล็บ
|
customMessage |
string
ข้อความที่ประกอบด้วยประโยค 1 หรือ 2 ประโยค เพื่อช่วยให้ผู้ใช้อุปกรณ์ขอความช่วยเหลือหรือให้รายละเอียดเพิ่มเติมเกี่ยวกับสิ่งที่เกิดขึ้นกับอุปกรณ์ การตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะแสดงข้อความนี้ก่อนจัดเตรียมอุปกรณ์
|
isDefault |
boolean
ต้องระบุ การตั้งค่าอุปกรณ์พร้อมใช้แบบรวมกลุ่มจะมีผลกับอุปกรณ์ใหม่ที่องค์กรซื้อในอนาคตหรือไม่ กำหนดค่าลูกค้าเริ่มต้นได้เพียง 1 รายการเท่านั้น การตั้งค่านี้จะเป็น true จะเปลี่ยนค่า isDefault ของการกำหนดค่าเริ่มต้นก่อนหน้าเป็น false
|
forcedResetTime |
string (Duration format)
ไม่บังคับ ระยะหมดเวลาก่อนที่จะบังคับให้รีเซ็ตอุปกรณ์เป็นค่าเริ่มต้นหากอุปกรณ์ดำเนินการจัดสรรในวิซาร์ดการตั้งค่าไม่สำเร็จ โดยทั่วไปเกิดจากการขาดการเชื่อมต่อเครือข่ายระหว่างวิซาร์ดการตั้งค่า ช่วงเวลามีค่าตั้งแต่ 0-6 ชั่วโมง โดย 2 ชั่วโมงจะเป็นค่าเริ่มต้นหากไม่ได้ตั้งค่า ระยะเวลาเป็นวินาทีโดยมีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย "s " ตัวอย่างเช่น "3.5s"
|
เมธอด |
|
สร้างการกำหนดค่าใหม่ |
|
ลบการกำหนดค่าที่ไม่ได้ใช้ |
|
รับรายละเอียดการกำหนดค่า |
|
แสดงรายการการกำหนดค่าของลูกค้า |
|
อัปเดตค่าในช่องของการกำหนดค่า |
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 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. |"]]