File: androidenterprise_v1.storelayoutclusters.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (320 lines) | stat: -rw-r--r-- 16,381 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.storelayoutclusters.html">storelayoutclusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(enterpriseId, pageId, clusterId)</a></code></p>
<p class="firstline">Deletes a cluster.</p>
<p class="toc_element">
  <code><a href="#get">get(enterpriseId, pageId, clusterId)</a></code></p>
<p class="firstline">Retrieves details of a cluster.</p>
<p class="toc_element">
  <code><a href="#insert">insert(enterpriseId, pageId, body)</a></code></p>
<p class="firstline">Inserts a new cluster in a page.</p>
<p class="toc_element">
  <code><a href="#list">list(enterpriseId, pageId)</a></code></p>
<p class="firstline">Retrieves the details of all clusters on the specified page.</p>
<p class="toc_element">
  <code><a href="#patch">patch(enterpriseId, pageId, clusterId, body)</a></code></p>
<p class="firstline">Updates a cluster. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(enterpriseId, pageId, clusterId, body)</a></code></p>
<p class="firstline">Updates a cluster.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(enterpriseId, pageId, clusterId)</code>
  <pre>Deletes a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(enterpriseId, pageId, clusterId)</code>
  <pre>Retrieves details of a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)

Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "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.
          #
          # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(enterpriseId, pageId, body)</code>
  <pre>Inserts a new cluster in a page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "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.
        # 
        # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "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.
          #
          # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(enterpriseId, pageId)</code>
  <pre>Retrieves the details of all clusters on the specified page.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)

Returns:
  An object of the form:

    { # The store page resources for the enterprise.
    "cluster": [ # A store cluster of an enterprise.
      { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
          "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
          "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.
              #
              # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
            "A String",
          ],
          "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
          "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.
            { # A localized string with its locale.
              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
              "text": "A String", # The text localized in the associated locale.
            },
          ],
        },
    ],
    "kind": "androidenterprise#storeLayoutClustersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
  }</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(enterpriseId, pageId, clusterId, body)</code>
  <pre>Updates a cluster. This method supports patch semantics.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "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.
        # 
        # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "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.
          #
          # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(enterpriseId, pageId, clusterId, body)</code>
  <pre>Updates a cluster.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  pageId: string, The ID of the page. (required)
  clusterId: string, The ID of the cluster. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
    "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.
        # 
        # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
      "A String",
    ],
    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
    "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.
      { # A localized string with its locale.
        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
        "text": "A String", # The text localized in the associated locale.
      },
    ],
  }


Returns:
  An object of the form:

    { # Definition of a managed Google Play store cluster, a list of products displayed as part of a store page.
      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
      "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.
          #
          # 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 of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
        "A String",
      ],
      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
      "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.
        { # A localized string with its locale.
          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
          "text": "A String", # The text localized in the associated locale.
        },
      ],
    }</pre>
</div>

</body></html>