Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Storelayoutclusters
Stay organized with collections
Save and categorize content based on your preferences.
A Storelayoutclusters resource represents a list of products displayed together as a group on a Google Play for Work store page. Each page can have up to 30 clusters, and each cluster can have up to 100 products.
The display information provided for each cluster includes the cluster's localized name, a list of apps, and the placement of the cluster within its parent page (orderInPage).
The Store Layout Design guide has information on how to design a store layout, including how to create a store cluster.
For a list of methods for this resource, see the end of this page.
Resource representations
Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
{
"kind": "androidenterprise#storeCluster",
"id": string,
"name": [
{
"locale": string,
"text": string
}
],
"productId": [
string
],
"orderInPage": string
}
| Property name |
Value |
Description |
Notes |
id |
string |
Unique ID of this cluster. Assigned by the server. Immutable once assigned. |
|
kind |
string |
|
|
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. |
|
orderInPage |
string |
String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. |
|
productId[] |
list |
List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. |
|
Methods
- delete
- Deletes a cluster.
- get
- Retrieves details of a cluster.
- insert
- Inserts a new cluster in a page.
- list
- Retrieves the details of all clusters on the specified page.
- update
- Updates a cluster.
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\u003eStorelayoutclusters represent groups of products (up to 100) displayed on Google Play for Work store pages.\u003c/p\u003e\n"],["\u003cp\u003eEach store page can contain up to 30 clusters, organized by \u003ccode\u003eorderInPage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eClusters are defined by a localized name, a list of products (\u003ccode\u003eproductId\u003c/code\u003e), and their placement on the page.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage clusters using methods like insert, delete, update, get, and list to customize store layouts.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the Store Layout Design guide for creating effective store layouts and clusters.\u003c/p\u003e\n"]]],[],null,["# Storelayoutclusters\n\n\u003cbr /\u003e\n\nA Storelayoutclusters resource represents a list of products displayed together as a group on a [Google Play for Work store](/android/work/play/emm-api/v1/storelayoutpages) page. Each page can have up to 30 clusters, and each cluster can have up to 100 products.\n\nThe display information provided for each cluster includes the cluster's localized name, a list of apps, and the placement of the cluster within its parent page (`orderInPage`).\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 cluster.\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 cluster, a list of products displayed as part of a store page.\n\n```text\n{\n \"kind\": \"androidenterprise#storeCluster\",\n \"id\": string,\n \"name\": [\n {\n \"locale\": string,\n \"text\": string\n }\n ],\n \"productId\": [\n string\n ],\n \"orderInPage\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|-----------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `id` | `string` | Unique ID of this cluster. Assigned by the server. Immutable once assigned. | |\n| `kind` | `string` | | |\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| `orderInPage` | `string` | String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. | |\n| `productId[]` | `list` | List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. | |\n\nMethods\n-------\n\n[delete](/android/work/play/emm-api/v1/storelayoutclusters/delete)\n: Deletes a cluster.\n\n[get](/android/work/play/emm-api/v1/storelayoutclusters/get)\n: Retrieves details of a cluster.\n\n[insert](/android/work/play/emm-api/v1/storelayoutclusters/insert)\n: Inserts a new cluster in a page.\n\n[list](/android/work/play/emm-api/v1/storelayoutclusters/list)\n: Retrieves the details of all clusters on the specified page.\n\n[update](/android/work/play/emm-api/v1/storelayoutclusters/update)\n: Updates a cluster."]]