Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / androidenterprise_v1.collections.html
blob: 41d03cfff9b40fed5f4e61a268ffc06815ebb526 [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.collections.html">collections</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(enterpriseId, collectionId)</a></code></p>
79<p class="firstline">Deletes a collection.</p>
80<p class="toc_element">
81 <code><a href="#get">get(enterpriseId, collectionId)</a></code></p>
82<p class="firstline">Retrieves the details of a collection.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(enterpriseId, body)</a></code></p>
85<p class="firstline">Creates a new collection.</p>
86<p class="toc_element">
87 <code><a href="#list">list(enterpriseId)</a></code></p>
88<p class="firstline">Retrieves the IDs of all the collections for an enterprise.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(enterpriseId, collectionId, body)</a></code></p>
91<p class="firstline">Updates a collection. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(enterpriseId, collectionId, body)</a></code></p>
94<p class="firstline">Updates a collection.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(enterpriseId, collectionId)</code>
98 <pre>Deletes a collection.
99
100Args:
101 enterpriseId: string, The ID of the enterprise. (required)
102 collectionId: string, The ID of the collection. (required)
103</pre>
104</div>
105
106<div class="method">
107 <code class="details" id="get">get(enterpriseId, collectionId)</code>
108 <pre>Retrieves the details of a collection.
109
110Args:
111 enterpriseId: string, The ID of the enterprise. (required)
112 collectionId: string, The ID of the collection. (required)
113
114Returns:
115 An object of the form:
116
117 { # 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.
118 #
119 # 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.
120 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
121 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
122 "A String",
123 ],
124 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
125 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
126 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
127 }</pre>
128</div>
129
130<div class="method">
131 <code class="details" id="insert">insert(enterpriseId, body)</code>
132 <pre>Creates a new collection.
133
134Args:
135 enterpriseId: string, The ID of the enterprise. (required)
136 body: object, The request body. (required)
137 The object takes the form of:
138
139{ # 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.
140 #
141 # 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.
142 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
143 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
144 "A String",
145 ],
146 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
147 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
148 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
149 }
150
151
152Returns:
153 An object of the form:
154
155 { # 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.
156 #
157 # 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.
158 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
159 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
160 "A String",
161 ],
162 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
163 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
164 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="list">list(enterpriseId)</code>
170 <pre>Retrieves the IDs of all the collections for an enterprise.
171
172Args:
173 enterpriseId: string, The ID of the enterprise. (required)
174
175Returns:
176 An object of the form:
177
178 { # The collection resources for the enterprise.
179 "kind": "androidenterprise#collectionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
180 "collection": [ # An ordered collection of products which can be made visible on the Google Play Store app to a selected group of users.
181 { # 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.
182 #
183 # 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.
184 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
185 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
186 "A String",
187 ],
188 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
189 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
190 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
191 },
192 ],
193 }</pre>
194</div>
195
196<div class="method">
197 <code class="details" id="patch">patch(enterpriseId, collectionId, body)</code>
198 <pre>Updates a collection. This method supports patch semantics.
199
200Args:
201 enterpriseId: string, The ID of the enterprise. (required)
202 collectionId: string, The ID of the collection. (required)
203 body: object, The request body. (required)
204 The object takes the form of:
205
206{ # 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.
207 #
208 # 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.
209 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
210 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
211 "A String",
212 ],
213 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
214 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
215 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
216 }
217
218
219Returns:
220 An object of the form:
221
222 { # 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.
223 #
224 # 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.
225 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
226 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
227 "A String",
228 ],
229 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
230 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
231 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="update">update(enterpriseId, collectionId, body)</code>
237 <pre>Updates a collection.
238
239Args:
240 enterpriseId: string, The ID of the enterprise. (required)
241 collectionId: string, The ID of the collection. (required)
242 body: object, The request body. (required)
243 The object takes the form of:
244
245{ # 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.
246 #
247 # 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.
248 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
249 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
250 "A String",
251 ],
252 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
253 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
254 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
255 }
256
257
258Returns:
259 An object of the form:
260
261 { # 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.
262 #
263 # 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.
264 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
265 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
266 "A String",
267 ],
268 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
269 "visibility": "A String", # Whether this collection is visible to all users, or only to the users that have been granted access through the collection_viewers api. Even if a collection is visible to allUsers, it is possible to add and remove viewers, but this will have no effect until the collection's visibility changes to viewersOnly.
270 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
271 }</pre>
272</div>
273
274</body></html>