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

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

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

75

<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.installs.html">installs</a></h1>

Nathaniel Manista

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame]

78

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

79

<p class="firstline">Requests to remove an app from a device. A call to <code>get</code> or</p>

Nathaniel Manista

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

[diff] [blame]

80

Bu Sun Kim

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

[diff] [blame]

81

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

Nathaniel Manista

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

[diff] [blame]

82

<p class="firstline">Retrieves details of an installation of an app on a device.</p>

83

Bu Sun Kim

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

[diff] [blame]

84

<code><a href="#list">list(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 all apps installed on the specified device.</p>

86

Bu Sun Kim

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

[diff] [blame]

87

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

88

<p class="firstline">Requests to install the latest version of an app to a device. If the app</p>

Nathaniel Manista

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

[diff] [blame]

89

<h3>Method Details</h3>

90

Bu Sun Kim

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

[diff] [blame]

91

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

92

<pre>Requests to remove an app from a device. A call to <code>get</code> or

93

<code>list</code> will still show the app as installed on the device until

94

it is actually removed.

Nathaniel Manista

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

[diff] [blame]

95

96

Args:

97

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

98

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

99

deviceId: string, The Android ID of the device. (required)

Bu Sun Kim

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

[diff] [blame]

100

installId: string, The ID of the product represented by the install, e.g.

101

"app:com.google.android.gm". (required)

102

x__xgafv: string, V1 error format.

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

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]

110

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

Nathaniel Manista

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

[diff] [blame]

111

<pre>Retrieves details of an installation of an app on a device.

112

113

Args:

114

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

115

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

116

deviceId: string, The Android ID of the device. (required)

Bu Sun Kim

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

[diff] [blame]

117

installId: string, The ID of the product represented by the install, e.g.

118

"app:com.google.android.gm". (required)

119

x__xgafv: string, V1 error format.

120

Allowed values

121

1 - v1 error format

122

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

123

124

Returns:

125

An object of the form:

126

Bu Sun Kim

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

[diff] [blame]

127

{ # The existence of an Installs resource indicates that an app is

128

# installed on a particular device (or that an install is pending).

Dan O'Meara

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

[diff] [blame]

129

#

Bu Sun Kim

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

[diff] [blame]

130

# The API can be used to create an install resource using the

131

# <a class="method-link" method="androidenterprise.installs.update">update</a>

132

# method. This triggers the actual install of the app on the device. If the

133

# user does not already have an entitlement for the app, then an attempt is

134

# made to create one. If this fails (for example, because the app is not free

135

# and there is no available license), then the creation of the install fails.

Dan O'Meara

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

[diff] [blame]

136

#

Bu Sun Kim

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

[diff] [blame]

137

# The API can also be used to update an installed app. If

138

# the&nbsp;<a class="method-link" method="androidenterprise.installs.update"

139

# style="font-style: normal; font-size: 14px; font-family: Roboto, sans-serif;

140

# line-height: 22.3999996185303px;">update</a>&nbsp;method is

141

# used on an existing install, then the app will be updated to the latest

142

# available version.

Dan O'Meara

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

[diff] [blame]

143

#

Bu Sun Kim

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

[diff] [blame]

144

# Note that it is not possible to force the installation of a specific version

145

# of an app: the version code is read-only.

Dan O'Meara

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

[diff] [blame]

146

#

Bu Sun Kim

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

[diff] [blame]

147

# If a user installs an app themselves (as permitted by the enterprise), then

148

# again an install resource and possibly an entitlement resource are

149

# automatically created.

Dan O'Meara

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

[diff] [blame]

150

#

Bu Sun Kim

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

[diff] [blame]

151

# The API can also be used to delete an install resource, which triggers the

152

# removal of the app from the device. Note that deleting an install does not

153

# automatically remove the corresponding entitlement, even if there are no

154

# remaining installs. The install resource will also be deleted if the user

155

# uninstalls the app themselves.

156

"versionCode": 42, # The version of the installed product. Guaranteed to be set only if the

157

# install state is <code>&quot;installed&quot;</code>.

158

"installState": "A String", # Install state. The state <code>&quot;installPending&quot;</code>

159

# means that an install request has recently been made and download to the

160

# device is in progress. The state <code>&quot;installed&quot;</code>

161

# means that the app has been installed. This field is read-only.

162

"productId": "A String", # The ID of the product that the install is for. For example,

163

# <code>&quot;app:com.google.android.gm&quot;</code>.

Dan O'Meara

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

[diff] [blame]

164

}</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]

168

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

Nathaniel Manista

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

[diff] [blame]

169

<pre>Retrieves the details of all apps installed on the specified device.

170

171

Args:

172

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

173

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

174

deviceId: string, The Android ID of the device. (required)

Bu Sun Kim

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

[diff] [blame]

175

x__xgafv: string, V1 error format.

176

Allowed values

177

1 - v1 error format

178

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

179

180

Returns:

181

An object of the form:

182

Bu Sun Kim

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

[diff] [blame]

183

{

184

"install": [ # An installation of an app for a user on a specific device.

185

# The existence of an install implies that the user must have an

186

# entitlement to the app.

187

{ # The existence of an Installs resource indicates that an app is

188

# installed on a particular device (or that an install is pending).

Dan O'Meara

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

[diff] [blame]

189

#

Bu Sun Kim

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

[diff] [blame]

190

# The API can be used to create an install resource using the

191

# <a class="method-link" method="androidenterprise.installs.update">update</a>

192

# method. This triggers the actual install of the app on the device. If the

193

# user does not already have an entitlement for the app, then an attempt is

194

# made to create one. If this fails (for example, because the app is not free

195

# and there is no available license), then the creation of the install fails.

Dan O'Meara

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

[diff] [blame]

196

#

Bu Sun Kim

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

[diff] [blame]

197

# The API can also be used to update an installed app. If

198

# the&nbsp;<a class="method-link" method="androidenterprise.installs.update"

199

# style="font-style: normal; font-size: 14px; font-family: Roboto, sans-serif;

200

# line-height: 22.3999996185303px;">update</a>&nbsp;method is

201

# used on an existing install, then the app will be updated to the latest

202

# available version.

Dan O'Meara

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

[diff] [blame]

203

#

Bu Sun Kim

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

[diff] [blame]

204

# Note that it is not possible to force the installation of a specific version

205

# of an app: the version code is read-only.

Dan O'Meara

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

[diff] [blame]

206

#

Bu Sun Kim

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

[diff] [blame]

207

# If a user installs an app themselves (as permitted by the enterprise), then

208

# again an install resource and possibly an entitlement resource are

209

# automatically created.

Dan O'Meara

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

[diff] [blame]

210

#

Bu Sun Kim

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

[diff] [blame]

211

# The API can also be used to delete an install resource, which triggers the

212

# removal of the app from the device. Note that deleting an install does not

213

# automatically remove the corresponding entitlement, even if there are no

214

# remaining installs. The install resource will also be deleted if the user

215

# uninstalls the app themselves.

216

"versionCode": 42, # The version of the installed product. Guaranteed to be set only if the

217

# install state is <code>&quot;installed&quot;</code>.

218

"installState": "A String", # Install state. The state <code>&quot;installPending&quot;</code>

219

# means that an install request has recently been made and download to the

220

# device is in progress. The state <code>&quot;installed&quot;</code>

221

# means that the app has been installed. This field is read-only.

222

"productId": "A String", # The ID of the product that the install is for. For example,

223

# <code>&quot;app:com.google.android.gm&quot;</code>.

Dan O'Meara

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

[diff] [blame]

224

},

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]

230

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

231

<pre>Requests to install the latest version of an app to a device. If the app

232

is already installed, then it is updated to the latest version if

233

necessary.

Nathaniel Manista

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

[diff] [blame]

234

235

Args:

236

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

237

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

238

deviceId: string, The Android ID of the device. (required)

Bu Sun Kim

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

[diff] [blame]

239

installId: string, The ID of the product represented by the install, e.g.

240

"app:com.google.android.gm". (required)

Dan O'Meara

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

[diff] [blame]

241

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

242

The object takes the form of:

243

Bu Sun Kim

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

[diff] [blame]

244

{ # The existence of an Installs resource indicates that an app is

245

# installed on a particular device (or that an install is pending).

Dan O'Meara

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

[diff] [blame]

246

#

Bu Sun Kim

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

[diff] [blame]

247

# The API can be used to create an install resource using the

248

# <a class="method-link" method="androidenterprise.installs.update">update</a>

249

# method. This triggers the actual install of the app on the device. If the

250

# user does not already have an entitlement for the app, then an attempt is

251

# made to create one. If this fails (for example, because the app is not free

252

# and there is no available license), then the creation of the install fails.

Dan O'Meara

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

[diff] [blame]

253

#

Bu Sun Kim

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

[diff] [blame]

254

# The API can also be used to update an installed app. If

255

# the&nbsp;<a class="method-link" method="androidenterprise.installs.update"

256

# style="font-style: normal; font-size: 14px; font-family: Roboto, sans-serif;

257

# line-height: 22.3999996185303px;">update</a>&nbsp;method is

258

# used on an existing install, then the app will be updated to the latest

259

# available version.

Dan O'Meara

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

[diff] [blame]

260

#

Bu Sun Kim

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

[diff] [blame]

261

# Note that it is not possible to force the installation of a specific version

262

# of an app: the version code is read-only.

Dan O'Meara

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

[diff] [blame]

263

#

Bu Sun Kim

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

[diff] [blame]

264

# If a user installs an app themselves (as permitted by the enterprise), then

265

# again an install resource and possibly an entitlement resource are

266

# automatically created.

Dan O'Meara

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

[diff] [blame]

267

#

Bu Sun Kim

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

[diff] [blame]

268

# The API can also be used to delete an install resource, which triggers the

269

# removal of the app from the device. Note that deleting an install does not

270

# automatically remove the corresponding entitlement, even if there are no

271

# remaining installs. The install resource will also be deleted if the user

272

# uninstalls the app themselves.

273

"versionCode": 42, # The version of the installed product. Guaranteed to be set only if the

274

# install state is <code>&quot;installed&quot;</code>.

275

"installState": "A String", # Install state. The state <code>&quot;installPending&quot;</code>

276

# means that an install request has recently been made and download to the

277

# device is in progress. The state <code>&quot;installed&quot;</code>

278

# means that the app has been installed. This field is read-only.

279

"productId": "A String", # The ID of the product that the install is for. For example,

280

# <code>&quot;app:com.google.android.gm&quot;</code>.

Dan O'Meara

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

[diff] [blame]

281

}

Nathaniel Manista

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

[diff] [blame]

282

Bu Sun Kim

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

[diff] [blame]

283

x__xgafv: string, V1 error format.

284

Allowed values

285

1 - v1 error format

286

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

287

288

Returns:

289

An object of the form:

290

Bu Sun Kim

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

[diff] [blame]

291

{ # The existence of an Installs resource indicates that an app is

292

# installed on a particular device (or that an install is pending).

Dan O'Meara

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

[diff] [blame]

293

#

Bu Sun Kim

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

[diff] [blame]

294

# The API can be used to create an install resource using the

295

# <a class="method-link" method="androidenterprise.installs.update">update</a>

296

# method. This triggers the actual install of the app on the device. If the

297

# user does not already have an entitlement for the app, then an attempt is

298

# made to create one. If this fails (for example, because the app is not free

299

# and there is no available license), then the creation of the install fails.

Dan O'Meara

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

[diff] [blame]

300

#

Bu Sun Kim

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

[diff] [blame]

301

# The API can also be used to update an installed app. If

302

# the&nbsp;<a class="method-link" method="androidenterprise.installs.update"

303

# style="font-style: normal; font-size: 14px; font-family: Roboto, sans-serif;

304

# line-height: 22.3999996185303px;">update</a>&nbsp;method is

305

# used on an existing install, then the app will be updated to the latest

306

# available version.

Dan O'Meara

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

[diff] [blame]

307

#

Bu Sun Kim

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

[diff] [blame]

308

# Note that it is not possible to force the installation of a specific version

309

# of an app: the version code is read-only.

Dan O'Meara

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

[diff] [blame]

310

#

Bu Sun Kim

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

[diff] [blame]

311

# If a user installs an app themselves (as permitted by the enterprise), then

312

# again an install resource and possibly an entitlement resource are

313

# automatically created.

Dan O'Meara

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

[diff] [blame]

314

#

Bu Sun Kim

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

[diff] [blame]

315

# The API can also be used to delete an install resource, which triggers the

316

# removal of the app from the device. Note that deleting an install does not

317

# automatically remove the corresponding entitlement, even if there are no

318

# remaining installs. The install resource will also be deleted if the user

319

# uninstalls the app themselves.

320

"versionCode": 42, # The version of the installed product. Guaranteed to be set only if the

321

# install state is <code>&quot;installed&quot;</code>.

322

"installState": "A String", # Install state. The state <code>&quot;installPending&quot;</code>

323

# means that an install request has recently been made and download to the

324

# device is in progress. The state <code>&quot;installed&quot;</code>

325

# means that the app has been installed. This field is read-only.

326

"productId": "A String", # The ID of the product that the install is for. For example,

327

# <code>&quot;app:com.google.android.gm&quot;</code>.

Dan O'Meara

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

[diff] [blame]

328

}</pre>

Nathaniel Manista