Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Enterprises: setStoreLayout
Stay organized with collections
Save and categorize content based on your preferences.
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:
|
|
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:
|
|
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\u003eDefines the enterprise's store layout, defaulting to "basic" which displays admin-approved and whitelisted apps sorted by product ID.\u003c/p\u003e\n"],["\u003cp\u003eSetting a custom homepage using \u003ccode\u003ehomepageId\u003c/code\u003e changes the \u003ccode\u003estoreLayoutType\u003c/code\u003e to "custom" and overrides the basic layout.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003estoreLayoutType\u003c/code\u003e can be either "basic" or "custom", determining the store's layout structure.\u003c/p\u003e\n"]]],[],null,["# Enterprises: setStoreLayout\n\n| **Note:** Requires [authorization](#auth).\n\nSets the store layout for the enterprise. By default, storeLayoutType\nis set to \"basic\" and the basic store layout is enabled. The basic\nlayout only contains apps approved by the admin, and that have\nbeen added to the available product set for a user (using the\n[setAvailableProductSet](/android/work/play/emm-api/v1/users/setAvailableProductSet) call). Apps on the page are sorted in order of\ntheir product ID value. If you create a custom store layout (by setting\nstoreLayoutType = \"custom\" and setting a homepage), the basic store\nlayout is disabled.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT 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\nIn the request body, supply data 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` | | |\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` | | |"]]