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
|
<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.collections.html">collections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, collectionId)</a></code></p>
<p class="firstline">Deletes a collection.</p>
<p class="toc_element">
<code><a href="#get">get(enterpriseId, collectionId)</a></code></p>
<p class="firstline">Retrieves the details of a collection.</p>
<p class="toc_element">
<code><a href="#insert">insert(enterpriseId, body)</a></code></p>
<p class="firstline">Creates a new collection.</p>
<p class="toc_element">
<code><a href="#list">list(enterpriseId)</a></code></p>
<p class="firstline">Retrieves the IDs of all the collections for an enterprise.</p>
<p class="toc_element">
<code><a href="#patch">patch(enterpriseId, collectionId, body)</a></code></p>
<p class="firstline">Updates a collection. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(enterpriseId, collectionId, body)</a></code></p>
<p class="firstline">Updates a collection.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(enterpriseId, collectionId)</code>
<pre>Deletes a collection.
Args:
enterpriseId: string, The ID of the enterprise. (required)
collectionId: string, The ID of the collection. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(enterpriseId, collectionId)</code>
<pre>Retrieves the details of a collection.
Args:
enterpriseId: string, The ID of the enterprise. (required)
collectionId: string, The ID of the collection. (required)
Returns:
An object of the form:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(enterpriseId, body)</code>
<pre>Creates a new collection.
Args:
enterpriseId: string, The ID of the enterprise. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}
Returns:
An object of the form:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(enterpriseId)</code>
<pre>Retrieves the IDs of all the collections for an enterprise.
Args:
enterpriseId: string, The ID of the enterprise. (required)
Returns:
An object of the form:
{ # The collection resources for the enterprise.
"kind": "androidenterprise#collectionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
"collection": [ # An ordered collection of products which can be made visible on the Google Play Store to a selected group of users.
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(enterpriseId, collectionId, body)</code>
<pre>Updates a collection. This method supports patch semantics.
Args:
enterpriseId: string, The ID of the enterprise. (required)
collectionId: string, The ID of the collection. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}
Returns:
An object of the form:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(enterpriseId, collectionId, body)</code>
<pre>Updates a collection.
Args:
enterpriseId: string, The ID of the enterprise. (required)
collectionId: string, The ID of the collection. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}
Returns:
An object of the form:
{ # A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot install an app on a managed device unless the app is listed in at least one collection that is visible to that user.
#
# Note that the API can be used to directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.
"kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
"productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
"A String",
],
"name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
"visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet" API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass the "availableProductSet" for all users within a domain.
#
# The "allUsers" setting is deprecated, and will be removed.
"collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
}</pre>
</div>
</body></html>
|
