getAppRestrictionsSchema method

Future<AppRestrictionsSchema> getAppRestrictionsSchema(String enterpriseId, String productId, { String? language, String? $fields, })

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.

Request parameters:

enterpriseId - The ID of the enterprise.

productId - The ID of the product.

language - The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

$fields - Selector specifying which fields to include in a partial response.

Completes with a AppRestrictionsSchema.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<AppRestrictionsSchema> getAppRestrictionsSchema(
  core.String enterpriseId,
  core.String productId, {
  core.String? language,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (language != null) 'language': [language],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'androidenterprise/v1/enterprises/' +
      commons.escapeVariable('$enterpriseId') +
      '/products/' +
      commons.escapeVariable('$productId') +
      '/appRestrictionsSchema';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return AppRestrictionsSchema.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}