เรียกข้อมูลสคีมาที่กำหนดพร็อพเพอร์ตี้ที่กำหนดค่าได้สำหรับผลิตภัณฑ์นี้ ผลิตภัณฑ์ทั้งหมดมีสคีมา แต่สคีมานี้อาจว่างเปล่าหากไม่มีการกำหนดค่าที่มีการจัดการ สคีมานี้ใช้เพื่อสร้าง UI ที่อนุญาตให้ผู้ดูแลระบบกำหนดค่าผลิตภัณฑ์ได้
หากต้องการใช้การกำหนดค่าที่มีการจัดการตามสคีมาที่ได้รับมาโดยใช้ API นี้ โปรดดูการกำหนดค่าที่มีการจัดการผ่าน Play
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/products/productId/appRestrictionsSchema
พารามิเตอร์
ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
---|---|---|
พารามิเตอร์เส้นทาง | ||
enterpriseId |
string |
รหัสขององค์กร |
productId |
string |
รหัสของผลิตภัณฑ์ |
พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
language |
string |
แท็ก BCP47 สำหรับภาษาที่ต้องการของผู้ใช้ (เช่น "en-US", "de") |
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์ตามขอบเขตต่อไปนี้
ขอบเขต |
---|
https://www.googleapis.com/auth/androidenterprise |
สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
โปรดอย่าให้เนื้อหาคำขอตามวิธีการนี้
คำตอบ
หากสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับซึ่งมีโครงสร้างต่อไปนี้
{ "kind": string, "restrictions": [ { "key": string, "title": string, "restrictionType": string, "description": string, "entry": [ string ], "entryValue": [ string ], "defaultValue": { "type": string, "valueBool": boolean, "valueString": string, "valueInteger": integer, "valueMultiselect": [ string ] }, "nestedRestriction": [ (AppRestrictionsSchemaRestriction) ] } ] }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
restrictions[] |
list |
ชุดของข้อจำกัดที่ประกอบขึ้นเป็นสคีมานี้ | |
restrictions[].key |
string |
คีย์ที่ไม่ซ้ำกันที่ผลิตภัณฑ์ใช้ระบุข้อจำกัด เช่น "com.google.android.gm.fieldname" | |
restrictions[].title |
string |
ชื่อของข้อจำกัด | |
restrictions[].restrictionType |
string |
ประเภทของข้อจำกัด
ค่าที่ยอมรับได้ มีดังนี้
|
|
restrictions[].description |
string |
คำอธิบายข้อจำกัดที่ยาวขึ้น ให้รายละเอียดเพิ่มเติมเกี่ยวกับผลกระทบจากผลกระทบ | |
restrictions[].entry[] |
list |
สำหรับข้อจำกัด choice หรือ multiselect รายการชื่อที่เป็นไปได้ซึ่งมนุษย์อ่านได้ |
|
restrictions[].entryValue[] |
list |
สำหรับข้อจำกัด choice หรือ multiselect รายการค่าที่เป็นไปได้ที่เครื่องอ่านได้ ควรใช้ค่าเหล่านี้ในการกำหนดค่า ไม่ว่าจะเป็นค่า string ค่าเดียวสำหรับข้อจำกัด choice หรือใน stringArray สำหรับข้อจำกัด multiselect |
|
restrictions[].defaultValue |
nested object |
ค่าเริ่มต้นของข้อจำกัด การจำกัด bundle และ bundleArray ไม่มีค่าเริ่มต้น |
|
restrictions[].defaultValue.type |
string |
ประเภทของค่าที่ระบุ
ค่าที่ยอมรับได้ มีดังนี้
|
|
restrictions[].defaultValue.valueBool |
boolean |
ค่าบูลีน - ค่านี้จะแสดงเมื่อประเภทเป็นบูลีนเท่านั้น | |
restrictions[].defaultValue.valueString |
string |
ค่าสตริง - ค่านี้จะปรากฏสำหรับสตริงประเภท ตัวเลือก และค่าที่ซ่อน | |
restrictions[].defaultValue.valueInteger |
integer |
ค่าจำนวนเต็ม - ค่านี้จะปรากฏก็ต่อเมื่อประเภทเป็นจำนวนเต็ม | |
restrictions[].defaultValue.valueMultiselect[] |
list |
รายการค่าสตริง - จะปรากฏต่อเมื่อประเภทคือการเลือกหลายรายการเท่านั้น | |
restrictions[].nestedRestriction[] |
list |
สำหรับข้อจำกัด bundle หรือ bundleArray รายการข้อจำกัดที่ฝังอยู่ การจำกัด bundle จะซ้อนอยู่ในการจำกัด bundleArray เสมอ และการจำกัด bundleArray มีความลึกไม่เกิน 2 ระดับ |
|
kind |
string |
เลิกใช้งานแล้ว |