Webapps

For a list of methods for this resource, see the end of this page.

Resource representations

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.

{
  "webAppId": string,
  "title": string,
  "startUrl": string,
  "icons": [
    {
      "imageData": string
    }
  ],
  "displayMode": string,
  "versionCode": long,
  "isPublished": boolean
}
Property name Value Description Notes
displayMode 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.


Acceptable values are:
  • "fullScreen"
  • "minimalUi"
  • "standalone"
icons[] list A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
icons[].imageData 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.
isPublished boolean A flag whether the app has been published to the Play store yet.
startUrl string The start URL, i.e. the URL that should load when the user opens the application.
title 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).
versionCode long 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.
webAppId 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.

Methods

delete
Deletes an existing web app.
get
Gets an existing web app.
insert
Creates a new web app for the enterprise.
list
Retrieves the details of all web apps for a given enterprise.
update
Updates an existing web app.