Products: getAppRestrictionsSchema

אחזור הסכימה שמגדירה את המאפיינים שאפשר להגדיר למוצר הזה. לכל המוצרים יש סכימה, אבל אם לא הוגדרו הגדרות מנוהלות, הסכימה הזו יכולה להיות ריקה. אפשר להשתמש בסכימה הזו כדי לאכלס ממשק משתמש שמאפשר לאדמין להגדיר את המוצר. במאמר הגדרות מנוהלות דרך Play תוכלו לקרוא איך מחילים הגדרה מנוהלת שמבוססת על הסכימה שהתקבלה באמצעות ה-API הזה.

בקשה

בקשת 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)
      ]
    }
  ]
}
שם הנכס ערך תיאור הערות
restrictions[] list קבוצת ההגבלות שמהן מורכב הסכימה הזו.
restrictions[].key string המפתח הייחודי שבו המוצר משתמש לזיהוי ההגבלה, למשל com.google.android.gm.fieldname.
restrictions[].title string שם ההגבלה.
restrictions[].restrictionType string סוג ההגבלה.

הערכים הקבילים הם:
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "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 סוג הערך שצוין.

הערכים הקבילים הם:
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "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 נמצאת עמוקה לכל היותר בשתי רמות.
kind string הוצא משימוש.