Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Enterprises: getStoreLayout
Stay organized with collections
Save and categorize content based on your preferences.
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:
|
|
kind |
string |
|
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eRetrieves the store layout configuration for a given enterprise, which dictates the organization and presentation of apps in the managed Google Play Store.\u003c/p\u003e\n"],["\u003cp\u003eIf a custom layout hasn't been defined, the API defaults to a "basic" layout showcasing all approved and whitelisted applications for the user.\u003c/p\u003e\n"],["\u003cp\u003eThe 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.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope to access and retrieve the store layout information.\u003c/p\u003e\n"]]],[],null,["# Enterprises: getStoreLayout\n\n| **Note:** Requires [authorization](#auth).\n\nReturns the store layout for the enterprise. If the store layout\nhas not been set, returns \"basic\" as the store layout type and no\nhomepage.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/storeLayout\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|---------------------------|\n| **Path parameters** |||\n| `enterpriseId` | `string` | The ID of the enterprise. |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/androidenterprise` |\n\nFor more information, see the [authentication and authorization](/android/work/play/emm-api/v1/how-tos/authorizing) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"androidenterprise#storeLayout\",\n \"homepageId\": string,\n \"storeLayoutType\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `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\". | |\n| `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. \u003cbr /\u003e Acceptable values are: - \"`basic`\" - \"`custom`\" | |\n| `kind` | `string` | | |"]]