Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / androidenterprise_v1.devices.html
blob: d708ad057f5f4089d8e2bd3d995f9fc57250d449 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#forceReportUpload">forceReportUpload(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#get">get(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]85<p class="firstline">Retrieves the details of a device.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]91<p class="firstline">Retrieves the IDs of all of a user's devices.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code><a href="#setState">setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <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]97<p class="firstline">Updates the device policy</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 <code class="details" id="forceReportUpload">forceReportUpload(enterpriseId, userId, deviceId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 <pre>Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107
108Args:
109 enterpriseId: string, The ID of the enterprise. (required)
110 userId: string, The ID of the user. (required)
111 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116</pre>
117</div>
118
119<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 <code class="details" id="get">get(enterpriseId, userId, deviceId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]121 <pre>Retrieves the details of a device.
122
123Args:
124 enterpriseId: string, The ID of the enterprise. (required)
125 userId: string, The ID of the user. (required)
126 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131
132Returns:
133 An object of the form:
134
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]135 { # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]136 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, &quot;123456789abcdef0&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]138 &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.
139 { # List of states set by the app.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]140 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]141 &quot;keyedAppState&quot;: [ # List of keyed app states. This field will always be present.
142 { # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]144 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]145 &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.
146 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state. This field will always be present.
147 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]148 },
149 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 },
151 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]152 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]153 },
154 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - &quot;managedDevice&quot;, a device that has the EMM&#x27;s device policy controller (DPC) as the device owner. - &quot;managedProfile&quot;, a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - &quot;containerApp&quot;, no longer used (deprecated). - &quot;unmanagedProfile&quot;, a device that has been allowed (by the domain&#x27;s admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]155 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
156 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. # The maintenance window defining when apps running in the foreground should be updated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]157 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]158 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]159 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]160 &quot;productPolicy&quot;: [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.
161 { # The policy for a product.
162 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example, &quot;app:com.google.android.gm&quot;.
163 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
164 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.
165 { # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]166 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]167 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
168 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]169 },
170 ],
171 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]172 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]173 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]174 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]175 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties defined by the app developer in the app&#x27;s managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]176 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
177 { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property&#x27;s type in the app restrictions schema.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
179 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]180 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 # Object with schema name: ManagedProperty
182 ],
183 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]184 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]185 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
186 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
187 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
188 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
189 &quot;managedProperty&quot;: [ # The list of managed properties.
190 # Object with schema name: ManagedProperty
191 ],
192 },
193 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
194 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
195 &quot;A String&quot;,
196 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]197 },
198 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]199 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
200 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
201 { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a &#x27;$&#x27; sign and should be alphanumeric only.
202 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
203 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
204 },
205 ],
206 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
207 },
208 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
209 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]210 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]211 &quot;autoUpdateMode&quot;: &quot;A String&quot;, # The auto-update mode for the product.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]212 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
213 &quot;A String&quot;,
214 ],
215 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
216 &quot;A String&quot;,
217 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]218 },
219 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]220 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot; allows the device&#x27;s user to configure the app update policy. &quot;always&quot; enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables auto updates only when the device is connected to wifi.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]221 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot; gives the device access to all products, regardless of approval status. &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks. &quot;whitelist&quot; grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]222 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is &quot;deviceReportDisabled&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]223 },
224 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]225</div>
226
227<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 <code class="details" id="getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 <pre>Retrieves whether a device&#x27;s access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]230
231Args:
232 enterpriseId: string, The ID of the enterprise. (required)
233 userId: string, The ID of the user. (required)
234 deviceId: string, The ID of the device. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]235 x__xgafv: string, V1 error format.
236 Allowed values
237 1 - v1 error format
238 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]239
240Returns:
241 An object of the form:
242
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]243 { # The state of a user&#x27;s device, as accessed by the getState and setState methods on device resources.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]244 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that the Google account on the device can be used to access Google services (including Google Play), while &quot;disabled&quot; means that it cannot. A new device is initially in the &quot;disabled&quot; state.
245 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]246</div>
247
248<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]249 <code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 <pre>Retrieves the IDs of all of a user&#x27;s devices.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]251
252Args:
253 enterpriseId: string, The ID of the enterprise. (required)
254 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]259
260Returns:
261 An object of the form:
262
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]263 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 &quot;device&quot;: [ # A managed device.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]265 { # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]266 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, &quot;123456789abcdef0&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]267 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]268 &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.
269 { # List of states set by the app.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]270 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]271 &quot;keyedAppState&quot;: [ # List of keyed app states. This field will always be present.
272 { # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]273 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]274 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]275 &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.
276 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state. This field will always be present.
277 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]278 },
279 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]280 },
281 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]282 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]283 },
284 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - &quot;managedDevice&quot;, a device that has the EMM&#x27;s device policy controller (DPC) as the device owner. - &quot;managedProfile&quot;, a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - &quot;containerApp&quot;, no longer used (deprecated). - &quot;unmanagedProfile&quot;, a device that has been allowed (by the domain&#x27;s admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]285 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
286 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. # The maintenance window defining when apps running in the foreground should be updated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]287 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]288 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]289 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]290 &quot;productPolicy&quot;: [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.
291 { # The policy for a product.
292 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example, &quot;app:com.google.android.gm&quot;.
293 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
294 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.
295 { # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]296 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]297 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
298 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]299 },
300 ],
301 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]302 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]303 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]304 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]305 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties defined by the app developer in the app&#x27;s managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]306 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
307 { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property&#x27;s type in the app restrictions schema.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]308 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
309 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 # Object with schema name: ManagedProperty
312 ],
313 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]314 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]315 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
316 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
317 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
318 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
319 &quot;managedProperty&quot;: [ # The list of managed properties.
320 # Object with schema name: ManagedProperty
321 ],
322 },
323 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
324 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
325 &quot;A String&quot;,
326 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]327 },
328 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]329 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
330 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
331 { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a &#x27;$&#x27; sign and should be alphanumeric only.
332 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
333 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
334 },
335 ],
336 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
337 },
338 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
339 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]340 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]341 &quot;autoUpdateMode&quot;: &quot;A String&quot;, # The auto-update mode for the product.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]342 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
343 &quot;A String&quot;,
344 ],
345 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
346 &quot;A String&quot;,
347 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]348 },
349 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]350 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot; allows the device&#x27;s user to configure the app update policy. &quot;always&quot; enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables auto updates only when the device is connected to wifi.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]351 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot; gives the device access to all products, regardless of approval status. &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks. &quot;whitelist&quot; grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]352 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is &quot;deviceReportDisabled&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]354 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]356 }</pre>
357</div>
358
359<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]360 <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]361 <pre>Sets whether a device&#x27;s access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]362
363Args:
364 enterpriseId: string, The ID of the enterprise. (required)
365 userId: string, The ID of the user. (required)
366 deviceId: string, The ID of the device. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]367 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]368 The object takes the form of:
369
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]370{ # The state of a user&#x27;s device, as accessed by the getState and setState methods on device resources.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]371 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that the Google account on the device can be used to access Google services (including Google Play), while &quot;disabled&quot; means that it cannot. A new device is initially in the &quot;disabled&quot; state.
372 }
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]373
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]374 x__xgafv: string, V1 error format.
375 Allowed values
376 1 - v1 error format
377 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]378
379Returns:
380 An object of the form:
381
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]382 { # The state of a user&#x27;s device, as accessed by the getState and setState methods on device resources.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]383 &quot;accountState&quot;: &quot;A String&quot;, # The state of the Google account on the device. &quot;enabled&quot; indicates that the Google account on the device can be used to access Google services (including Google Play), while &quot;disabled&quot; means that it cannot. A new device is initially in the &quot;disabled&quot; state.
384 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]385</div>
386
387<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]388 <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]389 <pre>Updates the device policy
390
391Args:
392 enterpriseId: string, The ID of the enterprise. (required)
393 userId: string, The ID of the user. (required)
394 deviceId: string, The ID of the device. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]395 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 The object takes the form of:
397
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]398{ # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]399 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, &quot;123456789abcdef0&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]400 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]401 &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.
402 { # List of states set by the app.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]403 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]404 &quot;keyedAppState&quot;: [ # List of keyed app states. This field will always be present.
405 { # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]406 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]407 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]408 &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.
409 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state. This field will always be present.
410 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]411 },
412 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]413 },
414 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]415 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]416 },
417 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - &quot;managedDevice&quot;, a device that has the EMM&#x27;s device policy controller (DPC) as the device owner. - &quot;managedProfile&quot;, a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - &quot;containerApp&quot;, no longer used (deprecated). - &quot;unmanagedProfile&quot;, a device that has been allowed (by the domain&#x27;s admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]418 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
419 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. # The maintenance window defining when apps running in the foreground should be updated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]420 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]421 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]422 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]423 &quot;productPolicy&quot;: [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.
424 { # The policy for a product.
425 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example, &quot;app:com.google.android.gm&quot;.
426 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
427 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.
428 { # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]429 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]430 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
431 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]432 },
433 ],
434 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]435 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]436 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]437 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]438 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties defined by the app developer in the app&#x27;s managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]439 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
440 { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property&#x27;s type in the app restrictions schema.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]441 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
442 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 # Object with schema name: ManagedProperty
445 ],
446 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]447 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]448 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
449 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
450 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
451 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
452 &quot;managedProperty&quot;: [ # The list of managed properties.
453 # Object with schema name: ManagedProperty
454 ],
455 },
456 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
457 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
458 &quot;A String&quot;,
459 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]460 },
461 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]462 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
463 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
464 { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a &#x27;$&#x27; sign and should be alphanumeric only.
465 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
466 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
467 },
468 ],
469 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
470 },
471 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
472 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]473 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]474 &quot;autoUpdateMode&quot;: &quot;A String&quot;, # The auto-update mode for the product.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]475 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
476 &quot;A String&quot;,
477 ],
478 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
479 &quot;A String&quot;,
480 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]481 },
482 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]483 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot; allows the device&#x27;s user to configure the app update policy. &quot;always&quot; enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables auto updates only when the device is connected to wifi.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]484 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot; gives the device access to all products, regardless of approval status. &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks. &quot;whitelist&quot; grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]485 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is &quot;deviceReportDisabled&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]486 },
487}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]488
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]489 updateMask: string, Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=&lt;field1&gt;,&lt;field2&gt;,...
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]490 x__xgafv: string, V1 error format.
491 Allowed values
492 1 - v1 error format
493 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494
495Returns:
496 An object of the form:
497
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]498 { # A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]499 &quot;androidId&quot;: &quot;A String&quot;, # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, &quot;123456789abcdef0&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]500 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]501 &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.
502 { # List of states set by the app.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]503 &quot;packageName&quot;: &quot;A String&quot;, # The package name of the app. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]504 &quot;keyedAppState&quot;: [ # List of keyed app states. This field will always be present.
505 { # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]506 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]507 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]508 &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.
509 &quot;severity&quot;: &quot;A String&quot;, # Severity of the app state. This field will always be present.
510 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]511 },
512 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]513 },
514 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]515 &quot;lastUpdatedTimestampMillis&quot;: &quot;A String&quot;, # The timestamp of the last report update in milliseconds since epoch. This field will always be present.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]516 },
517 &quot;managementType&quot;: &quot;A String&quot;, # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - &quot;managedDevice&quot;, a device that has the EMM&#x27;s device policy controller (DPC) as the device owner. - &quot;managedProfile&quot;, a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - &quot;containerApp&quot;, no longer used (deprecated). - &quot;unmanagedProfile&quot;, a device that has been allowed (by the domain&#x27;s admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]518 &quot;policy&quot;: { # The device policy for a given managed device. # The policy enforced on the device.
519 &quot;maintenanceWindow&quot;: { # Maintenance window for managed Google Play Accounts. This allows Play store to update the apps on the foreground in the designated window. # The maintenance window defining when apps running in the foreground should be updated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]520 &quot;durationMs&quot;: &quot;A String&quot;, # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]521 &quot;startTimeAfterMidnightMs&quot;: &quot;A String&quot;, # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]522 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]523 &quot;productPolicy&quot;: [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.
524 { # The policy for a product.
525 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product. For example, &quot;app:com.google.android.gm&quot;.
526 &quot;autoInstallPolicy&quot;: { # The auto-install policy for the product.
527 &quot;autoInstallConstraint&quot;: [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.
528 { # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]529 &quot;deviceIdleStateConstraint&quot;: &quot;A String&quot;, # Device idle state constraint.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]530 &quot;networkTypeConstraint&quot;: &quot;A String&quot;, # Network type constraint.
531 &quot;chargingStateConstraint&quot;: &quot;A String&quot;, # Charging state constraint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]532 },
533 ],
534 &quot;autoInstallMode&quot;: &quot;A String&quot;, # The auto-install mode. If unset defaults to &quot;doNotAutoInstall&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]535 &quot;minimumVersionCode&quot;: 42, # The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]536 &quot;autoInstallPriority&quot;: 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]537 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]538 &quot;managedConfiguration&quot;: { # A managed configuration resource contains the set of managed properties defined by the app developer in the app&#x27;s managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]539 &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
540 { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property&#x27;s type in the app restrictions schema.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]541 &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
542 { # A bundle of managed properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]543 &quot;managedProperty&quot;: [ # The list of managed properties.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544 # Object with schema name: ManagedProperty
545 ],
546 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]547 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]548 &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
549 &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
550 &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
551 &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
552 &quot;managedProperty&quot;: [ # The list of managed properties.
553 # Object with schema name: ManagedProperty
554 ],
555 },
556 &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
557 &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
558 &quot;A String&quot;,
559 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]560 },
561 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]562 &quot;configurationVariables&quot;: { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
563 &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
564 { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a &#x27;$&#x27; sign and should be alphanumeric only.
565 &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
566 &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
567 },
568 ],
569 &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
570 },
571 &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
572 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]573 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]574 &quot;autoUpdateMode&quot;: &quot;A String&quot;, # The auto-update mode for the product.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]575 &quot;trackIds&quot;: [ # Grants the device visibility to the specified product release track(s), identified by trackIds. The list of release tracks of a product can be obtained by calling Products.Get.
576 &quot;A String&quot;,
577 ],
578 &quot;tracks&quot;: [ # Deprecated. Use trackIds instead.
579 &quot;A String&quot;,
580 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]581 },
582 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]583 &quot;autoUpdatePolicy&quot;: &quot;A String&quot;, # The auto-update policy for apps installed on the device. &quot;choiceToTheUser&quot; allows the device&#x27;s user to configure the app update policy. &quot;always&quot; enables auto updates. &quot;never&quot; disables auto updates. &quot;wifiOnly&quot; enables auto updates only when the device is connected to wifi.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]584 &quot;productAvailabilityPolicy&quot;: &quot;A String&quot;, # The availability granted to the device for the specified products. &quot;all&quot; gives the device access to all products, regardless of approval status. &quot;all&quot; does not enable automatic visibility of &quot;alpha&quot; or &quot;beta&quot; tracks. &quot;whitelist&quot; grants the device access the products specified in productPolicy[]. Only products that are approved or products that were previously approved (products with revoked approval) by the enterprise can be whitelisted. If no value is provided, the availability set at the user level is applied by default.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]585 &quot;deviceReportPolicy&quot;: &quot;A String&quot;, # Whether the device reports app states to the EMM. The default value is &quot;deviceReportDisabled&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]586 },
587 }</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]588</div>
589
590</body></html>