Get App Restrictions Schema
|
|||||
|
|
||||
Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage corporate Android devices
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
enterpriseId Required |
STRING |
The ID of the enterprise |
productId Required |
STRING |
The ID of the product |
language |
STRING |
The BCP47 tag for the user's preferred language (e.g. "en-US", "de") |
= Parameter name
= Format
|
enterpriseId STRING Required The ID of the enterprise |
|
productId STRING Required The ID of the product |
|
language STRING The BCP47 tag for the user's preferred language (e.g. "en-US", "de") |
Output
This building block provides 22 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema" |
restrictions[] |
OBJECT |
A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied |
restrictions[].defaultValue |
OBJECT |
A typed value for the restriction |
restrictions[].defaultValue.type |
STRING |
The type of the value being provided |
restrictions[].defaultValue.valueBool |
BOOLEAN |
The boolean value - this will only be present if type is bool |
restrictions[].defaultValue.valueInteger |
INTEGER |
The integer value - this will only be present if type is integer |
restrictions[].defaultValue.valueMultiselect[] |
STRING |
|
restrictions[].defaultValue.valueString |
STRING |
The string value - this will be present for types string, choice and hidden |
restrictions[].description |
STRING |
A longer description of the restriction, giving more detail of what it affects |
restrictions[].entry[] |
STRING |
|
restrictions[].entryValue[] |
STRING |
|
restrictions[].key |
STRING |
The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname" |
restrictions[].nestedRestriction[] |
OBJECT |
A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied |
restrictions[].nestedRestriction[].defaultValue |
OBJECT |
A typed value for the restriction |
restrictions[].nestedRestriction[].description |
STRING |
A longer description of the restriction, giving more detail of what it affects |
restrictions[].nestedRestriction[].entry[] |
STRING |
|
restrictions[].nestedRestriction[].entryValue[] |
STRING |
|
restrictions[].nestedRestriction[].key |
STRING |
The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname" |
restrictions[].nestedRestriction[].restrictionType |
STRING |
The type of the restriction |
restrictions[].nestedRestriction[].title |
STRING |
The name of the restriction |
restrictions[].restrictionType |
STRING |
The type of the restriction |
restrictions[].title |
STRING |
The name of the restriction |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#appRestrictionsSchema" |
|
restrictions[] OBJECT A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied |
|
restrictions[].defaultValue OBJECT A typed value for the restriction |
|
restrictions[].defaultValue.type STRING The type of the value being provided |
|
restrictions[].defaultValue.valueBool BOOLEAN The boolean value - this will only be present if type is bool |
|
restrictions[].defaultValue.valueInteger INTEGER The integer value - this will only be present if type is integer |
|
restrictions[].defaultValue.valueMultiselect[] STRING |
|
restrictions[].defaultValue.valueString STRING The string value - this will be present for types string, choice and hidden |
|
restrictions[].description STRING A longer description of the restriction, giving more detail of what it affects |
|
restrictions[].entry[] STRING |
|
restrictions[].entryValue[] STRING |
|
restrictions[].key STRING The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname" |
|
restrictions[].nestedRestriction[] OBJECT A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied |
|
restrictions[].nestedRestriction[].defaultValue OBJECT A typed value for the restriction |
|
restrictions[].nestedRestriction[].description STRING A longer description of the restriction, giving more detail of what it affects |
|
restrictions[].nestedRestriction[].entry[] STRING |
|
restrictions[].nestedRestriction[].entryValue[] STRING |
|
restrictions[].nestedRestriction[].key STRING The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname" |
|
restrictions[].nestedRestriction[].restrictionType STRING The type of the restriction |
|
restrictions[].nestedRestriction[].title STRING The name of the restriction |
|
restrictions[].restrictionType STRING The type of the restriction |
|
restrictions[].title STRING The name of the restriction |