Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Storelayoutpages
Stay organized with collections
Save and categorize content based on your preferences.
A Storelayoutpages resource represents a single page of the enterprise's Google Play for Work store. Each page can have up to 30 store clusters (groups of related products), and the store can have up to 100 pages.
The display information provided for each page includes the page's localized name and links to other pages in the store, which are displayed as quick links at the top of the page. Each store must have one designated homepage, which you set using the Enterprises.setStoreLayout method of the Enterprises resource. The homepage should include links to all the other pages in the store.
The Store Layout Design guide has information on how to design a store layout, including how to create a store page.
For a list of methods for this resource, see the end of this page.
Resource representations
Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
{
"kind": "androidenterprise#storePage",
"id": string,
"name": [
{
"locale": string,
"text": string
}
],
"link": [
string
]
}
Property name |
Value |
Description |
Notes |
id |
string |
Unique ID of this page. Assigned by the server. Immutable once assigned. |
|
kind |
string |
|
|
link[] |
list |
Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages.
The API doesn't verify that the pages exist or the pages are reachable. |
|
name[] |
list |
Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry. |
|
name[].locale |
string |
The BCP47 tag for a locale. (e.g. "en-US", "de"). |
|
name[].text |
string |
The text localized in the associated locale. |
|
Methods
- delete
- Deletes a store page.
- get
- Retrieves details of a store page.
- insert
- Inserts a new store page.
- list
- Retrieves the details of all pages in the store.
- update
- Updates the content of a store page.
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\u003eA Storelayoutpages resource represents a single page within a Google Play for Work store, which can contain up to 30 store clusters and link to other pages.\u003c/p\u003e\n"],["\u003cp\u003eEach store must have a designated homepage, accessible via the Enterprises.setStoreLayout method, that links to all other store pages for navigation.\u003c/p\u003e\n"],["\u003cp\u003ePages are identified by unique IDs, display localized names, and include links to other relevant pages within the store structure.\u003c/p\u003e\n"],["\u003cp\u003eStorelayoutpages resources can be managed using methods like insert, delete, get, list, and update to control their content and organization.\u003c/p\u003e\n"]]],[],null,["# Storelayoutpages\n\n\u003cbr /\u003e\n\nA Storelayoutpages resource represents a single page of the enterprise's Google Play for Work store. Each page can have up to 30 [store clusters](/android/work/play/emm-api/v1/storelayoutclusters) (groups of related products), and the store can have up to 100 pages.\n\nThe display information provided for each page includes the page's localized name and links to other pages in the store, which are displayed as quick links at the top of the page. Each store must have one designated homepage, which you set using the [Enterprises.setStoreLayout](/android/work/play/emm-api/v1/enterprises/setStoreLayout) method of the Enterprises resource. The homepage should include links to all the other pages in the store.\n\nThe [Store Layout Design](/android/work/play/emm-api/store-layout) guide has information on how to design a store layout, including how to create a store page.\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\nDefinition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.\n\n```text\n{\n \"kind\": \"androidenterprise#storePage\",\n \"id\": string,\n \"name\": [\n {\n \"locale\": string,\n \"text\": string\n }\n ],\n \"link\": [\n string\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|-----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `id` | `string` | Unique ID of this page. Assigned by the server. Immutable once assigned. | |\n| `kind` | `string` | | |\n| `link[]` | `list` | Ordered list of pages a user should be able to reach from this page. The list can't include this page. It is recommended that the basic pages are created first, before adding the links between pages. The API doesn't verify that the pages exist or the pages are reachable. | |\n| `name[]` | `list` | Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry. | |\n| name[].`locale` | `string` | The BCP47 tag for a locale. (e.g. \"en-US\", \"de\"). | |\n| name[].`text` | `string` | The text localized in the associated locale. | |\n\nMethods\n-------\n\n[delete](/android/work/play/emm-api/v1/storelayoutpages/delete)\n: Deletes a store page.\n\n[get](/android/work/play/emm-api/v1/storelayoutpages/get)\n: Retrieves details of a store page.\n\n[insert](/android/work/play/emm-api/v1/storelayoutpages/insert)\n: Inserts a new store page.\n\n[list](/android/work/play/emm-api/v1/storelayoutpages/list)\n: Retrieves the details of all pages in the store.\n\n[update](/android/work/play/emm-api/v1/storelayoutpages/update)\n: Updates the content of a store page."]]