Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / androidenterprise_v1.enterprises.html
blob: ec74edcd5eb1cbdcb067ac286882fd0343fa1edd [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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]79<p class="firstline">Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
84 <code><a href="#completeSignup">completeSignup(enterpriseToken=None, completionToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <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]91<p class="firstline">Enrolls an enterprise with the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code><a href="#generateSignupUrl">generateSignupUrl(callbackUrl=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]94<p class="firstline">Generates a sign-up URL.</p>
95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <code><a href="#get">get(enterpriseId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]97<p class="firstline">Retrieves the name and domain of an enterprise.</p>
98<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code><a href="#getServiceAccount">getServiceAccount(enterpriseId, keyType=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]101<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 <code><a href="#getStoreLayout">getStoreLayout(enterpriseId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103<p class="firstline">Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]104<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 <code><a href="#list">list(domain, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106<p class="firstline">Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]107<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 <code><a href="#pullNotificationSet">pullNotificationSet(requestMode=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109<p class="firstline">Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 <code><a href="#sendTestPushNotification">sendTestPushNotification(enterpriseId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112<p class="firstline">Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 <code><a href="#setAccount">setAccount(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]115<p class="firstline">Sets the account that will be used to authenticate to the API as the enterprise.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 <code><a href="#setStoreLayout">setStoreLayout(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118<p class="firstline">Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 <code><a href="#unenroll">unenroll(enterpriseId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121<p class="firstline">Unenrolls an enterprise from the calling EMM.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122<h3>Method Details</h3>
123<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 <code class="details" id="acknowledgeNotificationSet">acknowledgeNotificationSet(notificationSetId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 <pre>Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]126
127Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 notificationSetId: string, The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 <code class="details" id="close">close()</code>
138 <pre>Close httplib2 connections.</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="completeSignup">completeSignup(enterpriseToken=None, completionToken=None, x__xgafv=None)</code>
143 <pre>Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]144
145Args:
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]146 enterpriseToken: string, The Enterprise token appended to the Callback URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]147 completionToken: string, The Completion token initially returned by GenerateSignupUrl.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]152
153Returns:
154 An object of the form:
155
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]156 { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]157 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]158 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
159 { # This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
160 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
161 },
162 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]163 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]164 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
165 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]166</div>
167
168<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]169 <code class="details" id="createWebToken">createWebToken(enterpriseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 <pre>Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]171
172Args:
173 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]174 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]175 The object takes the form of:
176
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177{ # Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]178 &quot;permission&quot;: [ # Deprecated. Use PlaySearch.approveApps.
179 &quot;A String&quot;,
180 ],
181 &quot;playSearch&quot;: { # Options for displaying the managed Play Search apps page.
182 &quot;approveApps&quot;: True or False, # Allow access to the iframe in approve mode. Default is false.
183 &quot;enabled&quot;: True or False, # Whether the managed Play Search apps page is displayed. Default is true.
184 },
185 &quot;parent&quot;: &quot;A String&quot;, # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https. Use whitespaces to separate multiple parent URIs.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]186 &quot;webApps&quot;: { # Options for displaying the Web Apps page.
187 &quot;enabled&quot;: True or False, # Whether the Web Apps page is displayed. Default is true.
188 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 &quot;storeBuilder&quot;: { # Options for displaying the Organize apps page.
190 &quot;enabled&quot;: True or False, # Whether the Organize apps page is displayed. Default is true.
191 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]192 &quot;managedConfigurations&quot;: { # Options for displaying the Managed Configuration page.
193 &quot;enabled&quot;: True or False, # Whether the Managed Configuration page is displayed. Default is true.
194 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]195 &quot;privateApps&quot;: { # Options for displaying the Private Apps page.
196 &quot;enabled&quot;: True or False, # Whether the Private Apps page is displayed. Default is true.
197 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]198 }
199
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]204
205Returns:
206 An object of the form:
207
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]208 { # A token authorizing an admin to access an iframe.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 &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]210 }</pre>
211</div>
212
213<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]214 <code class="details" id="enroll">enroll(token, body=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 <pre>Enrolls an enterprise with the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]216
217Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]218 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]219 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]220 The object takes the form of:
221
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]222{ # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]223 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]224 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
225 { # This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
226 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
227 },
228 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]229 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]230 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
231}
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]232
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]237
238Returns:
239 An object of the form:
240
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]241 { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]242 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]243 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
244 { # This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
245 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
246 },
247 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]248 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]249 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
250 }</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]251</div>
252
253<div class="method">
254 <code class="details" id="generateSignupUrl">generateSignupUrl(callbackUrl=None, x__xgafv=None)</code>
255 <pre>Generates a sign-up URL.
256
257Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]258 callbackUrl: string, The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named &quot;enterpriseToken&quot; which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264Returns:
265 An object of the form:
266
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]267 { # A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]268 &quot;url&quot;: &quot;A String&quot;, # A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]269 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]270 &quot;completionToken&quot;: &quot;A String&quot;, # An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]271 }</pre>
272</div>
273
274<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]275 <code class="details" id="get">get(enterpriseId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]276 <pre>Retrieves the name and domain of an enterprise.
277
278Args:
279 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]284
285Returns:
286 An object of the form:
287
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]288 { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]289 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]290 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
291 { # This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
292 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
293 },
294 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]295 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]296 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
297 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]298</div>
299
300<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]301 <code class="details" id="getServiceAccount">getServiceAccount(enterpriseId, keyType=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]302 <pre>Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]303
304Args:
305 enterpriseId: string, The ID of the enterprise. (required)
306 keyType: string, The type of credential to return with the service account. Required.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]307 Allowed values
308 googleCredentials - Google Credentials File format.
309 pkcs12 - PKCS12 format. The password for the PKCS12 file is &#x27;notasecret&#x27;. For more information, see https://tools.ietf.org/html/rfc7292. The data for keys of this type are base64 encoded according to RFC 4648 Section 4. See http://tools.ietf.org/html/rfc4648#section-4.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]310 x__xgafv: string, V1 error format.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]311 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]312 1 - v1 error format
313 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]314
315Returns:
316 An object of the form:
317
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]318 { # A service account identity, including the name and credentials that can be used to authenticate as the service account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]319 &quot;name&quot;: &quot;A String&quot;, # The account name of the service account, in the form of an email address. Assigned by the server.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]320 &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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]321 &quot;type&quot;: &quot;A String&quot;, # The file format of the generated key data.
322 &quot;id&quot;: &quot;A String&quot;, # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]323 &quot;data&quot;: &quot;A String&quot;, # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
324 &quot;publicData&quot;: &quot;A String&quot;, # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]325 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]326 }</pre>
327</div>
328
329<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]330 <code class="details" id="getStoreLayout">getStoreLayout(enterpriseId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]331 <pre>Returns the store layout for the enterprise. If the store layout has not been set, returns &quot;basic&quot; as the store layout type and no homepage.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]332
333Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]334 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]335 x__xgafv: string, V1 error format.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]336 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]337 1 - v1 error format
338 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]339
340Returns:
341 An object of the form:
342
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]343 { # General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]344 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to &quot;basic&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]345 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot; if the homepageId field is not set, and to &quot;custom&quot; otherwise. If set to &quot;basic&quot;, the layout will consist of all approved apps that have been whitelisted for the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]346 }</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]347</div>
348
349<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]350 <code class="details" id="list">list(domain, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]351 <pre>Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]352
353Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]354 domain: string, Required. The exact primary domain name of the enterprise to look up. (required)
355 x__xgafv: string, V1 error format.
356 Allowed values
357 1 - v1 error format
358 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]359
360Returns:
361 An object of the form:
362
363 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]364 &quot;enterprise&quot;: [ # An enterprise.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]365 { # An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows: - For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process. - For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps. As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]366 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the enterprise.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]367 &quot;administrator&quot;: [ # Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
368 { # This represents an enterprise admin who can manage the enterprise in the managed Google Play store.
369 &quot;email&quot;: &quot;A String&quot;, # The admin&#x27;s email address.
370 },
371 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]372 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise, for example, &quot;Example, Inc&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]373 &quot;primaryDomain&quot;: &quot;A String&quot;, # The enterprise&#x27;s primary domain, such as &quot;example.com&quot;.
374 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]375 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]376 }</pre>
377</div>
378
379<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]380 <code class="details" id="pullNotificationSet">pullNotificationSet(requestMode=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]381 <pre>Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]382
383Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]384 requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
385 Allowed values
386 waitForNotifications - Wait until one or more notifications are present.
387 returnImmediately - Returns immediately whether notifications are present or not.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]388 x__xgafv: string, V1 error format.
389 Allowed values
390 1 - v1 error format
391 2 - v2 error format
392
393Returns:
394 An object of the form:
395
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]396 { # A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]397 &quot;notification&quot;: [ # The notifications received, or empty if no notifications are present.
398 { # A notification of one event relating to an enterprise.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]399 &quot;installFailureEvent&quot;: { # An event generated when an app installation failed on a device # Notifications about an app installation failure.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]400 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device. This field will always be present.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]401 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the install failure event occured. This field will always be present.
402 &quot;failureDetails&quot;: &quot;A String&quot;, # Additional details on the failure if applicable.
403 &quot;failureReason&quot;: &quot;A String&quot;, # The reason for the installation failure. This field will always be present.
404 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user. This field will always be present.
405 },
406 &quot;newPermissionsEvent&quot;: { # An event generated when new permissions are added to an app. # Notifications about new app permissions.
407 &quot;approvedPermissions&quot;: [ # The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions.
408 &quot;A String&quot;,
409 ],
410 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which new permissions were added. This field will always be present.
411 &quot;requestedPermissions&quot;: [ # The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.
412 &quot;A String&quot;,
413 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]414 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]415 &quot;timestampMillis&quot;: &quot;A String&quot;, # The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]416 &quot;notificationType&quot;: &quot;A String&quot;, # Type of the notification.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]417 &quot;appUpdateEvent&quot;: { # An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API. # Notifications about app updates.
418 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) that was updated. This field will always be present.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]419 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]420 &quot;newDeviceEvent&quot;: { # An event generated when a new device is ready to be managed. # Notifications about new devices.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]421 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device. This field will always be present.
422 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user. This field will always be present.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]423 &quot;dpcPackageName&quot;: &quot;A String&quot;, # Policy app on the device.
424 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations. Possible values include: - &quot;managedDevice&quot;, a device where the DPC is set as device owner, - &quot;managedProfile&quot;, a device where the DPC is set as profile owner.
425 },
426 &quot;appRestrictionsSchemaChangeEvent&quot;: { # An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API. # Notifications about new app restrictions schema changes.
427 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the app restriction schema changed. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]428 },
429 &quot;productAvailabilityChangeEvent&quot;: { # An event generated whenever a product&#x27;s availability changes. # Notifications about product availability changes.
430 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the product availability changed. This field will always be present.
431 &quot;availabilityStatus&quot;: &quot;A String&quot;, # The new state of the product. This field will always be present.
432 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]433 &quot;enterpriseId&quot;: &quot;A String&quot;, # The ID of the enterprise for which the notification is sent. This will always be present.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]434 &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.
435 &quot;approved&quot;: &quot;A String&quot;, # Whether the product was approved or unapproved. This field will always be present.
436 &quot;productId&quot;: &quot;A String&quot;, # The id of the product (e.g. &quot;app:com.google.android.gm&quot;) for which the approval status has changed. This field will always be present.
437 },
438 &quot;deviceReportUpdateEvent&quot;: { # An event generated when an updated device report is available. # Notifications about device report updates.
439 &quot;userId&quot;: &quot;A String&quot;, # The ID of the user. This field will always be present.
440 &quot;report&quot;: { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states. This field will always be present.
441 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are defined by the app&#x27;s developers. This field will always be present.
442 { # List of states set by the app.
443 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app. This field will always be present.
444 &quot;keyedAppState&quot;: [ # List of keyed app states. This field will always be present.
445 { # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
446 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example, an error message. To prevent XSS, we recommend removing any HTML from the message before displaying it.
447 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the key is set by the app&#x27;s developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.
448 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number or JSON object. To prevent XSS, we recommend removing any HTML from the data before displaying it.
449 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state. This field will always be present.
450 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.
451 },
452 ],
453 },
454 ],
455 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch. This field will always be present.
456 },
457 &quot;deviceId&quot;: &quot;A String&quot;, # The Android ID of the device. This field will always be present.
458 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]459 },
460 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]461 &quot;notificationSetId&quot;: &quot;A String&quot;, # The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]462 }</pre>
463</div>
464
465<div class="method">
466 <code class="details" id="sendTestPushNotification">sendTestPushNotification(enterpriseId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]467 <pre>Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]468
469Args:
470 enterpriseId: string, The ID of the enterprise. (required)
471 x__xgafv: string, V1 error format.
472 Allowed values
473 1 - v1 error format
474 2 - v2 error format
475
476Returns:
477 An object of the form:
478
479 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]480 &quot;topicName&quot;: &quot;A String&quot;, # The name of the Cloud Pub/Sub topic to which notifications for this enterprise&#x27;s enrolled account will be sent.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]481 &quot;messageId&quot;: &quot;A String&quot;, # The message ID of the test push notification that was sent.
482 }</pre>
483</div>
484
485<div class="method">
486 <code class="details" id="setAccount">setAccount(enterpriseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]487 <pre>Sets the account that will be used to authenticate to the API as the enterprise.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]488
489Args:
490 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]491 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]492 The object takes the form of:
493
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]494{ # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]495 &quot;accountEmail&quot;: &quot;A String&quot;, # The email address of the service account.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]496 }
497
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]498 x__xgafv: string, V1 error format.
499 Allowed values
500 1 - v1 error format
501 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]502
503Returns:
504 An object of the form:
505
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]506 { # A service account that can be used to authenticate as the enterprise to API calls that require such authentication.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;accountEmail&quot;: &quot;A String&quot;, # The email address of the service account.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]508 }</pre>
509</div>
510
511<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]512 <code class="details" id="setStoreLayout">setStoreLayout(enterpriseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]513 <pre>Sets the store layout for the enterprise. By default, storeLayoutType is set to &quot;basic&quot; and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = &quot;custom&quot; and setting a homepage), the basic store layout is disabled.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]514
515Args:
516 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]517 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]518 The object takes the form of:
519
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]520{ # General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]521 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to &quot;basic&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]522 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot; if the homepageId field is not set, and to &quot;custom&quot; otherwise. If set to &quot;basic&quot;, the layout will consist of all approved apps that have been whitelisted for the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]523 }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]524
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]525 x__xgafv: string, V1 error format.
526 Allowed values
527 1 - v1 error format
528 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]529
530Returns:
531 An object of the form:
532
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]533 { # General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]534 &quot;homepageId&quot;: &quot;A String&quot;, # The ID of the store page to be used as the homepage. The homepage is the first page shown in the managed Google Play Store. Not specifying a homepage is equivalent to setting the store layout type to &quot;basic&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]535 &quot;storeLayoutType&quot;: &quot;A String&quot;, # The store layout type. By default, this value is set to &quot;basic&quot; if the homepageId field is not set, and to &quot;custom&quot; otherwise. If set to &quot;basic&quot;, the layout will consist of all approved apps that have been whitelisted for the user.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]536 }</pre>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]537</div>
538
539<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]540 <code class="details" id="unenroll">unenroll(enterpriseId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]541 <pre>Unenrolls an enterprise from the calling EMM.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]542
543Args:
544 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]545 x__xgafv: string, V1 error format.
546 Allowed values
547 1 - v1 error format
548 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]549</pre>
550</div>
551
552</body></html>