Blame - docs/dyn/androidenterprise_v1.devices.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

83

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

84

<code><a href="#get">get(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

85

<p class="firstline">Retrieves the details of a device.</p>

86

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

87

<code><a href="#getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-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 Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

89

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

90

<code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

91

<p class="firstline">Retrieves the IDs of all of a user's devices.</p>

92

Bu Sun Kim

2020-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 Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

Bu Sun Kim

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Updates the device policy</p>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

105

<code class="details" id="forceReportUpload">forceReportUpload(enterpriseId, userId, deviceId, x__xgafv=None)</code>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

108

Args:

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 Kim

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

120

<code class="details" id="get">get(enterpriseId, userId, deviceId, x__xgafv=None)</code>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

121

<pre>Retrieves the details of a device.

122

123

Args:

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 Kim

2020-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 Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

131

132

Returns:

133

An object of the form:

134

Dmitry Frenkel

2020-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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

136

"report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states.

137

"lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present.

138

"appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present.

139

{ # List of states set by the app.

140

"keyedAppState": [ # List of keyed app states. This field will always be present.

141

{ # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.

142

"stateTimestampMillis": "A String", # Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.

143

"message": "A String", # 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.

144

"severity": "A String", # Severity of the app state. This field will always be present.

145

"data": "A String", # 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

"key": "A String", # Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.

147

},

148

],

149

"packageName": "A String", # The package name of the app. This field will always be present.

},

],

},

"managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", 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. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain'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.

154

"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".

155

"policy": { # The device policy for a given managed device. # The policy enforced on the device.

156

"maintenanceWindow": { # 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.

157

"startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.

158

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).

159

},

160

"deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled".

161

"autoUpdatePolicy": "A String", # The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi.

162

"productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.

163

{ # The policy for a product.

164

"productId": "A String", # The ID of the product. For example, "app:com.google.android.gm".

165

"autoInstallPolicy": { # The auto-install policy for the product.

166

"autoInstallConstraint": [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.

167

{ # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.

168

"chargingStateConstraint": "A String", # Charging state constraint.

169

"networkTypeConstraint": "A String", # Network type constraint.

170

"deviceIdleStateConstraint": "A String", # Device idle state constraint.

171

},

172

],

173

"autoInstallMode": "A String", # The auto-install mode. If unset defaults to "doNotAutoInstall".

174

"autoInstallPriority": 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.

175

"minimumVersionCode": 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.

176

},

177

"tracks": [ # Deprecated. Use trackIds instead.

178

"A String",

179

],

180

"trackIds": [ # 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.

181

"A String",

182

],

183

"managedConfiguration": { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.

184

"configurationVariables": { # 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.

185

"variableSet": [ # The variable set that is attributed to the user.

186

{ # 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 '$' sign and should be alphanumeric only.

187

"placeholder": "A String", # The placeholder string; defined by EMM.

188

"userValue": "A String", # The value of the placeholder, specific to the user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

189

},

190

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

191

"mcmId": "A String", # The ID of the managed configurations settings.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

192

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

193

"productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".

194

"kind": "A String", # Deprecated.

195

"managedProperty": [ # The set of managed properties for this configuration.

196

{ # 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's type in the app restrictions schema.

197

"valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.

198

"valueInteger": 42, # The integer value - this will only be present if type of the property is integer.

199

"valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.

200

"managedProperty": [ # The list of managed properties.

201

# Object with schema name: ManagedProperty

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

202

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

203

},

204

"valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.

205

"A String",

206

],

207

"valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.

208

"key": "A String", # The unique key that identifies the property.

209

"valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.

210

{ # A bundle of managed properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

"managedProperty": [ # The list of managed properties.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

212

# Object with schema name: ManagedProperty

213

],

214

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

215

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

216

},

217

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

218

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

219

"autoUpdateMode": "A String", # The auto-update mode for the product.

220

},

221

],

222

"productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" 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.

223

},

224

}</pre>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

228

<code class="details" id="getState">getState(enterpriseId, userId, deviceId, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

229

<pre>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.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

230

231

Args:

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 Kim

2020-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 Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

239

240

Returns:

241

An object of the form:

242

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

243

{ # The state of a user's device, as accessed by the getState and setState methods on device resources.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

244

"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.

245

}</pre>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

249

<code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

250

<pre>Retrieves the IDs of all of a user's devices.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

251

252

Args:

253

enterpriseId: string, The ID of the enterprise. (required)

254

userId: string, The ID of the user. (required)

Bu Sun Kim

2020-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 Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

259

260

Returns:

261

An object of the form:

262

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

263

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

264

"device": [ # A managed device.

Dmitry Frenkel

2020-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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

266

"report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states.

267

"lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present.

268

"appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present.

269

{ # List of states set by the app.

270

"keyedAppState": [ # List of keyed app states. This field will always be present.

271

{ # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.

272

"stateTimestampMillis": "A String", # Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.

273

"message": "A String", # 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.

274

"severity": "A String", # Severity of the app state. This field will always be present.

275

"data": "A String", # 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

"key": "A String", # Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.

277

},

278

],

279

"packageName": "A String", # The package name of the app. This field will always be present.

},

],

},

"managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", 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. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain'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.

284

"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".

285

"policy": { # The device policy for a given managed device. # The policy enforced on the device.

286

"maintenanceWindow": { # 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.

287

"startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.

288

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).

289

},

290

"deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled".

291

"autoUpdatePolicy": "A String", # The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi.

292

"productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.

293

{ # The policy for a product.

294

"productId": "A String", # The ID of the product. For example, "app:com.google.android.gm".

295

"autoInstallPolicy": { # The auto-install policy for the product.

296

"autoInstallConstraint": [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.

297

{ # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.

298

"chargingStateConstraint": "A String", # Charging state constraint.

299

"networkTypeConstraint": "A String", # Network type constraint.

300

"deviceIdleStateConstraint": "A String", # Device idle state constraint.

301

},

302

],

303

"autoInstallMode": "A String", # The auto-install mode. If unset defaults to "doNotAutoInstall".

304

"autoInstallPriority": 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.

305

"minimumVersionCode": 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.

306

},

307

"tracks": [ # Deprecated. Use trackIds instead.

308

"A String",

309

],

310

"trackIds": [ # 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.

311

"A String",

312

],

313

"managedConfiguration": { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.

314

"configurationVariables": { # 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.

315

"variableSet": [ # The variable set that is attributed to the user.

316

{ # 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 '$' sign and should be alphanumeric only.

317

"placeholder": "A String", # The placeholder string; defined by EMM.

318

"userValue": "A String", # The value of the placeholder, specific to the user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

319

},

320

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

321

"mcmId": "A String", # The ID of the managed configurations settings.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

322

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

323

"productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".

324

"kind": "A String", # Deprecated.

325

"managedProperty": [ # The set of managed properties for this configuration.

326

{ # 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's type in the app restrictions schema.

327

"valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.

328

"valueInteger": 42, # The integer value - this will only be present if type of the property is integer.

329

"valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.

330

"managedProperty": [ # The list of managed properties.

331

# Object with schema name: ManagedProperty

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

333

},

334

"valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.

335

"A String",

336

],

337

"valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.

338

"key": "A String", # The unique key that identifies the property.

339

"valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.

340

{ # A bundle of managed properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

341

"managedProperty": [ # The list of managed properties.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

342

# Object with schema name: ManagedProperty

343

],

344

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

345

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

346

},

347

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

348

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

349

"autoUpdateMode": "A String", # The auto-update mode for the product.

350

},

351

],

352

"productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

353

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

354

},

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

355

],

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-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 Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

361

<pre>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.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

362

363

Args:

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'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

367

body: object, The request body.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

368

The object takes the form of:

369

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

370

{ # The state of a user's device, as accessed by the getState and setState methods on device resources.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

371

"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.

372

}

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

373

Bu Sun Kim

2020-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 Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

378

379

Returns:

380

An object of the form:

381

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

382

{ # The state of a user's device, as accessed by the getState and setState methods on device resources.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

383

"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.

384

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

389

<pre>Updates the device policy

390

391

Args:

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'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

395

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

396

The object takes the form of:

397

Dmitry Frenkel

2020-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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

399

"report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states.

400

"lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present.

401

"appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present.

402

{ # List of states set by the app.

403

"keyedAppState": [ # List of keyed app states. This field will always be present.

404

{ # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.

405

"stateTimestampMillis": "A String", # Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.

406

"message": "A String", # 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.

407

"severity": "A String", # Severity of the app state. This field will always be present.

408

"data": "A String", # 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

"key": "A String", # Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.

410

},

411

],

412

"packageName": "A String", # The package name of the app. This field will always be present.

},

],

},

"managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", 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. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain'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.

417

"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".

418

"policy": { # The device policy for a given managed device. # The policy enforced on the device.

419

"maintenanceWindow": { # 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.

420

"startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.

421

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).

422

},

423

"deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled".

424

"autoUpdatePolicy": "A String", # The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi.

425

"productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.

426

{ # The policy for a product.

427

"productId": "A String", # The ID of the product. For example, "app:com.google.android.gm".

428

"autoInstallPolicy": { # The auto-install policy for the product.

429

"autoInstallConstraint": [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.

430

{ # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.

431

"chargingStateConstraint": "A String", # Charging state constraint.

432

"networkTypeConstraint": "A String", # Network type constraint.

433

"deviceIdleStateConstraint": "A String", # Device idle state constraint.

434

},

435

],

436

"autoInstallMode": "A String", # The auto-install mode. If unset defaults to "doNotAutoInstall".

437

"autoInstallPriority": 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.

438

"minimumVersionCode": 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.

439

},

440

"tracks": [ # Deprecated. Use trackIds instead.

441

"A String",

442

],

443

"trackIds": [ # 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.

444

"A String",

445

],

446

"managedConfiguration": { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.

447

"configurationVariables": { # 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.

448

"variableSet": [ # The variable set that is attributed to the user.

449

{ # 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 '$' sign and should be alphanumeric only.

450

"placeholder": "A String", # The placeholder string; defined by EMM.

451

"userValue": "A String", # The value of the placeholder, specific to the user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

452

},

453

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

454

"mcmId": "A String", # The ID of the managed configurations settings.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

455

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

456

"productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".

457

"kind": "A String", # Deprecated.

458

"managedProperty": [ # The set of managed properties for this configuration.

459

{ # 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's type in the app restrictions schema.

460

"valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.

461

"valueInteger": 42, # The integer value - this will only be present if type of the property is integer.

462

"valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.

463

"managedProperty": [ # The list of managed properties.

464

# Object with schema name: ManagedProperty

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

466

},

467

"valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.

468

"A String",

469

],

470

"valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.

471

"key": "A String", # The unique key that identifies the property.

472

"valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.

473

{ # A bundle of managed properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

474

"managedProperty": [ # The list of managed properties.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

475

# Object with schema name: ManagedProperty

476

],

477

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

478

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

479

},

480

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

481

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

482

"autoUpdateMode": "A String", # The auto-update mode for the product.

483

},

484

],

485

"productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" 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.

486

},

487

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

488

Dmitry Frenkel

2020-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=<field1>,<field2>,...

Bu Sun Kim

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

494

495

Returns:

496

An object of the form:

497

Dmitry Frenkel

2020-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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

499

"report": { # Device report updated with the latest app states for managed apps on the device. # The device report updated with the latest app states.

500

"lastUpdatedTimestampMillis": "A String", # The timestamp of the last report update in milliseconds since epoch. This field will always be present.

501

"appState": [ # List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present.

502

{ # List of states set by the app.

503

"keyedAppState": [ # List of keyed app states. This field will always be present.

504

{ # Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.

505

"stateTimestampMillis": "A String", # Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.

506

"message": "A String", # 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.

507

"severity": "A String", # Severity of the app state. This field will always be present.

508

"data": "A String", # 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

"key": "A String", # Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.

510

},

511

],

512

"packageName": "A String", # The package name of the app. This field will always be present.

},

],

},

"managementType": "A String", # Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - "managedDevice", a device that has the EMM's device policy controller (DPC) as the device owner. - "managedProfile", 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. - "containerApp", no longer used (deprecated). - "unmanagedProfile", a device that has been allowed (by the domain'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.

517

"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, "123456789abcdef0".

518

"policy": { # The device policy for a given managed device. # The policy enforced on the device.

519

"maintenanceWindow": { # 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.

520

"startTimeAfterMidnightMs": "A String", # Start time of the maintenance window, in milliseconds after midnight on the device. Windows can span midnight.

521

"durationMs": "A String", # Duration of the maintenance window, in milliseconds. The duration must be between 30 minutes and 24 hours (inclusive).

522

},

523

"deviceReportPolicy": "A String", # Whether the device reports app states to the EMM. The default value is "deviceReportDisabled".

524

"autoUpdatePolicy": "A String", # The auto-update policy for apps installed on the device. "choiceToTheUser" allows the device's user to configure the app update policy. "always" enables auto updates. "never" disables auto updates. "wifiOnly" enables auto updates only when the device is connected to wifi.

525

"productPolicy": [ # The list of product policies. The productAvailabilityPolicy needs to be set to WHITELIST or ALL for the product policies to be applied.

526

{ # The policy for a product.

527

"productId": "A String", # The ID of the product. For example, "app:com.google.android.gm".

528

"autoInstallPolicy": { # The auto-install policy for the product.

529

"autoInstallConstraint": [ # The constraints for auto-installing the app. You can specify a maximum of one constraint.

530

{ # The auto-install constraint. Defines a set of restrictions for installation. At least one of the fields must be set.

531

"chargingStateConstraint": "A String", # Charging state constraint.

532

"networkTypeConstraint": "A String", # Network type constraint.

533

"deviceIdleStateConstraint": "A String", # Device idle state constraint.

534

},

535

],

536

"autoInstallMode": "A String", # The auto-install mode. If unset defaults to "doNotAutoInstall".

537

"autoInstallPriority": 42, # The priority of the install, as an unsigned integer. A lower number means higher priority.

538

"minimumVersionCode": 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.

539

},

540

"tracks": [ # Deprecated. Use trackIds instead.

541

"A String",

542

],

543

"trackIds": [ # 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.

544

"A String",

545

],

546

"managedConfiguration": { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user. # The managed configuration for the product.

547

"configurationVariables": { # 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.

548

"variableSet": [ # The variable set that is attributed to the user.

549

{ # 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 '$' sign and should be alphanumeric only.

550

"placeholder": "A String", # The placeholder string; defined by EMM.

551

"userValue": "A String", # The value of the placeholder, specific to the user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

552

},

553

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

554

"mcmId": "A String", # The ID of the managed configurations settings.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

555

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

556

"productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".

557

"kind": "A String", # Deprecated.

558

"managedProperty": [ # The set of managed properties for this configuration.

559

{ # 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's type in the app restrictions schema.

560

"valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.

561

"valueInteger": 42, # The integer value - this will only be present if type of the property is integer.

562

"valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.

563

"managedProperty": [ # The list of managed properties.

564

# Object with schema name: ManagedProperty

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

565

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

566

},

567

"valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.

568

"A String",

569

],

570

"valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.

571

"key": "A String", # The unique key that identifies the property.

572

"valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.

573

{ # A bundle of managed properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

574

"managedProperty": [ # The list of managed properties.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

575

# Object with schema name: ManagedProperty

576

],

577

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

578

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

579

},

580

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

581

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

582

"autoUpdateMode": "A String", # The auto-update mode for the product.

583

},

584

],

585

"productAvailabilityPolicy": "A String", # The availability granted to the device for the specified products. "all" gives the device access to all products, regardless of approval status. "all" does not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" 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.

586

},

587

}</pre>

Nathaniel Manista