blob: df77391526308ee46f14f4503062d38831dac247 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.webapps.html">webapps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(enterpriseId, webAppId)</a></code></p>
79<p class="firstline">Deletes an existing web app.</p>
80<p class="toc_element">
81 <code><a href="#get">get(enterpriseId, webAppId)</a></code></p>
82<p class="firstline">Gets an existing web app.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(enterpriseId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Creates a new web app for the enterprise.</p>
86<p class="toc_element">
87 <code><a href="#list">list(enterpriseId)</a></code></p>
88<p class="firstline">Retrieves the details of all web apps for a given enterprise.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#update">update(enterpriseId, webAppId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Updates an existing web app.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(enterpriseId, webAppId)</code>
95 <pre>Deletes an existing web app.
96
97Args:
98 enterpriseId: string, The ID of the enterprise. (required)
99 webAppId: string, The ID of the web app. (required)
100</pre>
101</div>
102
103<div class="method">
104 <code class="details" id="get">get(enterpriseId, webAppId)</code>
105 <pre>Gets an existing web app.
106
107Args:
108 enterpriseId: string, The ID of the enterprise. (required)
109 webAppId: string, The ID of the web app. (required)
110
111Returns:
112 An object of the form:
113
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 { # 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&#x27;s device, a web app opens its specified URL.
115 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
116 #
117 # Possible values include:
118 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
119 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
120 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
130 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
131 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
137 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138</div>
139
140<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700141 <code class="details" id="insert">insert(enterpriseId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 <pre>Creates a new web app for the enterprise.
143
144Args:
145 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700146 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147 The object takes the form of:
148
Bu Sun Kim65020912020-05-20 12:08:20 -0700149{ # 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&#x27;s device, a web app opens its specified URL.
150 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
151 #
152 # Possible values include:
153 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
154 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
155 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
165 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
166 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
172}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700173
174
175Returns:
176 An object of the form:
177
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 { # 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&#x27;s device, a web app opens its specified URL.
179 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
180 #
181 # Possible values include:
182 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
183 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
184 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
194 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
195 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
201 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700202</div>
203
204<div class="method">
205 <code class="details" id="list">list(enterpriseId)</code>
206 <pre>Retrieves the details of all web apps for a given enterprise.
207
208Args:
209 enterpriseId: string, The ID of the enterprise. (required)
210
211Returns:
212 An object of the form:
213
214 { # The web app details for an enterprise.
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;kind&quot;: &quot;androidenterprise#webAppsListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;androidenterprise#webAppsListResponse&quot;.
216 &quot;webApp&quot;: [ # 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&#x27;s device, a web app opens its specified URL.
218 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
219 #
220 # Possible values include:
221 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
222 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
223 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
233 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
234 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
240 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700241 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 }</pre>
243</div>
244
245<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700246 <code class="details" id="update">update(enterpriseId, webAppId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700247 <pre>Updates an existing web app.
248
249Args:
250 enterpriseId: string, The ID of the enterprise. (required)
251 webAppId: string, The ID of the web app. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700252 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 The object takes the form of:
254
Bu Sun Kim65020912020-05-20 12:08:20 -0700255{ # 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&#x27;s device, a web app opens its specified URL.
256 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
257 #
258 # Possible values include:
259 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
260 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
261 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
271 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
272 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
278}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700279
280
281Returns:
282 An object of the form:
283
Bu Sun Kim65020912020-05-20 12:08:20 -0700284 { # 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&#x27;s device, a web app opens its specified URL.
285 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app.
286 #
287 # Possible values include:
288 # - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option.
289 # - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open.
290 # - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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 &quot;icons&quot;: [ # 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 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;).
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 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
300 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
301 &quot;title&quot;: &quot;A String&quot;, # 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 &quot;versionCode&quot;: &quot;A String&quot;, # 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 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
307 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700308</div>
309
310</body></html>