Enterprises: getStoreLayout

  • Retrieves the store layout configuration for a given enterprise, which dictates the organization and presentation of apps in the managed Google Play Store.

  • If a custom layout hasn't been defined, the API defaults to a "basic" layout showcasing all approved and whitelisted applications for the user.

  • The layout can be customized by specifying a homepage ID, leading to a "custom" layout type, enabling control over the initial page displayed in the store.

  • Requires authorization with the https://www.googleapis.com/auth/androidenterprise scope to access and retrieve the store layout information.

Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.

Request

HTTP request

GET 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

Do not supply a request body with this method.

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