1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.storelayoutclusters.html">storelayoutclusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(enterpriseId, pageId, clusterId)</a></code></p>
79<p class="firstline">Deletes a cluster.</p>
80<p class="toc_element">
81  <code><a href="#get">get(enterpriseId, pageId, clusterId)</a></code></p>
82<p class="firstline">Retrieves details of a cluster.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(enterpriseId, pageId, body)</a></code></p>
85<p class="firstline">Inserts a new cluster in a page.</p>
86<p class="toc_element">
87  <code><a href="#list">list(enterpriseId, pageId)</a></code></p>
88<p class="firstline">Retrieves the details of all clusters on the specified page.</p>
89<p class="toc_element">
90  <code><a href="#patch">patch(enterpriseId, pageId, clusterId, body)</a></code></p>
91<p class="firstline">Updates a cluster. This method supports patch semantics.</p>
92<p class="toc_element">
93  <code><a href="#update">update(enterpriseId, pageId, clusterId, body)</a></code></p>
94<p class="firstline">Updates a cluster.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="delete">delete(enterpriseId, pageId, clusterId)</code>
98  <pre>Deletes a cluster.
99
100Args:
101  enterpriseId: string, The ID of the enterprise. (required)
102  pageId: string, The ID of the page. (required)
103  clusterId: string, The ID of the cluster. (required)
104</pre>
105</div>
106
107<div class="method">
108    <code class="details" id="get">get(enterpriseId, pageId, clusterId)</code>
109  <pre>Retrieves details of a cluster.
110
111Args:
112  enterpriseId: string, The ID of the enterprise. (required)
113  pageId: string, The ID of the page. (required)
114  clusterId: string, The ID of the cluster. (required)
115
116Returns:
117  An object of the form:
118
119    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
120      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
121      "orderInPage": "A 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.
122          #
123          # 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.
124      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
125        "A String",
126      ],
127      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
128      "name": [ # 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.
129        { # A localized string with its locale.
130          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
131          "text": "A String", # The text localized in the associated locale.
132        },
133      ],
134    }</pre>
135</div>
136
137<div class="method">
138    <code class="details" id="insert">insert(enterpriseId, pageId, body)</code>
139  <pre>Inserts a new cluster in a page.
140
141Args:
142  enterpriseId: string, The ID of the enterprise. (required)
143  pageId: string, The ID of the page. (required)
144  body: object, The request body. (required)
145    The object takes the form of:
146
147{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
148    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
149    "orderInPage": "A 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.
150        #
151        # 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.
152    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
153      "A String",
154    ],
155    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
156    "name": [ # 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.
157      { # A localized string with its locale.
158        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
159        "text": "A String", # The text localized in the associated locale.
160      },
161    ],
162  }
163
164
165Returns:
166  An object of the form:
167
168    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
169      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
170      "orderInPage": "A 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.
171          #
172          # 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.
173      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
174        "A String",
175      ],
176      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
177      "name": [ # 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.
178        { # A localized string with its locale.
179          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
180          "text": "A String", # The text localized in the associated locale.
181        },
182      ],
183    }</pre>
184</div>
185
186<div class="method">
187    <code class="details" id="list">list(enterpriseId, pageId)</code>
188  <pre>Retrieves the details of all clusters on the specified page.
189
190Args:
191  enterpriseId: string, The ID of the enterprise. (required)
192  pageId: string, The ID of the page. (required)
193
194Returns:
195  An object of the form:
196
197    { # The store page resources for the enterprise.
198    "cluster": [ # A store cluster of an enterprise.
199      { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
200          "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
201          "orderInPage": "A 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.
202              #
203              # 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.
204          "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
205            "A String",
206          ],
207          "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
208          "name": [ # 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.
209            { # A localized string with its locale.
210              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
211              "text": "A String", # The text localized in the associated locale.
212            },
213          ],
214        },
215    ],
216    "kind": "androidenterprise#storeLayoutClustersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
217  }</pre>
218</div>
219
220<div class="method">
221    <code class="details" id="patch">patch(enterpriseId, pageId, clusterId, body)</code>
222  <pre>Updates a cluster. This method supports patch semantics.
223
224Args:
225  enterpriseId: string, The ID of the enterprise. (required)
226  pageId: string, The ID of the page. (required)
227  clusterId: string, The ID of the cluster. (required)
228  body: object, The request body. (required)
229    The object takes the form of:
230
231{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
232    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
233    "orderInPage": "A 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.
234        #
235        # 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.
236    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
237      "A String",
238    ],
239    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
240    "name": [ # 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.
241      { # A localized string with its locale.
242        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
243        "text": "A String", # The text localized in the associated locale.
244      },
245    ],
246  }
247
248
249Returns:
250  An object of the form:
251
252    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
253      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
254      "orderInPage": "A 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.
255          #
256          # 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.
257      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
258        "A String",
259      ],
260      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
261      "name": [ # 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.
262        { # A localized string with its locale.
263          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
264          "text": "A String", # The text localized in the associated locale.
265        },
266      ],
267    }</pre>
268</div>
269
270<div class="method">
271    <code class="details" id="update">update(enterpriseId, pageId, clusterId, body)</code>
272  <pre>Updates a cluster.
273
274Args:
275  enterpriseId: string, The ID of the enterprise. (required)
276  pageId: string, The ID of the page. (required)
277  clusterId: string, The ID of the cluster. (required)
278  body: object, The request body. (required)
279    The object takes the form of:
280
281{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
282    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
283    "orderInPage": "A 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.
284        #
285        # 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.
286    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
287      "A String",
288    ],
289    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
290    "name": [ # 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.
291      { # A localized string with its locale.
292        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
293        "text": "A String", # The text localized in the associated locale.
294      },
295    ],
296  }
297
298
299Returns:
300  An object of the form:
301
302    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
303      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
304      "orderInPage": "A 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.
305          #
306          # 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.
307      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
308        "A String",
309      ],
310      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
311      "name": [ # 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.
312        { # A localized string with its locale.
313          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
314          "text": "A String", # The text localized in the associated locale.
315        },
316      ],
317    }</pre>
318</div>
319
320</body></html>