Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / eca709b2fe5da618224b733ff633786174258e35 / . / docs / dyn / androidenterprise_v1.collections.html
blob: 6c727086ac841e2d9900dd204b4f309986ecaa50 [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".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 "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.
126 #
127 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="insert">insert(enterpriseId, body)</code>
134 <pre>Creates a new collection.
135
136Args:
137 enterpriseId: string, The ID of the enterprise. (required)
138 body: object, The request body. (required)
139 The object takes the form of:
140
141{ # 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.
142 #
143 # 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.
144 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
145 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
146 "A String",
147 ],
148 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]149 "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.
150 #
151 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
153 }
154
155
156Returns:
157 An object of the form:
158
159 { # 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.
160 #
161 # 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.
162 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
163 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
164 "A String",
165 ],
166 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]167 "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.
168 #
169 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]170 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list">list(enterpriseId)</code>
176 <pre>Retrieves the IDs of all the collections for an enterprise.
177
178Args:
179 enterpriseId: string, The ID of the enterprise. (required)
180
181Returns:
182 An object of the form:
183
184 { # The collection resources for the enterprise.
185 "kind": "androidenterprise#collectionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionsListResponse".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186 "collection": [ # An ordered collection of products which can be made visible on the Google Play Store to a selected group of users.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187 { # 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.
188 #
189 # 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.
190 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
191 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
192 "A String",
193 ],
194 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 "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.
196 #
197 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]198 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
199 },
200 ],
201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="patch">patch(enterpriseId, collectionId, body)</code>
206 <pre>Updates a collection. This method supports patch semantics.
207
208Args:
209 enterpriseId: string, The ID of the enterprise. (required)
210 collectionId: string, The ID of the collection. (required)
211 body: object, The request body. (required)
212 The object takes the form of:
213
214{ # 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.
215 #
216 # 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.
217 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
218 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
219 "A String",
220 ],
221 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]222 "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.
223 #
224 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]225 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
226 }
227
228
229Returns:
230 An object of the form:
231
232 { # 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.
233 #
234 # 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.
235 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
236 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
237 "A String",
238 ],
239 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]240 "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.
241 #
242 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]243 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
244 }</pre>
245</div>
246
247<div class="method">
248 <code class="details" id="update">update(enterpriseId, collectionId, body)</code>
249 <pre>Updates a collection.
250
251Args:
252 enterpriseId: string, The ID of the enterprise. (required)
253 collectionId: string, The ID of the collection. (required)
254 body: object, The request body. (required)
255 The object takes the form of:
256
257{ # 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.
258 #
259 # 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.
260 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
261 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
262 "A String",
263 ],
264 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]265 "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.
266 #
267 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]268 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
269 }
270
271
272Returns:
273 An object of the form:
274
275 { # 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.
276 #
277 # 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.
278 "kind": "androidenterprise#collection", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collection".
279 "productId": [ # The IDs of the products in the collection, in the order in which they should be displayed.
280 "A String",
281 ],
282 "name": "A String", # A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]283 "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.
284 #
285 # The "allUsers" setting is deprecated, and will be removed.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]286 "collectionId": "A String", # Arbitrary unique ID, allocated by the API on creation.
287 }</pre>
288</div>
289
290</body></html>