1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
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>
<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.webapps.html">webapps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(enterpriseId, webAppId)</a></code></p>
<p class="firstline">Deletes an existing web app.</p>
<p class="toc_element">
<code><a href="#get">get(enterpriseId, webAppId)</a></code></p>
<p class="firstline">Gets an existing web app.</p>
<p class="toc_element">
<code><a href="#insert">insert(enterpriseId, body)</a></code></p>
<p class="firstline">Creates a new web app for the enterprise.</p>
<p class="toc_element">
<code><a href="#list">list(enterpriseId)</a></code></p>
<p class="firstline">Retrieves the details of all web apps for a given enterprise.</p>
<p class="toc_element">
<code><a href="#patch">patch(enterpriseId, webAppId, body)</a></code></p>
<p class="firstline">Updates an existing web app. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(enterpriseId, webAppId, body)</a></code></p>
<p class="firstline">Updates an existing web app.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(enterpriseId, webAppId)</code>
<pre>Deletes an existing web app.
Args:
enterpriseId: string, The ID of the enterprise. (required)
webAppId: string, The ID of the web app. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(enterpriseId, webAppId)</code>
<pre>Gets an existing web app.
Args:
enterpriseId: string, The ID of the enterprise. (required)
webAppId: string, The ID of the web app. (required)
Returns:
An object of the form:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(enterpriseId, body)</code>
<pre>Creates a new web app for the enterprise.
Args:
enterpriseId: string, The ID of the enterprise. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}
Returns:
An object of the form:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(enterpriseId)</code>
<pre>Retrieves the details of all web apps for a given enterprise.
Args:
enterpriseId: string, The ID of the enterprise. (required)
Returns:
An object of the form:
{ # The web app details for an enterprise.
"webApp": [ # The manifest describing a web app.
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
},
],
"kind": "androidenterprise#webAppsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#webAppsListResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(enterpriseId, webAppId, body)</code>
<pre>Updates an existing web app. This method supports patch semantics.
Args:
enterpriseId: string, The ID of the enterprise. (required)
webAppId: string, The ID of the web app. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}
Returns:
An object of the form:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(enterpriseId, webAppId, body)</code>
<pre>Updates an existing web app.
Args:
enterpriseId: string, The ID of the enterprise. (required)
webAppId: string, The ID of the web app. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}
Returns:
An object of the form:
{ # 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.
"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).
"icons": [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
{ # Icon for a web app.
"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").
# - The image type can be png or jpg.
# - The image should ideally be square.
# - The image should ideally have a size of 512x512.
},
],
"displayMode": "A String", # The display mode of the web app.
#
# Possible values include:
# - "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.
# - "standalone", the device's status bar and navigation bar are visible when the app is open.
# - "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.
"isPublished": True or False, # A flag whether the app has been published to the Play store yet.
"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.
"versionCode": "A String", # The current version of the app.
#
#
# 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.
"startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application.
}</pre>
</div>
</body></html>
|
