Debian Codegraph @

docs/dyn/androidenterprise_v1.storelayoutclusters.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(enterpriseId, pageId, clusterId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes a cluster.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(enterpriseId, pageId, clusterId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves details of a cluster.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(enterpriseId, pageId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Inserts a new cluster in a page.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(enterpriseId, pageId, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the details of all clusters on the specified page.</p>
92 <p class="toc_element">
93 <code><a href="#update">update(enterpriseId, pageId, clusterId, body=None, x__xgafv=None)</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="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="delete">delete(enterpriseId, pageId, clusterId, x__xgafv=None)</code>
103 <pre>Deletes a cluster.
104
105 Args:
106 enterpriseId: string, The ID of the enterprise. (required)
107 pageId: string, The ID of the page. (required)
108 clusterId: string, The ID of the cluster. (required)
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113 </pre>
114 </div>
115
116 <div class="method">
117 <code class="details" id="get">get(enterpriseId, pageId, clusterId, x__xgafv=None)</code>
118 <pre>Retrieves details of a cluster.
119
120 Args:
121 enterpriseId: string, The ID of the enterprise. (required)
122 pageId: string, The ID of the page. (required)
123 clusterId: string, The ID of the cluster. (required)
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
133 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
134 &quot;name&quot;: [ # 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.
135 { # A localized string with its locale.
136 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
137 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
138 },
139 ],
140 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
141 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
142 &quot;A String&quot;,
143 ],
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="insert">insert(enterpriseId, pageId, body=None, x__xgafv=None)</code>
149 <pre>Inserts a new cluster in a page.
150
151 Args:
152 enterpriseId: string, The ID of the enterprise. (required)
153 pageId: string, The ID of the page. (required)
154 body: object, The request body.
155 The object takes the form of:
156
157 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
158 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
159 &quot;name&quot;: [ # 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.
160 { # A localized string with its locale.
161 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
162 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
163 },
164 ],
165 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
166 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
167 &quot;A String&quot;,
168 ],
169 }
170
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176 Returns:
177 An object of the form:
178
179 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
180 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
181 &quot;name&quot;: [ # 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.
182 { # A localized string with its locale.
183 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
184 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
185 },
186 ],
187 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
188 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
189 &quot;A String&quot;,
190 ],
191 }</pre>
192 </div>
193
194 <div class="method">
195 <code class="details" id="list">list(enterpriseId, pageId, x__xgafv=None)</code>
196 <pre>Retrieves the details of all clusters on the specified page.
197
198 Args:
199 enterpriseId: string, The ID of the enterprise. (required)
200 pageId: string, The ID of the page. (required)
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206 Returns:
207 An object of the form:
208
209 {
210 &quot;cluster&quot;: [ # A store cluster of an enterprise.
211 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
212 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
213 &quot;name&quot;: [ # 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.
214 { # A localized string with its locale.
215 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
216 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
217 },
218 ],
219 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
220 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
221 &quot;A String&quot;,
222 ],
223 },
224 ],
225 }</pre>
226 </div>
227
228 <div class="method">
229 <code class="details" id="update">update(enterpriseId, pageId, clusterId, body=None, x__xgafv=None)</code>
230 <pre>Updates a cluster.
231
232 Args:
233 enterpriseId: string, The ID of the enterprise. (required)
234 pageId: string, The ID of the page. (required)
235 clusterId: string, The ID of the cluster. (required)
236 body: object, The request body.
237 The object takes the form of:
238
239 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
240 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
241 &quot;name&quot;: [ # 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.
242 { # A localized string with its locale.
243 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
244 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
245 },
246 ],
247 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
248 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
249 &quot;A String&quot;,
250 ],
251 }
252
253 x__xgafv: string, V1 error format.
254 Allowed values
255 1 - v1 error format
256 2 - v2 error format
257
258 Returns:
259 An object of the form:
260
261 { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
262 &quot;id&quot;: &quot;A String&quot;, # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
263 &quot;name&quot;: [ # 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.
264 { # A localized string with its locale.
265 &quot;locale&quot;: &quot;A String&quot;, # The BCP47 tag for a locale. (e.g. &quot;en-US&quot;, &quot;de&quot;).
266 &quot;text&quot;: &quot;A String&quot;, # The text localized in the associated locale.
267 },
268 ],
269 &quot;orderInPage&quot;: &quot;A String&quot;, # String (US-ASCII only) used to determine order of this cluster within the parent page&#x27;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.
270 &quot;productId&quot;: [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
271 &quot;A String&quot;,
272 ],
273 }</pre>
274 </div>
275
276 </body></html>