Products: getAppRestrictionsSchema

طرحی را که ویژگی های قابل تنظیم برای این محصول را تعریف می کند، بازیابی می کند. همه محصولات دارای یک طرح هستند، اما اگر هیچ پیکربندی مدیریت شده ای تعریف نشده باشد، ممکن است این طرح خالی باشد. این طرح را می توان برای پر کردن یک رابط کاربری استفاده کرد که به مدیر اجازه می دهد محصول را پیکربندی کند. برای اعمال یک پیکربندی مدیریت شده بر اساس طرح به دست آمده با استفاده از این 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)
      ]
    }
  ]
}
نام ملک ارزش توضیحات یادداشت ها
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 مقدار بولی - این فقط در صورتی وجود دارد که نوع bool باشد.
restrictions[].defaultValue. valueString string مقدار رشته - این مقدار برای انواع رشته، انتخاب و مخفی وجود خواهد داشت.
restrictions[].defaultValue. valueInteger integer مقدار صحیح - این فقط در صورتی وجود دارد که نوع عدد صحیح باشد.
restrictions[].defaultValue. valueMultiselect[] list لیست مقادیر رشته - این فقط در صورتی وجود دارد که نوع چند انتخابی باشد.
restrictions[]. nestedRestriction[] list برای محدودیت‌های bundle یا bundleArray ، فهرستی از محدودیت‌های تودرتو. یک محدودیت bundle همیشه در داخل یک محدودیت bundleArray قرار دارد و یک محدودیت bundleArray حداکثر در دو سطح عمیق است.
kind string منسوخ شده است.