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