REST Resource: enterprises.webApps

Resource: WebApp

A web app.

JSON representation
{
  "name": string,
  "title": string,
  "startUrl": string,
  "icons": [
    {
      object (WebAppIcon)
    }
  ],
  "displayMode": enum (DisplayMode),
  "versionCode": string
}
Fields
name

string

The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}.

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).

startUrl

string

The start URL, i.e. the URL that should load when the user opens the application.

icons[]

object (WebAppIcon)

A list of icons for the web app. Must have at least one element.

displayMode

enum (DisplayMode)

The display mode of the web app.

versionCode

string (int64 format)

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.

WebAppIcon

An icon for a web app. Supported formats are: png, jpg and webp.

JSON representation
{
  "imageData": string
}
Fields
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.

DisplayMode

The display mode of the web app.

Enums
DISPLAY_MODE_UNSPECIFIED Not used.
MINIMAL_UI Opens the web app with a minimal set of browser UI elements for controlling navigation and viewing the page URL.
STANDALONE Opens the web app to look and feel like a standalone native application. The browser UI elements and page URL are not visible, however the system status bar and back button are visible.
FULL_SCREEN Opens the web app in full screen without any visible controls. The 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.

Methods

create

Creates a web app.

delete

Deletes a web app.

get

Gets a web app.

list

Lists web apps for a given enterprise.

patch

Updates a web app.