นโยบาย Chrome จะแสดงเป็นสคีมานโยบายโดย Schema Service API สคีมานโยบายแต่ละรายการมีชื่อที่ไม่ซ้ำกันเพื่อระบุ คำจำกัดความของช่องการตั้งค่าและประเภทของช่อง รวมถึงคำอธิบายการตั้งค่าที่มนุษย์อ่านได้เป็นภาษาอังกฤษ
ตัวอย่างเช่น ด้านล่างนี้คือวิธีที่ Schema Service API แสดงการตั้งค่าที่อนุญาตให้ปุ่มออกจากระบบปรากฏในถาดระบบของ Chrome ตัวแทนอย่างง่ายของการตั้งค่านี้คือ bool showLogoutButtonInTray
คลิก "แสดงตัวอย่าง" ด้านล่างเพื่อดูว่า API บริการสคีมาแสดงถึงการตั้งค่านี้อย่างไร
แสดงตัวอย่าง
{ "name": "customers/C0202nabg/policySchemas/chrome.users.ShowLogoutButton", "policyDescription": "Show logout button in tray.", // description of the policy "definition": { // definition of the settings (fields names and types) "messageType": [ { "name": "ShowLogoutButton", "field": [ { "name": "showLogoutButtonInTray", // the setting showLogoutButtonInTray "number": 1, "label": "LABEL_OPTIONAL", "type": "TYPE_BOOL" // the setting showLogoutButtonInTray is of type boolean } ] } ] }, "fieldDescriptions": [ // human readable descriptions of the settings and their values { "field": "showLogoutButtonInTray", "knownValueDescriptions": [ { "value": "true", "description": "Show logout button in tray." // description for showLogoutButtonInTray=true }, { "value": "false", "description": "Do not show logout button in tray." // description for showLogoutButtonInTray=false } ] } ], "schemaName": "chrome.users.ShowLogoutButton" // unique name to identify the policy }
ชื่อสคีมานโยบาย
name
ของสคีมาคือตัวระบุที่ไม่ซ้ำกัน โดยมีรูปแบบต่อไปนี้ {namespace}.{leafName}
ในตัวอย่างด้านบน ชื่อสคีมาแบบเต็มคือ chrome.users.ShowLogoutButton
เนมสเปซคือ chrome.users.
และชื่อ Leaf คือ ShowLogoutButton
ระบบจะจัดกลุ่มนโยบายของขอบเขตที่คล้ายกันภายใต้เนมสเปซเดียวกัน เช่น สคีมานโยบายผู้ใช้ทั้งหมดจะมีเนมสเปซ chrome.users.
นำหน้า และสคีมานโยบายเครื่องพิมพ์ทั้งหมดจะมีคำนำหน้าเป็นเนมสเปซ chrome.printers.
เนมสเปซ
เนมสเปซ | คีย์ | สิทธิ์สำหรับบทบาทผู้ดูแลระบบที่จำเป็น |
---|---|---|
chrome.users.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าของผู้ใช้ | |
chrome.users.apps.LEAF_NAME |
key="app_id" |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าของผู้ใช้ > จัดการการตั้งค่าแอปพลิเคชัน |
chrome.users.appsconfig.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าของผู้ใช้ > จัดการการตั้งค่าแอปพลิเคชัน | |
chrome.devices.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS | |
chrome.devices.managedguest.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS | |
chrome.devices.managedguest.apps.LEAF_NAME |
key="app_id" |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS |
chrome.devices.kiosk.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS | |
chrome.devices.kiosk.apps.LEAF_NAME |
key="app_id" |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS |
chrome.devices.kiosk.appsconfig.LEAF_NAME |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการการตั้งค่าอุปกรณ์ ChromeOS | |
chrome.printers.LEAF_NAME |
key="printer_id" |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการเครื่องพิมพ์ |
chrome.printservers.LEAF_NAME |
key="print_server_id" |
บริการ > การจัดการ Chrome > การตั้งค่า > จัดการเครื่องพิมพ์ |
chrome.networks.globalsettings.LEAF_NAME |
บริการ > การตั้งค่าอุปกรณ์ที่แชร์ | |
chrome.networks.wifi.LEAF_NAME |
key="network_id" |
บริการ > การตั้งค่าอุปกรณ์ที่แชร์ |
chrome.networks.ethernet.LEAF_NAME |
key="network_id" |
บริการ > การตั้งค่าอุปกรณ์ที่แชร์ |
chrome.networks.vpn.LEAF_NAME |
key="network_id" |
บริการ > การตั้งค่าอุปกรณ์ที่แชร์ |
chrome.networks.certificates.LEAF_NAME |
key="network_id" |
บริการ > การตั้งค่าอุปกรณ์ที่แชร์ |
คีย์สคีมานโยบาย
บางนโยบายจำเป็นต้องมีบริบทเพิ่มเติมจึงจะดูหรือแก้ไขได้ เช่น
- หากต้องการแก้ไขนโยบายสำหรับแอปพลิเคชัน คุณต้องระบุแอปพลิเคชันด้วยการป้อน
key="app_id"
- หากต้องการแก้ไขนโยบายสำหรับการตั้งค่าเครื่องพิมพ์ในหน่วยขององค์กร คุณต้องระบุเครื่องพิมพ์โดยเติมข้อมูล
key="printer_id"
สคีมาของนโยบายเหล่านี้มีส่วน additionalTargetKeyNames
ที่อธิบายคีย์และค่าที่จะส่งในคำขอ API
ดูรายละเอียดเพิ่มเติมได้ที่ตัวอย่างโค้ด
แสดงตัวอย่าง
{ "name": "customers/C0202nabg/policySchemas/chrome.printers.AllowForUsers", "policyDescription": "Allows a printer for users in a given organization.", "additionalTargetKeyNames": [ { "key": "printer_id", "keyDescription": "Id of printer as visible in Admin SDK printers API." } ], "definition": { "messageType": [ { "name": "AllowForUsers", "field": [ { "name": "allowForUsers", "number": 1, "label": "LABEL_OPTIONAL", "type": "TYPE_BOOL" } ] } ] }, "fieldDescriptions": [ { "field": "allowForUsers", "description": "Controls whether a printer is allowed for users in a given organization." } ], "schemaName": "chrome.printers.AllowForUsers" }
นโยบายแอป
เนมสเปซข้างต้นบางส่วนมีไว้สำหรับนโยบายแอป เช่น แอปของผู้ใช้ แอปคีออสก์ แอปเซสชันผู้เยี่ยมชมที่มีการจัดการ และนโยบายการกำหนดค่าแอปคีออสก์ นโยบายแอปกำหนดให้มี
app_id
app_id
สร้างขึ้นจากการรวมประเภทแอปและตัวระบุแอป เช่น
chrome:mkaakpdehdafacodkgkpghoibnmamcme
แสดงถึงแอป Chrome "Google วาดเขียน"android:com.google.android.calendar
แสดงถึงแอป Android "Google ปฏิทิน"web:https://canvas.apps.chrome
แสดงถึงเว็บแอป "Canvas"
ช่องหลายค่า
ช่องที่มีป้ายกำกับ LABEL_REPEATED
หมายถึงช่องที่มีหลายค่า เช่น รายการหรืออาร์เรย์ โดยคุณระบุค่าหลายค่าให้กับช่องเหล่านี้ได้ ดูรายละเอียดเพิ่มเติมได้ที่ตัวอย่างโค้ด
สถานะสคีมานโยบาย
ทุกนโยบายมีออบเจ็กต์ policyApiLifecycle
เพื่อแสดงสถานะปัจจุบัน
ออบเจ็กต์นี้มีช่องต่อไปนี้ที่มีรายละเอียดเกี่ยวกับสถานะของนโยบาย
- ช่อง
policyApiLifecycleStage
จะแสดงขั้นตอนในตารางต่อไปนี้ที่อธิบายสถานะปัจจุบันของนโยบายได้ดีที่สุด - ช่อง
description
จะให้รายละเอียดเพิ่มเติมเกี่ยวกับสถานะปัจจุบันของนโยบายนี้ - ช่อง
endSupport
จะแสดงวันที่สนับสนุนสุดท้ายสำหรับนโยบาย หากมีการกำหนดนโยบายไว้ - ตั้งค่า
deprecatedInFavorOf
ได้ก็ต่อเมื่อ policyApiLifecycleStage เป็น API_DEPRECATED โดยจะแสดงเนมสเปซที่สมบูรณ์ในตัวเองของนโยบายใหม่ที่เลิกใช้งานนโยบายปัจจุบัน - ช่อง
scheduledToDeprecatePolicies
จะสอดคล้องกับ deprecatedInFavorOf โดยจะแสดงเนมสเปซที่สมบูรณ์ในตัวเองของนโยบายเก่าที่จะเลิกใช้งานเนื่องจากมีการเริ่มใช้นโยบายนี้
ขั้นของวงจร
ระยะทำงาน | คำอธิบาย |
---|---|
API_UNSPECIFIED |
ไม่ทราบสถานะปัจจุบันของนโยบาย สงวนไว้ อย่าใช้ |
API_PREVIEW |
นโยบายยังใช้งานไม่ได้ ขั้นตอนนี้สามารถโอนไปยัง API_CURRENT หรือ API_DEVELOPMENT ได้ |
API_DEVELOPMENT |
ยังไม่ได้สรุปนโยบายและอาจมีการนำการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นมาใช้แทน ขั้นตอนนี้สามารถโอนไปยัง API_CURRENT หรือ API_DEPRECATED ได้ |
API_CURRENT |
นโยบายต่างๆ อยู่ในรูปแบบอย่างเป็นทางการ แต่อาจมีการเปลี่ยนแปลงโดยไม่ถือเป็นการละเมิดได้ ระยะนี้สามารถโอนไปยัง API_DEPRECATED ได้ |
API_DEPRECATED |
เราเลิกใช้งานนโยบายนี้แล้วและอาจมีการนำออกในอนาคต ผู้ดูแลระบบควรหยุดใช้นโยบายนี้ |
แสดงตัวอย่าง
{ "name": "customers/C0202nabg/policySchemas/chrome.users.OutdatedPolicy", "policyDescription": "Just for demo, this is an outdated policy.", "definition": { "messageType": [ { "name": "OutdatedPolicy", "field": [ { "name": "outdatedField", "number": 1, "label": "LABEL_OPTIONAL", "type": "TYPE_BOOL" } ] } ] }, "fieldDescriptions": [ { "field": "outdatedField", "description": "This is an outdated field" } ], "schemaName": "chrome.users.OutdatedPolicy", "policyApiLifecycle": { // policy's current lifecycle status "policyApiLifecycleStage": "API_DEPRECATED", "description": "This policy is deprecated. Please stop using it", "endSupport": { "year": 2021, "month": 2, "day": 29 } "deprecatedInFavorOf": "chrome.users.NewPolicy" } } { "name": "customers/C0202nabg/policySchemas/chrome.users.NewPolicy", "policyDescription": "Just for demo, this is a new policy.", "definition": { "messageType": [ { "name": "NewPolicy", "field": [ { "name": "newField", "number": 1, "label": "LABEL_OPTIONAL", "type": "TYPE_BOOL" } ] } ] }, "fieldDescriptions": [ { "field": "newField", "description": "This is an new field" } ], "schemaName": "chrome.users.NewPolicy", "policyApiLifecycle": { // policy's current lifecycle status "policyApiLifecycleStage": "API_CURRENT, "scheduledToDeprecatePolicies": "chrome.users.OutdatedPolicy" } }
ประกาศสคีมานโยบาย
นโยบายบางรายการมี notices
ที่เชื่อมโยงอยู่โดยกำหนด acknowledgement_required
เป็น true
สำหรับค่าบางค่าของช่องนโยบายบางช่อง สำหรับนโยบายเหล่านี้ คุณต้องตั้งค่าช่องการรับทราบพิเศษเป็น true
ก่อนจึงจะกำหนดค่าได้
ดูรายละเอียดเพิ่มเติมได้ที่ตัวอย่างโค้ด
แพลตฟอร์มที่รองรับ
supportedPlatforms
คือรายการที่ระบุว่านโยบายจะมีผลเฉพาะกับอุปกรณ์หรือผู้ใช้ในแพลตฟอร์มเหล่านี้ แพลตฟอร์มที่รองรับทั้งหมดแสดง
ในตารางต่อไปนี้
แพลตฟอร์มที่รองรับ
แพลตฟอร์ม | คำอธิบาย |
---|---|
PLATFORM_UNSPECIFIED |
แพลตฟอร์มที่ไม่ได้ระบุ สงวนไว้ อย่าใช้ |
CHROME_OS |
ChromeOS |
CHROME_BROWSER |
เบราว์เซอร์ Chrome สำหรับ macOS/Windows/Linux |
CHROME_BROWSER_FOR_ANDROID |
เบราว์เซอร์ Chrome สำหรับ Android |
CHROME_BROWSER_FOR_IOS |
เบราว์เซอร์ Chrome สำหรับ iOS |