Products: getAppRestrictionsSchema

このプロダクトの構成可能なプロパティを定義するスキーマを取得します。すべての商品にはスキーマがありますが、管理対象の設定が定義されていない場合は、このスキーマを空にできます。このスキーマを使用すると、管理者がプロダクトを構成できる UI を作成できます。この API を使用して取得したスキーマに基づいて管理対象設定を適用するには、Play による管理対象設定をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/products/productId/appRestrictionsSchema

パラメータ

パラメータ名 価値 説明
パスパラメータ
enterpriseId string 企業の ID。
productId string 商品の ID。
省略可能なクエリ パラメータ
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 制限の場合、可能性のあるエントリの機械可読値のリスト。これらの値は、構成で、choice 制限の場合は単一の string 値として使用するか、multiselect 制限の場合は stringArray で使用する必要があります。
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 文字列値 - これは型が string、choice、非表示の場合に存在します。
restrictions[].defaultValue.valueInteger integer 整数値 - タイプが整数の場合にのみ存在します。
restrictions[].defaultValue.valueMultiselect[] list 文字列値のリスト - タイプが複数選択の場合にのみ存在します。
restrictions[].nestedRestriction[] list bundle または bundleArray 制限の場合、ネストされた制限のリスト。bundle 制限は常に bundleArray 制限内にネストされ、bundleArray 制限は 2 レベル以下の深さになります。
kind string 非推奨。