Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androidenterprise_v1.enterprises.html
blob: fb70e672094a3721aebfec3ea40fe0613773aea1 [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.enterprises.html">enterprises</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#acknowledgeNotificationSet">acknowledgeNotificationSet(notificationSetId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Acknowledges notifications that were received from</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#completeSignup">completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Completes the signup flow, by specifying the Completion token and</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a unique token to access an embeddable UI. To generate a</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#enroll">enroll(token, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<p class="firstline">Enrolls an enterprise with the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]90 <code><a href="#generateSignupUrl">generateSignupUrl(callbackUrl=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]91<p class="firstline">Generates a sign-up URL.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]93 <code><a href="#get">get(enterpriseId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]94<p class="firstline">Retrieves the name and domain of an enterprise.</p>
95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]96 <code><a href="#getServiceAccount">getServiceAccount(enterpriseId, keyType=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Returns a service account and credentials. The service account</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]99 <code><a href="#getStoreLayout">getStoreLayout(enterpriseId, x__xgafv=None)</a></code></p>
100<p class="firstline">Returns the store layout for the enterprise. If the store layout</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]102 <code><a href="#list">list(domain, x__xgafv=None)</a></code></p>
103<p class="firstline">Looks up an enterprise by domain name.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]105 <code><a href="#pullNotificationSet">pullNotificationSet(requestMode=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Pulls and returns a notification set for the enterprises associated with</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]108 <code><a href="#sendTestPushNotification">sendTestPushNotification(enterpriseId, x__xgafv=None)</a></code></p>
109<p class="firstline">Sends a test notification to validate the EMM integration with</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]111 <code><a href="#setAccount">setAccount(enterpriseId, body=None, x__xgafv=None)</a></code></p>
112<p class="firstline">Sets the account that will be used to authenticate to the API as the</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114 <code><a href="#setStoreLayout">setStoreLayout(enterpriseId, body=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Sets the store layout for the enterprise. By default, storeLayoutType</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]116<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]117 <code><a href="#unenroll">unenroll(enterpriseId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]118<p class="firstline">Unenrolls an enterprise from the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119<h3>Method Details</h3>
120<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]121 <code class="details" id="acknowledgeNotificationSet">acknowledgeNotificationSet(notificationSetId=None, x__xgafv=None)</code>
122 <pre>Acknowledges notifications that were received from
123Enterprises.PullNotificationSet to prevent subsequent calls from returning
124the same notifications.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]125
126Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]127 notificationSetId: string, The notification set ID as returned by Enterprises.PullNotificationSet.
128This must be provided.
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]133</pre>
134</div>
135
136<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]137 <code class="details" id="completeSignup">completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)</code>
138 <pre>Completes the signup flow, by specifying the Completion token and
139Enterprise token.
140This request must not be called multiple times for a given Enterprise
141Token.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]142
143Args:
144 completionToken: string, The Completion token initially returned by GenerateSignupUrl.
145 enterpriseToken: string, The Enterprise token appended to the Callback URL.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]150
151Returns:
152 An object of the form:
153
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]154 { # An Enterprises resource represents the binding between an EMM and a
155 # specific organization. That binding can be instantiated in one of two
156 # different ways using this API as follows:
157 # &lt;ul&gt;&lt;li&gt;For Google managed domain customers, the process involves using
158 # &lt;code&gt;Enterprises.enroll&lt;/code&gt; and &lt;code&gt;Enterprises.setAccount&lt;/code&gt; (in
159 # conjunction with artifacts obtained from the Admin console and the Google
160 # API Console) and submitted to the EMM through a more-or-less manual
161 # process.&lt;/li&gt;
162 # &lt;li&gt;For managed Google Play Accounts customers, the process involves using
163 # &lt;code&gt;Enterprises.generateSignupUrl&lt;/code&gt; and
164 # &lt;code&gt;Enterprises.completeSignup&lt;/code&gt; in conjunction with the managed
165 # Google Play sign-up UI (Google-provided mechanism) to create the binding
166 # without manual steps.&lt;/li&gt;&lt;/ul&gt; As an EMM, you can support either or both
167 # approaches in your EMM console. See &lt;a
168 # href=&quot;/android/work/play/emm-api/create-enterprise&quot;&gt;Create an Enterprise&lt;/a&gt;
169 # for details.
170 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises
171 # created via the EMM-initiated flow.
172 { # This represents an enterprise admin who can manage the enterprise
173 # in the managed Google Play store.
174 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
175 },
176 ],
177 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
178 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
179 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
180 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181</div>
182
183<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]184 <code class="details" id="createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</code>
185 <pre>Returns a unique token to access an embeddable UI. To generate a
186web UI, pass the generated token into the managed Google Play javascript
187API. Each token may only be used to start one UI session. See the
188javascript API documentation for further information.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]189
190Args:
191 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]193 The object takes the form of:
194
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]195{ # Specification for a token used to generate iframes. The token specifies
196 # what data the admin is allowed to modify and the URI the iframe is
197 # allowed to communiate with.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;storeBuilder&quot;: { # Options for displaying the Organize apps page.
199 &quot;enabled&quot;: True or False, # Whether the Organize apps page is displayed. Default is true.
200 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]201 &quot;managedConfigurations&quot;: { # Options for displaying the Managed Configuration page.
202 &quot;enabled&quot;: True or False, # Whether the Managed Configuration page is displayed. Default is true.
203 },
204 &quot;parent&quot;: &quot;A String&quot;, # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe
205 # may not be hosted at other URIs. This URI must be https.
206 # Use whitespaces to separate multiple parent URIs.
207 &quot;privateApps&quot;: { # Options for displaying the Private Apps page.
208 &quot;enabled&quot;: True or False, # Whether the Private Apps page is displayed. Default is true.
209 },
210 &quot;playSearch&quot;: { # Options for displaying the managed Play Search apps page.
211 &quot;enabled&quot;: True or False, # Whether the managed Play Search apps page is displayed. Default is true.
212 &quot;approveApps&quot;: True or False, # Allow access to the iframe in &lt;a
213 # href=&quot;https://developers.google.com/android/work/play/emm-api/managed-play-iframe#render&quot;&gt;approve
214 # mode&lt;/a&gt;. Default is false.
215 },
216 &quot;permission&quot;: [ # Deprecated. Use &lt;code&gt;PlaySearch.approveApps&lt;/code&gt;.
217 &quot;A String&quot;,
218 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]219 &quot;webApps&quot;: { # Options for displaying the Web Apps page.
220 &quot;enabled&quot;: True or False, # Whether the Web Apps page is displayed. Default is true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]222 }
223
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]228
229Returns:
230 An object of the form:
231
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]232 { # A token authorizing an admin to access an iframe.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 &quot;token&quot;: &quot;A String&quot;, # An opaque token to be passed to the Play front-end to generate an iframe.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]234 }</pre>
235</div>
236
237<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]238 <code class="details" id="enroll">enroll(token, body=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 <pre>Enrolls an enterprise with the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]240
241Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]242 token: string, Required. The token provided by the enterprise to register the EMM. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]243 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]244 The object takes the form of:
245
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]246{ # An Enterprises resource represents the binding between an EMM and a
247 # specific organization. That binding can be instantiated in one of two
248 # different ways using this API as follows:
249 # &lt;ul&gt;&lt;li&gt;For Google managed domain customers, the process involves using
250 # &lt;code&gt;Enterprises.enroll&lt;/code&gt; and &lt;code&gt;Enterprises.setAccount&lt;/code&gt; (in
251 # conjunction with artifacts obtained from the Admin console and the Google
252 # API Console) and submitted to the EMM through a more-or-less manual
253 # process.&lt;/li&gt;
254 # &lt;li&gt;For managed Google Play Accounts customers, the process involves using
255 # &lt;code&gt;Enterprises.generateSignupUrl&lt;/code&gt; and
256 # &lt;code&gt;Enterprises.completeSignup&lt;/code&gt; in conjunction with the managed
257 # Google Play sign-up UI (Google-provided mechanism) to create the binding
258 # without manual steps.&lt;/li&gt;&lt;/ul&gt; As an EMM, you can support either or both
259 # approaches in your EMM console. See &lt;a
260 # href=&quot;/android/work/play/emm-api/create-enterprise&quot;&gt;Create an Enterprise&lt;/a&gt;
261 # for details.
262 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises
263 # created via the EMM-initiated flow.
264 { # This represents an enterprise admin who can manage the enterprise
265 # in the managed Google Play store.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]266 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
267 },
268 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
270 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]271 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
272 }
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]273
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]278
279Returns:
280 An object of the form:
281
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]282 { # An Enterprises resource represents the binding between an EMM and a
283 # specific organization. That binding can be instantiated in one of two
284 # different ways using this API as follows:
285 # &lt;ul&gt;&lt;li&gt;For Google managed domain customers, the process involves using
286 # &lt;code&gt;Enterprises.enroll&lt;/code&gt; and &lt;code&gt;Enterprises.setAccount&lt;/code&gt; (in
287 # conjunction with artifacts obtained from the Admin console and the Google
288 # API Console) and submitted to the EMM through a more-or-less manual
289 # process.&lt;/li&gt;
290 # &lt;li&gt;For managed Google Play Accounts customers, the process involves using
291 # &lt;code&gt;Enterprises.generateSignupUrl&lt;/code&gt; and
292 # &lt;code&gt;Enterprises.completeSignup&lt;/code&gt; in conjunction with the managed
293 # Google Play sign-up UI (Google-provided mechanism) to create the binding
294 # without manual steps.&lt;/li&gt;&lt;/ul&gt; As an EMM, you can support either or both
295 # approaches in your EMM console. See &lt;a
296 # href=&quot;/android/work/play/emm-api/create-enterprise&quot;&gt;Create an Enterprise&lt;/a&gt;
297 # for details.
298 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises
299 # created via the EMM-initiated flow.
300 { # This represents an enterprise admin who can manage the enterprise
301 # in the managed Google Play store.
302 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
303 },
304 ],
305 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
306 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
307 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="generateSignupUrl">generateSignupUrl(callbackUrl=None, x__xgafv=None)</code>
313 <pre>Generates a sign-up URL.
314
315Args:
316 callbackUrl: string, The callback URL to which the Admin will be redirected after successfully
317creating an enterprise. Before redirecting there the system will add a
318single query parameter to this URL named &quot;enterpriseToken&quot; which will
319contain an opaque token to be used for the CompleteSignup request.&lt;br&gt;
320Beware that this means that the URL will be parsed, the parameter added
321and then a new URL formatted, i.e. there may be some minor formatting
322changes and, more importantly, the URL must be well-formed so that it can
323be parsed.
324 x__xgafv: string, V1 error format.
325 Allowed values
326 1 - v1 error format
327 2 - v2 error format
328
329Returns:
330 An object of the form:
331
332 { # A resource returned by the GenerateSignupUrl API, which contains the
333 # Signup URL and Completion Token.
334 &quot;url&quot;: &quot;A String&quot;, # A URL under which the Admin can sign up for an enterprise.
335 # The page pointed to cannot be rendered in an iframe.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]336 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]337 &quot;completionToken&quot;: &quot;A String&quot;, # An opaque token that will be required, along with the Enterprise Token,
338 # for obtaining the enterprise resource from CompleteSignup.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]339 }</pre>
340</div>
341
342<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]343 <code class="details" id="get">get(enterpriseId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]344 <pre>Retrieves the name and domain of an enterprise.
345
346Args:
347 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]348 x__xgafv: string, V1 error format.
349 Allowed values
350 1 - v1 error format
351 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]352
353Returns:
354 An object of the form:
355
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]356 { # An Enterprises resource represents the binding between an EMM and a
357 # specific organization. That binding can be instantiated in one of two
358 # different ways using this API as follows:
359 # &lt;ul&gt;&lt;li&gt;For Google managed domain customers, the process involves using
360 # &lt;code&gt;Enterprises.enroll&lt;/code&gt; and &lt;code&gt;Enterprises.setAccount&lt;/code&gt; (in
361 # conjunction with artifacts obtained from the Admin console and the Google
362 # API Console) and submitted to the EMM through a more-or-less manual
363 # process.&lt;/li&gt;
364 # &lt;li&gt;For managed Google Play Accounts customers, the process involves using
365 # &lt;code&gt;Enterprises.generateSignupUrl&lt;/code&gt; and
366 # &lt;code&gt;Enterprises.completeSignup&lt;/code&gt; in conjunction with the managed
367 # Google Play sign-up UI (Google-provided mechanism) to create the binding
368 # without manual steps.&lt;/li&gt;&lt;/ul&gt; As an EMM, you can support either or both
369 # approaches in your EMM console. See &lt;a
370 # href=&quot;/android/work/play/emm-api/create-enterprise&quot;&gt;Create an Enterprise&lt;/a&gt;
371 # for details.
372 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises
373 # created via the EMM-initiated flow.
374 { # This represents an enterprise admin who can manage the enterprise
375 # in the managed Google Play store.
376 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
377 },
378 ],
379 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
380 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
381 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
382 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]383</div>
384
385<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]386 <code class="details" id="getServiceAccount">getServiceAccount(enterpriseId, keyType=None, x__xgafv=None)</code>
387 <pre>Returns a service account and credentials. The service account
388can be bound to the enterprise by calling setAccount. The service account
389is unique to this enterprise and EMM, and will be deleted if the enterprise
390is unbound. The credentials contain private key data and are not stored
391server-side.
392&lt;br&gt; &lt;br&gt;
393This method can only be called after calling
394Enterprises.Enroll or Enterprises.CompleteSignup, and before
395Enterprises.SetAccount; at other times it will return an error.
396&lt;br&gt; &lt;br&gt;
397Subsequent calls after the first will generate a new, unique set of
398credentials, and invalidate the previously generated credentials.
399&lt;br&gt; &lt;br&gt;
400Once the service account is bound to the enterprise, it can be managed
401using the serviceAccountKeys resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]402
403Args:
404 enterpriseId: string, The ID of the enterprise. (required)
405 keyType: string, The type of credential to return with the service account. Required.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]406 x__xgafv: string, V1 error format.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]407 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]408 1 - v1 error format
409 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]410
411Returns:
412 An object of the form:
413
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]414 { # A service account identity, including the name and credentials that can be
415 # used to authenticate as the service account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]416 &quot;key&quot;: { # Credentials that can be used to authenticate as a service account. # Credentials that can be used to authenticate as this ServiceAccount.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]417 &quot;data&quot;: &quot;A String&quot;, # The body of the private key credentials file, in string format. This
418 # is only populated when the ServiceAccountKey is created, and is not stored
419 # by Google.
420 &quot;publicData&quot;: &quot;A String&quot;, # Public key data for the credentials file. This is an X.509 cert. If you are
421 # using the &lt;code&gt;googleCredentials&lt;/code&gt; key type, this is identical to the
422 # cert that can be retrieved by using the X.509 cert url inside of the
423 # credentials file.
424 &quot;id&quot;: &quot;A String&quot;, # An opaque, unique identifier for this ServiceAccountKey.
425 # Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 &quot;type&quot;: &quot;A String&quot;, # The file format of the generated key data.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]427 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]428 &quot;name&quot;: &quot;A String&quot;, # The account name of the service account, in the form of an email address.
429 # Assigned by the server.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]430 }</pre>
431</div>
432
433<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]434 <code class="details" id="getStoreLayout">getStoreLayout(enterpriseId, x__xgafv=None)</code>
435 <pre>Returns the store layout for the enterprise. If the store layout
436has not been set, returns &quot;basic&quot; as the store layout type and no
437homepage.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]438
439Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]440 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]441 x__xgafv: string, V1 error format.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]442 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]443 1 - v1 error format
444 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]445
446Returns:
447 An object of the form:
448
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]449 { # General setting for the managed Google Play store layout,
450 # currently only specifying the page to display the first time
451 # the store is opened.
452 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the
453 # first page shown in the managed Google Play Store.
454 #
455 # Not specifying a homepage is equivalent to setting the store layout
456 # type to &quot;basic&quot;.
457 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot;
458 # if the homepageId field is not set, and to &quot;custom&quot; otherwise.
459 # If set to &quot;basic&quot;, the layout will consist of all approved apps that
460 # have been whitelisted for the user.
461 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]462</div>
463
464<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]465 <code class="details" id="list">list(domain, x__xgafv=None)</code>
466 <pre>Looks up an enterprise by domain name.
467This is only supported for enterprises created via the Google-initiated
468creation flow. Lookup of the id is not needed for enterprises created via
469the EMM-initiated flow since the EMM learns the enterprise ID in the
470callback specified in the Enterprises.generateSignupUrl call.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]471
472Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]473 domain: string, Required. The exact primary domain name of the enterprise to look up. (required)
474 x__xgafv: string, V1 error format.
475 Allowed values
476 1 - v1 error format
477 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]478
479Returns:
480 An object of the form:
481
482 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]483 &quot;enterprise&quot;: [ # An enterprise.
484 { # An Enterprises resource represents the binding between an EMM and a
485 # specific organization. That binding can be instantiated in one of two
486 # different ways using this API as follows:
487 # &lt;ul&gt;&lt;li&gt;For Google managed domain customers, the process involves using
488 # &lt;code&gt;Enterprises.enroll&lt;/code&gt; and &lt;code&gt;Enterprises.setAccount&lt;/code&gt; (in
489 # conjunction with artifacts obtained from the Admin console and the Google
490 # API Console) and submitted to the EMM through a more-or-less manual
491 # process.&lt;/li&gt;
492 # &lt;li&gt;For managed Google Play Accounts customers, the process involves using
493 # &lt;code&gt;Enterprises.generateSignupUrl&lt;/code&gt; and
494 # &lt;code&gt;Enterprises.completeSignup&lt;/code&gt; in conjunction with the managed
495 # Google Play sign-up UI (Google-provided mechanism) to create the binding
496 # without manual steps.&lt;/li&gt;&lt;/ul&gt; As an EMM, you can support either or both
497 # approaches in your EMM console. See &lt;a
498 # href=&quot;/android/work/play/emm-api/create-enterprise&quot;&gt;Create an Enterprise&lt;/a&gt;
499 # for details.
500 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises
501 # created via the EMM-initiated flow.
502 { # This represents an enterprise admin who can manage the enterprise
503 # in the managed Google Play store.
504 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
505 },
506 ],
507 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
508 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
509 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
510 },
511 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]512 }</pre>
513</div>
514
515<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]516 <code class="details" id="pullNotificationSet">pullNotificationSet(requestMode=None, x__xgafv=None)</code>
517 <pre>Pulls and returns a notification set for the enterprises associated with
518the service account authenticated for the request. The notification set may
519be empty if no notification are pending.
520&lt;br&gt;
521A notification set returned needs to be acknowledged within 20 seconds
522by calling Enterprises.AcknowledgeNotificationSet, unless the
523notification set is empty.
524&lt;br&gt;
525Notifications that are not acknowledged within the 20 seconds will
526eventually be included again in the response to another PullNotificationSet
527request, and those that are never acknowledged will ultimately be deleted
528according to the Google Cloud Platform Pub/Sub system policy.
529&lt;br&gt;
530Multiple requests might be performed concurrently to retrieve
531notifications, in which case the pending notifications (if any) will be
532split among each caller, if any are pending.
533&lt;br&gt;
534If no notifications are present, an empty notification list is returned.
535Subsequent requests may return more notifications once they become
536available.
537
538Args:
539 requestMode: string, The request mode for pulling notifications.
540&lt;br&gt;
541Specifying &lt;code&gt;waitForNotifications&lt;/code&gt; will cause the request to
542block and wait until one or more notifications are present, or return an
543empty notification list if no notifications are present after some time.
544&lt;br&gt;
545Speciying &lt;code&gt;returnImmediately&lt;/code&gt; will cause the request to
546immediately return the pending notifications, or an empty list if no
547notifications are present.
548&lt;br&gt;
549If omitted, defaults to &lt;code&gt;waitForNotifications&lt;/code&gt;.
550 x__xgafv: string, V1 error format.
551 Allowed values
552 1 - v1 error format
553 2 - v2 error format
554
555Returns:
556 An object of the form:
557
558 { # A resource returned by the PullNotificationSet API, which contains
559 # a collection of notifications for enterprises associated with the service
560 # account authenticated for the request.
561 &quot;notificationSetId&quot;: &quot;A String&quot;, # The notification set ID, required to mark the notification as
562 # received with the Enterprises.AcknowledgeNotification API.
563 # This will be omitted if no notifications are present.
564 &quot;notification&quot;: [ # The notifications received, or empty if no notifications are present.
565 { # A notification of one event relating to an enterprise.
566 &quot;appUpdateEvent&quot;: { # An event generated when a new version of an app is uploaded to Google Play. # Notifications about app updates.
567 # Notifications are sent for new public versions only: alpha, beta, or canary
568 # versions do not generate this event. To fetch up-to-date version history for
569 # an app, use Products.Get on the EMM API.
570 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) that was updated.
571 # This field will always be present.
572 },
573 &quot;appRestrictionsSchemaChangeEvent&quot;: { # An event generated when a new app version is uploaded to Google Play and its # Notifications about new app restrictions schema changes.
574 # app restrictions schema changed.
575 # To fetch the app restrictions schema for an app, use
576 # Products.getAppRestrictionsSchema on the EMM API.
577 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the
578 # app restriction schema changed. This field will always be present.
579 },
580 &quot;newDeviceEvent&quot;: { # An event generated when a new device is ready to be managed. # Notifications about new devices.
581 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device.
582 # This field will always be present.
583 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by an Android
584 # EMM in various deployment configurations. &lt;br&gt;&lt;br&gt;
585 # Possible values include:
586 # &lt;ul&gt;&lt;li&gt;&quot;&lt;code&gt;managedDevice&lt;/code&gt;&quot;, a device where the DPC is set as
587 # device owner,&lt;/li&gt;
588 # &lt;li&gt;&quot;&lt;code&gt;managedProfile&lt;/code&gt;&quot;, a device where the DPC is set as profile
589 # owner.&lt;/li&gt;&lt;/ul&gt;
590 &quot;dpcPackageName&quot;: &quot;A String&quot;, # Policy app on the device.
591 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user.
592 # This field will always be present.
593 },
594 &quot;productApprovalEvent&quot;: { # An event generated when a product&#x27;s approval status is changed. # Notifications about changes to a product&#x27;s approval status.
595 &quot;approved&quot;: &quot;A String&quot;, # Whether the product was approved or unapproved.
596 # This field will always be present.
597 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the
598 # approval status has changed. This field will always be present.
599 },
600 &quot;timestampMillis&quot;: &quot;A String&quot;, # The time when the notification was published in
601 # milliseconds since 1970-01-01T00:00:00Z.
602 # This will always be present.
603 &quot;installFailureEvent&quot;: { # An event generated when an app installation failed on a device # Notifications about an app installation failure.
604 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device.
605 # This field will always be present.
606 &quot;failureReason&quot;: &quot;A String&quot;, # The reason for the installation failure.
607 # This field will always be present.
608 &quot;failureDetails&quot;: &quot;A String&quot;, # Additional details on the failure if applicable.
609 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user.
610 # This field will always be present.
611 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the
612 # install failure event occured. This field will always be present.
613 },
614 &quot;newPermissionsEvent&quot;: { # An event generated when new permissions are added to an app. # Notifications about new app permissions.
615 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which new
616 # permissions were added. This field will always be present.
617 &quot;approvedPermissions&quot;: [ # The set of permissions that the enterprise admin has already approved for
618 # this application.
619 # Use Permissions.Get on the EMM API to retrieve details about these
620 # permissions.
621 &quot;A String&quot;,
622 ],
623 &quot;requestedPermissions&quot;: [ # The set of permissions that the app is currently requesting.
624 # Use Permissions.Get on the EMM API to retrieve details about these
625 # permissions.
626 &quot;A String&quot;,
627 ],
628 },
629 &quot;deviceReportUpdateEvent&quot;: { # An event generated when an updated device report is available. # Notifications about device report updates.
630 &quot;report&quot;: { # Device report updated with the latest app states for managed apps on the # The device report updated with the latest app states.
631 # This field will always be present.
632 # device.
633 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are
634 # defined by the app&#x27;s developers.
635 # This field will always be present.
636 { # List of states set by the app.
637 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app.
638 # This field will always be present.
639 &quot;keyedAppState&quot;: [ # List of keyed app states.
640 # This field will always be present.
641 { # Represents a keyed app state containing a key, timestamp, severity level,
642 # optional description, and optional data.
643 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch.
644 # This field will always be present.
645 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state.
646 # This field will always be present.
647 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example,
648 # an error message. To prevent XSS, we recommend removing any HTML from the
649 # message before displaying it.
650 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the
651 # key is set by the app&#x27;s developer. To prevent XSS, we recommend removing
652 # any HTML from the key before displaying it.
653 # This field will always be present.
654 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number
655 # or JSON object. To prevent XSS, we recommend removing any HTML from the
656 # data before displaying it.
657 },
658 ],
659 },
660 ],
661 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch.
662 # This field will always be present.
663 },
664 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device.
665 # This field will always be present.
666 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user.
667 # This field will always be present.
668 },
669 &quot;productAvailabilityChangeEvent&quot;: { # An event generated whenever a product&#x27;s availability changes. # Notifications about product availability changes.
670 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the
671 # product availability changed. This field will always be present.
672 &quot;availabilityStatus&quot;: &quot;A String&quot;, # The new state of the product.
673 # This field will always be present.
674 },
675 &quot;notificationType&quot;: &quot;A String&quot;, # Type of the notification.
676 &quot;enterpriseId&quot;: &quot;A String&quot;, # The ID of the enterprise for which the notification is sent.
677 # This will always be present.
678 },
679 ],
680 }</pre>
681</div>
682
683<div class="method">
684 <code class="details" id="sendTestPushNotification">sendTestPushNotification(enterpriseId, x__xgafv=None)</code>
685 <pre>Sends a test notification to validate the EMM integration with
686the Google Cloud Pub/Sub service for this enterprise.
687
688Args:
689 enterpriseId: string, The ID of the enterprise. (required)
690 x__xgafv: string, V1 error format.
691 Allowed values
692 1 - v1 error format
693 2 - v2 error format
694
695Returns:
696 An object of the form:
697
698 {
699 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Cloud Pub/Sub topic to which notifications for this
700 # enterprise&#x27;s enrolled account will be sent.
701 &quot;messageId&quot;: &quot;A String&quot;, # The message ID of the test push notification that was sent.
702 }</pre>
703</div>
704
705<div class="method">
706 <code class="details" id="setAccount">setAccount(enterpriseId, body=None, x__xgafv=None)</code>
707 <pre>Sets the account that will be used to authenticate to the API as the
708enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]709
710Args:
711 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]712 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]713 The object takes the form of:
714
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]715{ # A service account that can be used to authenticate as the enterprise to
716 # API calls that require such authentication.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]717 &quot;accountEmail&quot;: &quot;A String&quot;, # The email address of the service account.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]718 }
719
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]720 x__xgafv: string, V1 error format.
721 Allowed values
722 1 - v1 error format
723 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]724
725Returns:
726 An object of the form:
727
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]728 { # A service account that can be used to authenticate as the enterprise to
729 # API calls that require such authentication.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]730 &quot;accountEmail&quot;: &quot;A String&quot;, # The email address of the service account.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]731 }</pre>
732</div>
733
734<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]735 <code class="details" id="setStoreLayout">setStoreLayout(enterpriseId, body=None, x__xgafv=None)</code>
736 <pre>Sets the store layout for the enterprise. By default, storeLayoutType
737is set to &quot;basic&quot; and the basic store layout is enabled. The basic
738layout only contains apps approved by the admin, and that have
739been added to the available product set for a user (using the
740&lt;a href=&quot;/android/work/play/emm-api/v1/users/setAvailableProductSet&quot;&gt;
741setAvailableProductSet&lt;/a&gt; call). Apps on the page are sorted in order of
742their product ID value. If you create a custom store layout (by setting
743storeLayoutType = &quot;custom&quot; and setting a homepage), the basic store
744layout is disabled.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]745
746Args:
747 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]748 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]749 The object takes the form of:
750
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]751{ # General setting for the managed Google Play store layout,
752 # currently only specifying the page to display the first time
753 # the store is opened.
754 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the
755 # first page shown in the managed Google Play Store.
756 #
757 # Not specifying a homepage is equivalent to setting the store layout
758 # type to &quot;basic&quot;.
759 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot;
760 # if the homepageId field is not set, and to &quot;custom&quot; otherwise.
761 # If set to &quot;basic&quot;, the layout will consist of all approved apps that
762 # have been whitelisted for the user.
763 }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]764
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]765 x__xgafv: string, V1 error format.
766 Allowed values
767 1 - v1 error format
768 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]769
770Returns:
771 An object of the form:
772
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]773 { # General setting for the managed Google Play store layout,
774 # currently only specifying the page to display the first time
775 # the store is opened.
776 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the
777 # first page shown in the managed Google Play Store.
778 #
779 # Not specifying a homepage is equivalent to setting the store layout
780 # type to &quot;basic&quot;.
781 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot;
782 # if the homepageId field is not set, and to &quot;custom&quot; otherwise.
783 # If set to &quot;basic&quot;, the layout will consist of all approved apps that
784 # have been whitelisted for the user.
785 }</pre>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]786</div>
787
788<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]789 <code class="details" id="unenroll">unenroll(enterpriseId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]790 <pre>Unenrolls an enterprise from the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]791
792Args:
793 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]794 x__xgafv: string, V1 error format.
795 Allowed values
796 1 - v1 error format
797 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]798</pre>
799</div>
800
801</body></html>