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

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

115

"displayMode": "A String", # The display mode of the web app.

116

#

117

# Possible values include:

118

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

119

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

120

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

121

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

122

{ # Icon for a web app.

123

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

124

# - The image type can be png or jpg.

125

# - The image should ideally be square.

126

# - The image should ideally have a size of 512x512.

127

},

128

],

129

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

130

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

131

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

132

"versionCode": "A String", # The current version of the app.

133

#

134

#

135

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

136

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

137

}</pre>

Bu Sun Kim

715bd7f

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

141

<code class="details" id="insert">insert(enterpriseId, body=None)</code>

Bu Sun Kim

715bd7f

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

[diff] [blame]

142

<pre>Creates a new web app for the enterprise.

143

144

Args:

145

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

Dan O'Meara

dd49464

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

[diff] [blame]

146

body: object, The request body.

Bu Sun Kim

715bd7f

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

[diff] [blame]

147

The object takes the form of:

148

Bu Sun Kim

6502091

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

[diff] [blame]

149

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

150

"displayMode": "A String", # The display mode of the web app.

151

#

152

# Possible values include:

153

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

154

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

155

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

156

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

157

{ # Icon for a web app.

158

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

159

# - The image type can be png or jpg.

160

# - The image should ideally be square.

161

# - The image should ideally have a size of 512x512.

162

},

163

],

164

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

165

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

166

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

167

"versionCode": "A String", # The current version of the app.

168

#

169

#

170

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

171

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

172

}

Bu Sun Kim

715bd7f

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

[diff] [blame]

Returns:

An object of the form:

177

Bu Sun Kim

6502091

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

[diff] [blame]

178

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

179

"displayMode": "A String", # The display mode of the web app.

180

#

181

# Possible values include:

182

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

183

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

184

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

185

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

186

{ # Icon for a web app.

187

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

188

# - The image type can be png or jpg.

189

# - The image should ideally be square.

190

# - The image should ideally have a size of 512x512.

191

},

192

],

193

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

194

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

195

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

196

"versionCode": "A String", # The current version of the app.

197

#

198

#

199

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

200

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

201

}</pre>

Bu Sun Kim

715bd7f

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

[diff] [blame]

</div>

<code class="details" id="list">list(enterpriseId)</code>

206

<pre>Retrieves the details of all web apps for a given enterprise.

207

208

Args:

209

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

210

211

Returns:

212

An object of the form:

213

214

{ # The web app details for an enterprise.

Bu Sun Kim

6502091

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

[diff] [blame]

215

"kind": "androidenterprise#webAppsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#webAppsListResponse".

216

"webApp": [ # The manifest describing a web app.

217

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

218

"displayMode": "A String", # The display mode of the web app.

219

#

220

# Possible values include:

221

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

222

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

223

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

224

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

225

{ # Icon for a web app.

226

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

227

# - The image type can be png or jpg.

228

# - The image should ideally be square.

229

# - The image should ideally have a size of 512x512.

230

},

231

],

232

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

233

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

234

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

235

"versionCode": "A String", # The current version of the app.

236

#

237

#

238

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

239

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

240

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

241

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

246

<code class="details" id="update">update(enterpriseId, webAppId, body=None)</code>

Bu Sun Kim

715bd7f

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

[diff] [blame]

247

<pre>Updates an existing web app.

248

249

Args:

250

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

251

webAppId: string, The ID of the web app. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

252

body: object, The request body.

Bu Sun Kim

715bd7f

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

[diff] [blame]

253

The object takes the form of:

254

Bu Sun Kim

6502091

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

[diff] [blame]

255

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

256

"displayMode": "A String", # The display mode of the web app.

257

#

258

# Possible values include:

259

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

260

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

261

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

262

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

263

{ # Icon for a web app.

264

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

265

# - The image type can be png or jpg.

266

# - The image should ideally be square.

267

# - The image should ideally have a size of 512x512.

268

},

269

],

270

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

271

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

272

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

273

"versionCode": "A String", # The current version of the app.

274

#

275

#

276

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

277

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

278

}

Bu Sun Kim

715bd7f

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

[diff] [blame]

Returns:

An object of the form:

283

Bu Sun Kim

6502091

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

[diff] [blame]

284

{ # A WebApps resource represents a web app created for an enterprise. Web apps are published to managed Google Play and can be distributed like other Android apps. On a user's device, a web app opens its specified URL.

285

"displayMode": "A String", # The display mode of the web app.

286

#

287

# Possible values include:

288

# - "minimalUi", the device's status bar, navigation bar, the app's URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.

289

# - "standalone", the device's status bar and navigation bar are visible when the app is open.

290

# - "fullScreen", the app opens in full screen mode, hiding the device's status and navigation bars. All browser UI elements, page URL, system status bar and back button are not visible, and the web app takes up the entirety of the available display area.

291

"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.

292

{ # Icon for a web app.

293

"imageData": "A String", # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe Alphabet").

294

# - The image type can be png or jpg.

295

# - The image should ideally be square.

296

# - The image should ideally have a size of 512x512.

297

},

298

],

299

"isPublished": True or False, # A flag whether the app has been published to the Play store yet.

300

"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.

301

"title": "A String", # The title of the web app as displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

302

"versionCode": "A String", # The current version of the app.

303

#

304

#

305

# Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.

306

"webAppId": "A String", # The ID of the application. A string of the form "app:<package name>" where the package name always starts with the prefix "com.google.enterprise.webapp." followed by a random id.

307

}</pre>

Bu Sun Kim

715bd7f

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

[diff] [blame]

308

</div>

309

310

</body></html>