Blame - docs/dyn/androidenterprise_v1.entitlements.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.entitlements.html">entitlements</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, entitlementId, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

79

<p class="firstline">Removes an entitlement to an app for a user.</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, entitlementId, 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 entitlement.</p>

83

Bu Sun Kim

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

[diff] [blame]

84

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

85

<p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p>

Nathaniel Manista

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

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

Nathaniel Manista

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

[diff] [blame]

88

<p class="firstline">Adds or updates an entitlement to an app for a user.</p>

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, entitlementId, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

92

<pre>Removes an entitlement to an app for a user.

Nathaniel Manista

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

[diff] [blame]

93

94

Args:

95

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

96

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

Bu Sun Kim

6502091

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

[diff] [blame]

97

entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)

Bu Sun Kim

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

[diff] [blame]

98

x__xgafv: string, V1 error format.

99

Allowed values

100

1 - v1 error format

101

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]

106

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

Nathaniel Manista

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

[diff] [blame]

107

<pre>Retrieves details of an entitlement.

108

109

Args:

110

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

111

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

Bu Sun Kim

6502091

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

[diff] [blame]

112

entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)

Bu Sun Kim

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

[diff] [blame]

113

x__xgafv: string, V1 error format.

114

Allowed values

115

1 - v1 error format

116

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

117

118

Returns:

119

An object of the form:

120

Bu Sun Kim

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

[diff] [blame]

121

{ # The presence of an Entitlements resource indicates that a user has the right

122

# to use a particular app. Entitlements are user specific, not device specific.

123

# This allows a user with an entitlement to an app to install the app on all

124

# their devices. It's also possible for a user to hold an entitlement to an app

125

# without installing the app on any device.

126

#

127

# The API can be used to create an entitlement. As an option, you can also use

128

# the API to trigger the installation of an app on all a user's managed devices

129

# at the same time the entitlement is created.

130

#

131

# If the app is free, creating the entitlement also creates a group license

132

# for that app. For paid apps, creating the entitlement consumes one license,

133

# and that license remains consumed until the entitlement is removed. If the

134

# enterprise hasn't purchased enough licenses, then no entitlement is created

135

# and the installation fails. An entitlement is also not created for an app if

136

# the app requires permissions that the enterprise hasn't accepted.

137

#

138

# If an entitlement is deleted, the app may be uninstalled from a user's

139

# device. As a best practice, uninstall the app by calling

140

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

141

# Installs.delete()</a> before deleting the entitlement.

142

#

143

# Entitlements for apps that a user pays for on an unmanaged profile have

144

# <code class="">"userPurchase"</code> as the entitlement reason. These

145

# entitlements cannot be removed via the API.

146

"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>

147

# for free apps. This property is temporary: it will be replaced by the <code

148

# class="">acquisition kind</code> field of group licenses.

149

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

150

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

151

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

155

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

156

<pre>Lists all entitlements for the specified user. Only the ID is set.

Nathaniel Manista

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

[diff] [blame]

157

158

Args:

159

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

160

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

Bu Sun Kim

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

[diff] [blame]

161

x__xgafv: string, V1 error format.

162

Allowed values

163

1 - v1 error format

164

2 - v2 error format

Nathaniel Manista

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

[diff] [blame]

165

166

Returns:

167

An object of the form:

168

Bu Sun Kim

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

[diff] [blame]

169

{

170

"entitlement": [ # An entitlement of a user to a product (e.g. an app).

171

# For example, a free app that they have installed, or a paid app that they

172

# have been allocated a license to.

173

{ # The presence of an Entitlements resource indicates that a user has the right

174

# to use a particular app. Entitlements are user specific, not device specific.

175

# This allows a user with an entitlement to an app to install the app on all

176

# their devices. It's also possible for a user to hold an entitlement to an app

177

# without installing the app on any device.

178

#

179

# The API can be used to create an entitlement. As an option, you can also use

180

# the API to trigger the installation of an app on all a user's managed devices

181

# at the same time the entitlement is created.

182

#

183

# If the app is free, creating the entitlement also creates a group license

184

# for that app. For paid apps, creating the entitlement consumes one license,

185

# and that license remains consumed until the entitlement is removed. If the

186

# enterprise hasn't purchased enough licenses, then no entitlement is created

187

# and the installation fails. An entitlement is also not created for an app if

188

# the app requires permissions that the enterprise hasn't accepted.

189

#

190

# If an entitlement is deleted, the app may be uninstalled from a user's

191

# device. As a best practice, uninstall the app by calling

192

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

193

# Installs.delete()</a> before deleting the entitlement.

194

#

195

# Entitlements for apps that a user pays for on an unmanaged profile have

196

# <code class="">"userPurchase"</code> as the entitlement reason. These

197

# entitlements cannot be removed via the API.

198

"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>

199

# for free apps. This property is temporary: it will be replaced by the <code

200

# class="">acquisition kind</code> field of group licenses.

201

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

202

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

203

},

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]

209

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

Nathaniel Manista

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

[diff] [blame]

210

<pre>Adds or updates an entitlement to an app for a user.

211

212

Args:

213

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

214

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

Bu Sun Kim

6502091

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

[diff] [blame]

215

entitlementId: string, The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". (required)

Dan O'Meara

dd49464

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

[diff] [blame]

216

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

217

The object takes the form of:

218

Bu Sun Kim

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

[diff] [blame]

219

{ # The presence of an Entitlements resource indicates that a user has the right

220

# to use a particular app. Entitlements are user specific, not device specific.

221

# This allows a user with an entitlement to an app to install the app on all

222

# their devices. It's also possible for a user to hold an entitlement to an app

223

# without installing the app on any device.

224

#

225

# The API can be used to create an entitlement. As an option, you can also use

226

# the API to trigger the installation of an app on all a user's managed devices

227

# at the same time the entitlement is created.

228

#

229

# If the app is free, creating the entitlement also creates a group license

230

# for that app. For paid apps, creating the entitlement consumes one license,

231

# and that license remains consumed until the entitlement is removed. If the

232

# enterprise hasn't purchased enough licenses, then no entitlement is created

233

# and the installation fails. An entitlement is also not created for an app if

234

# the app requires permissions that the enterprise hasn't accepted.

235

#

236

# If an entitlement is deleted, the app may be uninstalled from a user's

237

# device. As a best practice, uninstall the app by calling

238

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

239

# Installs.delete()</a> before deleting the entitlement.

240

#

241

# Entitlements for apps that a user pays for on an unmanaged profile have

242

# <code class="">"userPurchase"</code> as the entitlement reason. These

243

# entitlements cannot be removed via the API.

244

"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>

245

# for free apps. This property is temporary: it will be replaced by the <code

246

# class="">acquisition kind</code> field of group licenses.

247

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

248

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

249

}

Nathaniel Manista

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

[diff] [blame]

250

Bu Sun Kim

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

[diff] [blame]

251

install: boolean, Set to true to also install the product on all the user's devices where

252

possible. Failure to install on one or more devices will not prevent

253

this operation from returning successfully, as long as the entitlement

254

was successfully assigned to the user.

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

{ # The presence of an Entitlements resource indicates that a user has the right

264

# to use a particular app. Entitlements are user specific, not device specific.

265

# This allows a user with an entitlement to an app to install the app on all

266

# their devices. It's also possible for a user to hold an entitlement to an app

267

# without installing the app on any device.

268

#

269

# The API can be used to create an entitlement. As an option, you can also use

270

# the API to trigger the installation of an app on all a user's managed devices

271

# at the same time the entitlement is created.

272

#

273

# If the app is free, creating the entitlement also creates a group license

274

# for that app. For paid apps, creating the entitlement consumes one license,

275

# and that license remains consumed until the entitlement is removed. If the

276

# enterprise hasn't purchased enough licenses, then no entitlement is created

277

# and the installation fails. An entitlement is also not created for an app if

278

# the app requires permissions that the enterprise hasn't accepted.

279

#

280

# If an entitlement is deleted, the app may be uninstalled from a user's

281

# device. As a best practice, uninstall the app by calling

282

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

283

# Installs.delete()</a> before deleting the entitlement.

284

#

285

# Entitlements for apps that a user pays for on an unmanaged profile have

286

# <code class="">"userPurchase"</code> as the entitlement reason. These

287

# entitlements cannot be removed via the API.

288

"reason": "A String", # The reason for the entitlement. For example, <code class="">"free"</code>

289

# for free apps. This property is temporary: it will be replaced by the <code

290

# class="">acquisition kind</code> field of group licenses.

291

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

292

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

293

}</pre>

Nathaniel Manista