Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / androidenterprise_v1.devices.html
blob: 34c295c2bccbbc337c6cce67c1897dac426d9783 [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.devices.html">devices</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="#forceReportUpload">forceReportUpload(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
79<p class="firstline">Uploads a report containing any changes in app states on the device since</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#get">get(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]82<p class="firstline">Retrieves the details of a device.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves whether a device's access to Google services is enabled or</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]88<p class="firstline">Retrieves the IDs of all of a user's devices.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#setState">setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Sets whether a device's access to Google services is enabled or disabled.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code><a href="#update">update(enterpriseId, userId, deviceId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates the device policy</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 <code class="details" id="forceReportUpload">forceReportUpload(enterpriseId, userId, deviceId, x__xgafv=None)</code>
98 <pre>Uploads a report containing any changes in app states on the device since
99the last report was generated. You can call this method up to 3 times every
10024 hours for a given device.
101If you exceed the quota, then the Google Play EMM API returns &lt;code&gt;HTTP
102429 Too Many Requests&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103
104Args:
105 enterpriseId: string, The ID of the enterprise. (required)
106 userId: string, The ID of the user. (required)
107 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112</pre>
113</div>
114
115<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 <code class="details" id="get">get(enterpriseId, userId, deviceId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]117 <pre>Retrieves the details of a device.
118
119Args:
120 enterpriseId: string, The ID of the enterprise. (required)
121 userId: string, The ID of the user. (required)
122 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127
128Returns:
129 An object of the form:
130
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 { # A Devices resource represents a mobile device managed by the EMM and
132 # belonging to a specific enterprise user.
133 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed
134 # Google Play EMM in various deployment configurations. &lt;br&gt;&lt;br&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 # Possible values include:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]136 # &lt;ul&gt;&lt;li&gt;&quot;&lt;code&gt;managedDevice&lt;/code&gt;&quot;, a device that has the EMM&#x27;s device
137 # policy controller (DPC) as the device owner.&lt;/li&gt;
138 # &lt;li&gt;&quot;&lt;code&gt;managedProfile&lt;/code&gt;&quot;, a device that has a profile managed
139 # by the DPC (DPC is profile owner) in addition to a separate, personal
140 # profile that is unavailable to the DPC.&lt;/li&gt;
141 # &lt;li&gt;&quot;&lt;code&gt;containerApp&lt;/code&gt;&quot;, no longer used (deprecated).&lt;/li&gt;
142 # &lt;li&gt;&quot;&lt;code&gt;unmanagedProfile&lt;/code&gt;&quot;, a device that has been allowed (by the
143 # domain&#x27;s admin, using the Admin Console to enable the privilege) to use
144 # managed Google Play, but the profile is itself
145 # not owned by a DPC.&lt;/li&gt;&lt;/ul&gt;
146 &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.
147 # device.
148 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are
149 # defined by the app&#x27;s developers.
150 # This field will always be present.
151 { # List of states set by the app.
152 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app.
153 # This field will always be present.
154 &quot;keyedAppState&quot;: [ # List of keyed app states.
155 # This field will always be present.
156 { # Represents a keyed app state containing a key, timestamp, severity level,
157 # optional description, and optional data.
158 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch.
159 # This field will always be present.
160 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state.
161 # This field will always be present.
162 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example,
163 # an error message. To prevent XSS, we recommend removing any HTML from the
164 # message before displaying it.
165 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the
166 # key is set by the app&#x27;s developer. To prevent XSS, we recommend removing
167 # any HTML from the key before displaying it.
168 # This field will always be present.
169 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number
170 # or JSON object. To prevent XSS, we recommend removing any HTML from the
171 # data before displaying it.
172 },
173 ],
174 },
175 ],
176 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch.
177 # This field will always be present.
178 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]180 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. # The maintenance window defining when apps running in the foreground should
181 # be updated.
182 # This allows Play store to update the apps on the foreground in the designated
183 # window.
184 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be
185 # between 30 minutes and 24 hours (inclusive).
186 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the
187 # device. Windows can span midnight.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is
190 # &quot;deviceReportDisabled&quot;.
191 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot;
192 # allows the device&#x27;s user to configure the app update policy. &quot;always&quot;
193 # enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables
194 # auto updates only when the device is connected to wifi.
195 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot;
196 # gives the device access to all products, regardless of approval status.
197 # &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks.
198 # &quot;whitelist&quot; grants the device access the products specified in
199 # productPolicy[]. Only products that are approved or products that were
200 # previously approved (products with revoked approval) by the enterprise can
201 # be whitelisted. If no value is provided, the availability set at the user
202 # level is applied by default.
203 &quot;productPolicy&quot;: [ # The list of product policies. The &lt;code&gt;productAvailabilityPolicy&lt;/code&gt;
204 # needs to be set to &lt;code&gt;WHITELIST&lt;/code&gt; or &lt;code&gt;ALL&lt;/code&gt; for the
205 # product policies to be applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 { # The policy for a product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]207 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
208 &quot;A String&quot;,
209 ],
210 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s),
211 # identified by &lt;code&gt;trackIds&lt;/code&gt;. The list of release tracks of a
212 # product can be obtained by calling Products.Get.
213 &quot;A String&quot;,
214 ],
215 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties # The managed configuration for the product.
216 # defined by the app developer in the app&#x27;s managed configurations schema,
217 # as well as any configuration variables defined for the user.
218 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g.
219 # &quot;app:com.google.android.gm&quot;.
220 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration # Contains the ID of the managed configuration profile and the set of
221 # configuration variables (if any) defined for the user.
222 # settings ID to be applied to a single user, as well as the variable set that
223 # is attributed to the user. The variable set will be used to replace
224 # placeholders in the managed configuration settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
226 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]227 { # A variable set is a key-value pair of EMM-provided placeholders and
228 # its corresponding value, which is attributed to a user. For example,
229 # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders
230 # should start with a &#x27;$&#x27; sign and should be alphanumeric only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]232 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 },
234 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]237 { # A managed property of a managed configuration. The property must match one of
238 # the properties in the app restrictions schema of the product. Exactly one of
239 # the value fields must be populated, and it must match the property&#x27;s type in
240 # the app restrictions schema.
241 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is
242 # integer.
243 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is
244 # bool.
245 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is
246 # string, choice or hidden.
247 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the
248 # property is bundle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;managedProperty&quot;: [ # The list of managed properties.
250 # Object with schema name: ManagedProperty
251 ],
252 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]253 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of
254 # the property is bundle_array.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 # Object with schema name: ManagedProperty
258 ],
259 },
260 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]261 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the
262 # property is multiselect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;A String&quot;,
264 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]265 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 },
267 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]270 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
271 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means
272 # higher priority.
273 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
274 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of
275 # one constraint.
276 { # The auto-install constraint. Defines a set of restrictions for installation.
277 # At least one of the fields must be set.
278 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
279 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
280 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
281 },
282 ],
283 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed,
284 # then the app will be auto-updated according to the auto-install
285 # constraints, instead of waiting for the regular auto-update. You can set a
286 # minimum version code for at most 20 apps per device.
287 },
288 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example,
289 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 },
291 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]293 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as
294 # a lowercase hex string. For example,
295 # &lt;code&gt;&amp;quot;123456789abcdef0&amp;quot;&lt;/code&gt;.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]296 }</pre>
297</div>
298
299<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]300 <code class="details" id="getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</code>
301 <pre>Retrieves whether a device&#x27;s access to Google services is enabled or
302disabled.
303The device state takes effect only if enforcing EMM policies on Android
304devices is enabled in the Google Admin Console.
305Otherwise, the device state is ignored and all devices are allowed access
306to Google services.
307This is only supported for Google-managed users.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]308
309Args:
310 enterpriseId: string, The ID of the enterprise. (required)
311 userId: string, The ID of the user. (required)
312 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]317
318Returns:
319 An object of the form:
320
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]321 { # The state of a user&#x27;s device, as accessed by the getState and setState
322 # methods on device resources.
323 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that
324 # the Google account on the device can be used to access Google services
325 # (including Google Play), while &quot;disabled&quot; means that it cannot.
326 # A new device is initially in the &quot;disabled&quot; state.
327 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]328</div>
329
330<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]331 <code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332 <pre>Retrieves the IDs of all of a user&#x27;s devices.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]333
334Args:
335 enterpriseId: string, The ID of the enterprise. (required)
336 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]337 x__xgafv: string, V1 error format.
338 Allowed values
339 1 - v1 error format
340 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]341
342Returns:
343 An object of the form:
344
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]345 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]346 &quot;device&quot;: [ # A managed device.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]347 { # A Devices resource represents a mobile device managed by the EMM and
348 # belonging to a specific enterprise user.
349 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed
350 # Google Play EMM in various deployment configurations. &lt;br&gt;&lt;br&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 # Possible values include:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]352 # &lt;ul&gt;&lt;li&gt;&quot;&lt;code&gt;managedDevice&lt;/code&gt;&quot;, a device that has the EMM&#x27;s device
353 # policy controller (DPC) as the device owner.&lt;/li&gt;
354 # &lt;li&gt;&quot;&lt;code&gt;managedProfile&lt;/code&gt;&quot;, a device that has a profile managed
355 # by the DPC (DPC is profile owner) in addition to a separate, personal
356 # profile that is unavailable to the DPC.&lt;/li&gt;
357 # &lt;li&gt;&quot;&lt;code&gt;containerApp&lt;/code&gt;&quot;, no longer used (deprecated).&lt;/li&gt;
358 # &lt;li&gt;&quot;&lt;code&gt;unmanagedProfile&lt;/code&gt;&quot;, a device that has been allowed (by the
359 # domain&#x27;s admin, using the Admin Console to enable the privilege) to use
360 # managed Google Play, but the profile is itself
361 # not owned by a DPC.&lt;/li&gt;&lt;/ul&gt;
362 &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.
363 # device.
364 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are
365 # defined by the app&#x27;s developers.
366 # This field will always be present.
367 { # List of states set by the app.
368 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app.
369 # This field will always be present.
370 &quot;keyedAppState&quot;: [ # List of keyed app states.
371 # This field will always be present.
372 { # Represents a keyed app state containing a key, timestamp, severity level,
373 # optional description, and optional data.
374 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch.
375 # This field will always be present.
376 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state.
377 # This field will always be present.
378 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example,
379 # an error message. To prevent XSS, we recommend removing any HTML from the
380 # message before displaying it.
381 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the
382 # key is set by the app&#x27;s developer. To prevent XSS, we recommend removing
383 # any HTML from the key before displaying it.
384 # This field will always be present.
385 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number
386 # or JSON object. To prevent XSS, we recommend removing any HTML from the
387 # data before displaying it.
388 },
389 ],
390 },
391 ],
392 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch.
393 # This field will always be present.
394 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]395 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]396 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. # The maintenance window defining when apps running in the foreground should
397 # be updated.
398 # This allows Play store to update the apps on the foreground in the designated
399 # window.
400 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be
401 # between 30 minutes and 24 hours (inclusive).
402 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the
403 # device. Windows can span midnight.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]405 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is
406 # &quot;deviceReportDisabled&quot;.
407 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot;
408 # allows the device&#x27;s user to configure the app update policy. &quot;always&quot;
409 # enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables
410 # auto updates only when the device is connected to wifi.
411 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot;
412 # gives the device access to all products, regardless of approval status.
413 # &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks.
414 # &quot;whitelist&quot; grants the device access the products specified in
415 # productPolicy[]. Only products that are approved or products that were
416 # previously approved (products with revoked approval) by the enterprise can
417 # be whitelisted. If no value is provided, the availability set at the user
418 # level is applied by default.
419 &quot;productPolicy&quot;: [ # The list of product policies. The &lt;code&gt;productAvailabilityPolicy&lt;/code&gt;
420 # needs to be set to &lt;code&gt;WHITELIST&lt;/code&gt; or &lt;code&gt;ALL&lt;/code&gt; for the
421 # product policies to be applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 { # The policy for a product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]423 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
424 &quot;A String&quot;,
425 ],
426 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s),
427 # identified by &lt;code&gt;trackIds&lt;/code&gt;. The list of release tracks of a
428 # product can be obtained by calling Products.Get.
429 &quot;A String&quot;,
430 ],
431 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties # The managed configuration for the product.
432 # defined by the app developer in the app&#x27;s managed configurations schema,
433 # as well as any configuration variables defined for the user.
434 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g.
435 # &quot;app:com.google.android.gm&quot;.
436 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration # Contains the ID of the managed configuration profile and the set of
437 # configuration variables (if any) defined for the user.
438 # settings ID to be applied to a single user, as well as the variable set that
439 # is attributed to the user. The variable set will be used to replace
440 # placeholders in the managed configuration settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
442 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]443 { # A variable set is a key-value pair of EMM-provided placeholders and
444 # its corresponding value, which is attributed to a user. For example,
445 # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders
446 # should start with a &#x27;$&#x27; sign and should be alphanumeric only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]447 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]448 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 },
450 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]451 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]452 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]453 { # A managed property of a managed configuration. The property must match one of
454 # the properties in the app restrictions schema of the product. Exactly one of
455 # the value fields must be populated, and it must match the property&#x27;s type in
456 # the app restrictions schema.
457 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is
458 # integer.
459 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is
460 # bool.
461 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is
462 # string, choice or hidden.
463 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the
464 # property is bundle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]465 &quot;managedProperty&quot;: [ # The list of managed properties.
466 # Object with schema name: ManagedProperty
467 ],
468 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]469 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of
470 # the property is bundle_array.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]472 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]473 # Object with schema name: ManagedProperty
474 ],
475 },
476 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]477 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the
478 # property is multiselect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]479 &quot;A String&quot;,
480 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]481 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 },
483 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]484 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]486 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
487 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means
488 # higher priority.
489 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
490 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of
491 # one constraint.
492 { # The auto-install constraint. Defines a set of restrictions for installation.
493 # At least one of the fields must be set.
494 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
495 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
496 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
497 },
498 ],
499 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed,
500 # then the app will be auto-updated according to the auto-install
501 # constraints, instead of waiting for the regular auto-update. You can set a
502 # minimum version code for at most 20 apps per device.
503 },
504 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example,
505 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 },
507 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]509 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as
510 # a lowercase hex string. For example,
511 # &lt;code&gt;&amp;quot;123456789abcdef0&amp;quot;&lt;/code&gt;.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]512 },
513 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]514 }</pre>
515</div>
516
517<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]518 <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None)</code>
519 <pre>Sets whether a device&#x27;s access to Google services is enabled or disabled.
520The device state takes effect only if enforcing EMM policies on Android
521devices is enabled in the Google Admin Console.
522Otherwise, the device state is ignored and all devices are allowed access
523to Google services.
524This is only supported for Google-managed users.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]525
526Args:
527 enterpriseId: string, The ID of the enterprise. (required)
528 userId: string, The ID of the user. (required)
529 deviceId: string, The ID of the device. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]530 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]531 The object takes the form of:
532
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]533{ # The state of a user&#x27;s device, as accessed by the getState and setState
534 # methods on device resources.
535 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that
536 # the Google account on the device can be used to access Google services
537 # (including Google Play), while &quot;disabled&quot; means that it cannot.
538 # A new device is initially in the &quot;disabled&quot; state.
539 }
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]540
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]541 x__xgafv: string, V1 error format.
542 Allowed values
543 1 - v1 error format
544 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]545
546Returns:
547 An object of the form:
548
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]549 { # The state of a user&#x27;s device, as accessed by the getState and setState
550 # methods on device resources.
551 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that
552 # the Google account on the device can be used to access Google services
553 # (including Google Play), while &quot;disabled&quot; means that it cannot.
554 # A new device is initially in the &quot;disabled&quot; state.
555 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]556</div>
557
558<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]559 <code class="details" id="update">update(enterpriseId, userId, deviceId, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 <pre>Updates the device policy
561
562Args:
563 enterpriseId: string, The ID of the enterprise. (required)
564 userId: string, The ID of the user. (required)
565 deviceId: string, The ID of the device. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]566 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 The object takes the form of:
568
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]569{ # A Devices resource represents a mobile device managed by the EMM and
570 # belonging to a specific enterprise user.
571 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed
572 # Google Play EMM in various deployment configurations. &lt;br&gt;&lt;br&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]573 # Possible values include:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]574 # &lt;ul&gt;&lt;li&gt;&quot;&lt;code&gt;managedDevice&lt;/code&gt;&quot;, a device that has the EMM&#x27;s device
575 # policy controller (DPC) as the device owner.&lt;/li&gt;
576 # &lt;li&gt;&quot;&lt;code&gt;managedProfile&lt;/code&gt;&quot;, a device that has a profile managed
577 # by the DPC (DPC is profile owner) in addition to a separate, personal
578 # profile that is unavailable to the DPC.&lt;/li&gt;
579 # &lt;li&gt;&quot;&lt;code&gt;containerApp&lt;/code&gt;&quot;, no longer used (deprecated).&lt;/li&gt;
580 # &lt;li&gt;&quot;&lt;code&gt;unmanagedProfile&lt;/code&gt;&quot;, a device that has been allowed (by the
581 # domain&#x27;s admin, using the Admin Console to enable the privilege) to use
582 # managed Google Play, but the profile is itself
583 # not owned by a DPC.&lt;/li&gt;&lt;/ul&gt;
584 &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.
585 # device.
586 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are
587 # defined by the app&#x27;s developers.
588 # This field will always be present.
589 { # List of states set by the app.
590 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app.
591 # This field will always be present.
592 &quot;keyedAppState&quot;: [ # List of keyed app states.
593 # This field will always be present.
594 { # Represents a keyed app state containing a key, timestamp, severity level,
595 # optional description, and optional data.
596 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch.
597 # This field will always be present.
598 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state.
599 # This field will always be present.
600 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example,
601 # an error message. To prevent XSS, we recommend removing any HTML from the
602 # message before displaying it.
603 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the
604 # key is set by the app&#x27;s developer. To prevent XSS, we recommend removing
605 # any HTML from the key before displaying it.
606 # This field will always be present.
607 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number
608 # or JSON object. To prevent XSS, we recommend removing any HTML from the
609 # data before displaying it.
610 },
611 ],
612 },
613 ],
614 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch.
615 # This field will always be present.
616 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]617 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]618 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. # The maintenance window defining when apps running in the foreground should
619 # be updated.
620 # This allows Play store to update the apps on the foreground in the designated
621 # window.
622 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be
623 # between 30 minutes and 24 hours (inclusive).
624 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the
625 # device. Windows can span midnight.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]627 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is
628 # &quot;deviceReportDisabled&quot;.
629 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot;
630 # allows the device&#x27;s user to configure the app update policy. &quot;always&quot;
631 # enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables
632 # auto updates only when the device is connected to wifi.
633 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot;
634 # gives the device access to all products, regardless of approval status.
635 # &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks.
636 # &quot;whitelist&quot; grants the device access the products specified in
637 # productPolicy[]. Only products that are approved or products that were
638 # previously approved (products with revoked approval) by the enterprise can
639 # be whitelisted. If no value is provided, the availability set at the user
640 # level is applied by default.
641 &quot;productPolicy&quot;: [ # The list of product policies. The &lt;code&gt;productAvailabilityPolicy&lt;/code&gt;
642 # needs to be set to &lt;code&gt;WHITELIST&lt;/code&gt; or &lt;code&gt;ALL&lt;/code&gt; for the
643 # product policies to be applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]644 { # The policy for a product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]645 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
646 &quot;A String&quot;,
647 ],
648 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s),
649 # identified by &lt;code&gt;trackIds&lt;/code&gt;. The list of release tracks of a
650 # product can be obtained by calling Products.Get.
651 &quot;A String&quot;,
652 ],
653 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties # The managed configuration for the product.
654 # defined by the app developer in the app&#x27;s managed configurations schema,
655 # as well as any configuration variables defined for the user.
656 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g.
657 # &quot;app:com.google.android.gm&quot;.
658 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration # Contains the ID of the managed configuration profile and the set of
659 # configuration variables (if any) defined for the user.
660 # settings ID to be applied to a single user, as well as the variable set that
661 # is attributed to the user. The variable set will be used to replace
662 # placeholders in the managed configuration settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]663 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
664 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]665 { # A variable set is a key-value pair of EMM-provided placeholders and
666 # its corresponding value, which is attributed to a user. For example,
667 # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders
668 # should start with a &#x27;$&#x27; sign and should be alphanumeric only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]669 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]670 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671 },
672 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]673 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]674 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]675 { # A managed property of a managed configuration. The property must match one of
676 # the properties in the app restrictions schema of the product. Exactly one of
677 # the value fields must be populated, and it must match the property&#x27;s type in
678 # the app restrictions schema.
679 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is
680 # integer.
681 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is
682 # bool.
683 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is
684 # string, choice or hidden.
685 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the
686 # property is bundle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]687 &quot;managedProperty&quot;: [ # The list of managed properties.
688 # Object with schema name: ManagedProperty
689 ],
690 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]691 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of
692 # the property is bundle_array.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]693 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]694 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]695 # Object with schema name: ManagedProperty
696 ],
697 },
698 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]699 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the
700 # property is multiselect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]701 &quot;A String&quot;,
702 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]703 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 },
705 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]706 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]708 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
709 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means
710 # higher priority.
711 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
712 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of
713 # one constraint.
714 { # The auto-install constraint. Defines a set of restrictions for installation.
715 # At least one of the fields must be set.
716 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
717 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
718 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
719 },
720 ],
721 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed,
722 # then the app will be auto-updated according to the auto-install
723 # constraints, instead of waiting for the regular auto-update. You can set a
724 # minimum version code for at most 20 apps per device.
725 },
726 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example,
727 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]728 },
729 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]730 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]731 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as
732 # a lowercase hex string. For example,
733 # &lt;code&gt;&amp;quot;123456789abcdef0&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]734}
735
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]736 updateMask: string, Mask that identifies which fields to update. If not set, all modifiable
737fields will be modified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]738
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]739When set in a query parameter, this field should be specified as
740&lt;code&gt;updateMask=&amp;lt;field1&amp;gt;,&amp;lt;field2&amp;gt;,...&lt;/code&gt;
741 x__xgafv: string, V1 error format.
742 Allowed values
743 1 - v1 error format
744 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]745
746Returns:
747 An object of the form:
748
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]749 { # A Devices resource represents a mobile device managed by the EMM and
750 # belonging to a specific enterprise user.
751 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed
752 # Google Play EMM in various deployment configurations. &lt;br&gt;&lt;br&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]753 # Possible values include:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]754 # &lt;ul&gt;&lt;li&gt;&quot;&lt;code&gt;managedDevice&lt;/code&gt;&quot;, a device that has the EMM&#x27;s device
755 # policy controller (DPC) as the device owner.&lt;/li&gt;
756 # &lt;li&gt;&quot;&lt;code&gt;managedProfile&lt;/code&gt;&quot;, a device that has a profile managed
757 # by the DPC (DPC is profile owner) in addition to a separate, personal
758 # profile that is unavailable to the DPC.&lt;/li&gt;
759 # &lt;li&gt;&quot;&lt;code&gt;containerApp&lt;/code&gt;&quot;, no longer used (deprecated).&lt;/li&gt;
760 # &lt;li&gt;&quot;&lt;code&gt;unmanagedProfile&lt;/code&gt;&quot;, a device that has been allowed (by the
761 # domain&#x27;s admin, using the Admin Console to enable the privilege) to use
762 # managed Google Play, but the profile is itself
763 # not owned by a DPC.&lt;/li&gt;&lt;/ul&gt;
764 &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.
765 # device.
766 &quot;appState&quot;: [ # List of app states set by managed apps on the device. App states are
767 # defined by the app&#x27;s developers.
768 # This field will always be present.
769 { # List of states set by the app.
770 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app.
771 # This field will always be present.
772 &quot;keyedAppState&quot;: [ # List of keyed app states.
773 # This field will always be present.
774 { # Represents a keyed app state containing a key, timestamp, severity level,
775 # optional description, and optional data.
776 &quot;stateTimestampMillis&quot;: &quot;A String&quot;, # Timestamp of when the app set the state in milliseconds since epoch.
777 # This field will always be present.
778 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state.
779 # This field will always be present.
780 &quot;message&quot;: &quot;A String&quot;, # Free-form, human-readable message describing the app state. For example,
781 # an error message. To prevent XSS, we recommend removing any HTML from the
782 # message before displaying it.
783 &quot;key&quot;: &quot;A String&quot;, # Key indicating what the app is providing a state for. The content of the
784 # key is set by the app&#x27;s developer. To prevent XSS, we recommend removing
785 # any HTML from the key before displaying it.
786 # This field will always be present.
787 &quot;data&quot;: &quot;A String&quot;, # Additional field intended for machine-readable data. For example, a number
788 # or JSON object. To prevent XSS, we recommend removing any HTML from the
789 # data before displaying it.
790 },
791 ],
792 },
793 ],
794 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch.
795 # This field will always be present.
796 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]797 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]798 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. # The maintenance window defining when apps running in the foreground should
799 # be updated.
800 # This allows Play store to update the apps on the foreground in the designated
801 # window.
802 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be
803 # between 30 minutes and 24 hours (inclusive).
804 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the
805 # device. Windows can span midnight.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]806 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]807 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is
808 # &quot;deviceReportDisabled&quot;.
809 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot;
810 # allows the device&#x27;s user to configure the app update policy. &quot;always&quot;
811 # enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables
812 # auto updates only when the device is connected to wifi.
813 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot;
814 # gives the device access to all products, regardless of approval status.
815 # &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks.
816 # &quot;whitelist&quot; grants the device access the products specified in
817 # productPolicy[]. Only products that are approved or products that were
818 # previously approved (products with revoked approval) by the enterprise can
819 # be whitelisted. If no value is provided, the availability set at the user
820 # level is applied by default.
821 &quot;productPolicy&quot;: [ # The list of product policies. The &lt;code&gt;productAvailabilityPolicy&lt;/code&gt;
822 # needs to be set to &lt;code&gt;WHITELIST&lt;/code&gt; or &lt;code&gt;ALL&lt;/code&gt; for the
823 # product policies to be applied.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]824 { # The policy for a product.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]825 &quot;tracks&quot;: [ # Deprecated. Use &lt;code&gt;trackIds&lt;/code&gt; instead.
826 &quot;A String&quot;,
827 ],
828 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s),
829 # identified by &lt;code&gt;trackIds&lt;/code&gt;. The list of release tracks of a
830 # product can be obtained by calling Products.Get.
831 &quot;A String&quot;,
832 ],
833 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties # The managed configuration for the product.
834 # defined by the app developer in the app&#x27;s managed configurations schema,
835 # as well as any configuration variables defined for the user.
836 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g.
837 # &quot;app:com.google.android.gm&quot;.
838 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration # Contains the ID of the managed configuration profile and the set of
839 # configuration variables (if any) defined for the user.
840 # settings ID to be applied to a single user, as well as the variable set that
841 # is attributed to the user. The variable set will be used to replace
842 # placeholders in the managed configuration settings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]843 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
844 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]845 { # A variable set is a key-value pair of EMM-provided placeholders and
846 # its corresponding value, which is attributed to a user. For example,
847 # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders
848 # should start with a &#x27;$&#x27; sign and should be alphanumeric only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]849 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]850 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]851 },
852 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]853 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]854 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]855 { # A managed property of a managed configuration. The property must match one of
856 # the properties in the app restrictions schema of the product. Exactly one of
857 # the value fields must be populated, and it must match the property&#x27;s type in
858 # the app restrictions schema.
859 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is
860 # integer.
861 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is
862 # bool.
863 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is
864 # string, choice or hidden.
865 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the
866 # property is bundle.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]867 &quot;managedProperty&quot;: [ # The list of managed properties.
868 # Object with schema name: ManagedProperty
869 ],
870 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]871 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of
872 # the property is bundle_array.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]873 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]874 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]875 # Object with schema name: ManagedProperty
876 ],
877 },
878 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]879 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the
880 # property is multiselect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]881 &quot;A String&quot;,
882 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]883 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]884 },
885 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]886 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]887 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]888 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
889 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means
890 # higher priority.
891 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
892 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of
893 # one constraint.
894 { # The auto-install constraint. Defines a set of restrictions for installation.
895 # At least one of the fields must be set.
896 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
897 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
898 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
899 },
900 ],
901 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed,
902 # then the app will be auto-updated according to the auto-install
903 # constraints, instead of waiting for the regular auto-update. You can set a
904 # minimum version code for at most 20 apps per device.
905 },
906 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example,
907 # &lt;code&gt;&amp;quot;app:com.google.android.gm&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]908 },
909 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]910 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]911 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as
912 # a lowercase hex string. For example,
913 # &lt;code&gt;&amp;quot;123456789abcdef0&amp;quot;&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]914 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]915</div>
916
917</body></html>