Enterprises: setStoreLayout

    • This method requires authorization.

    • Sets the store layout for an enterprise, which can be either "basic" or "custom".

    • The basic layout includes approved apps added to the available product set for a user, while a custom layout is enabled by setting storeLayoutType to "custom" and providing a homepageId .

    • The request uses a PUT HTTP method and requires the enterpriseId path parameter.

    • The response structure includes the kind , homepageId , and storeLayoutType of the store layout.

    Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.

    Request

    HTTP request

    PUT https://www.googleapis.com/androidenterprise/v1/enterprises/ enterpriseId 
/storeLayout

    Parameters

    Parameter name
    Value
    Description
    Path parameters
    enterpriseId
    string
    The ID of the enterprise.

    Authorization

    This request requires authorization with the following scope:

    Scope
    https://www.googleapis.com/auth/androidenterprise

    For more information, see the authentication and authorization page.

    Request body

    In the request body, supply data with the following structure:

    {
  "kind": "androidenterprise#storeLayout",
  "homepageId": string 
,
  "storeLayoutType": string 
}
    Property name
    Value
    Description
    Notes
    homepageId
    string
    The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store.

    Not specifying a homepage is equivalent to setting the store layout type to "basic".
    storeLayoutType
    string
    The store layout type. By default, this value is set to "basic" if the homepageId field is not set, and to "custom" otherwise. If set to "basic", the layout will consist of all approved apps that have been whitelisted for the user.

    Acceptable values are:
    • " basic "
    • " custom "
    kind
    string

    Response

    If successful, this method returns a response body with the following structure:

    {
  "kind": "androidenterprise#storeLayout",
  "homepageId": string 
,
  "storeLayoutType": string 
}
    Property name
    Value
    Description
    Notes
    homepageId
    string
    The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store.

    Not specifying a homepage is equivalent to setting the store layout type to "basic".
    storeLayoutType
    string
    The store layout type. By default, this value is set to "basic" if the homepageId field is not set, and to "custom" otherwise. If set to "basic", the layout will consist of all approved apps that have been whitelisted for the user.

    Acceptable values are:
    • " basic "
    • " custom "
    kind
    string
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: