REST Resource: enterprises.webApps
Stay organized with collections
Save and categorize content based on your preferences.
Resource: WebApp
| 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 |
|
|
Creates a web app. |
|
|
Deletes a web app. |
|
|
Gets a web app. |
|
|
Lists web apps for a given enterprise. |
|
|
Updates a web app. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-19 UTC.
[null,null,["Last updated 2025-02-19 UTC."],[[["\u003cp\u003eA web app resource defines properties like name, title, URL, icons, and display mode, and allows for version control.\u003c/p\u003e\n"],["\u003cp\u003eWeb apps can be managed with methods to create, delete, retrieve, list, and update them.\u003c/p\u003e\n"],["\u003cp\u003eWebAppIcon defines the icon for the web app, supporting PNG, JPG, and WebP formats, ideally in a 512x512 size.\u003c/p\u003e\n"],["\u003cp\u003eDisplayMode allows controlling the web app's presentation, ranging from minimal UI to full-screen mode.\u003c/p\u003e\n"]]],["This describes a WebApp resource, its associated icon, and display settings. WebApps have properties like `name`, `title`, `startUrl`, `icons`, `displayMode`, and `versionCode`. `WebAppIcon` includes image data encoded in base64url. `DisplayMode` settings are `MINIMAL_UI`, `STANDALONE`, or `FULL_SCREEN`. Methods available include `create`, `delete`, `get`, `list`, and `patch`, enabling management of web apps within an enterprise.\n"],null,["# REST Resource: enterprises.webApps\n\n- [Resource: WebApp](#WebApp)\n - [JSON representation](#WebApp.SCHEMA_REPRESENTATION)\n- [WebAppIcon](#WebAppIcon)\n - [JSON representation](#WebAppIcon.SCHEMA_REPRESENTATION)\n- [DisplayMode](#DisplayMode)\n- [Methods](#METHODS_SUMMARY)\n\nResource: WebApp\n----------------\n\nA web app.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"title\": string, \"startUrl\": string, \"icons\": [ { object (/android/management/reference/rest/v1/enterprises.webApps#WebAppIcon) } ], \"displayMode\": enum (/android/management/reference/rest/v1/enterprises.webApps#DisplayMode), \"versionCode\": string } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the web app, which is generated by the server during creation in the form `enterprises/{enterpriseId}/webApps/{packageName}`. |\n| `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). |\n| `startUrl` | `string` The start URL, i.e. the URL that should load when the user opens the application. |\n| `icons[]` | `object (`[WebAppIcon](/android/management/reference/rest/v1/enterprises.webApps#WebAppIcon)`)` A list of icons for the web app. Must have at least one element. |\n| `displayMode` | `enum (`[DisplayMode](/android/management/reference/rest/v1/enterprises.webApps#DisplayMode)`)` The display mode of the web app. |\n| `versionCode` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` 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. |\n\nWebAppIcon\n----------\n\nAn icon for a web app. Supported formats are: png, jpg and webp.\n\n| JSON representation |\n|---------------------------------|\n| ``` { \"imageData\": string } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. \u003cbr /\u003e |\n\nDisplayMode\n-----------\n\nThe display mode of the web app.\n\n| Enums ||\n|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `DISPLAY_MODE_UNSPECIFIED` | Not used. |\n| `MINIMAL_UI` | Opens the web app with a minimal set of browser UI elements for controlling navigation and viewing the page URL. |\n| `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. |\n| `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. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------|----------------------------------------|\n| ### [create](/android/management/reference/rest/v1/enterprises.webApps/create) | Creates a web app. |\n| ### [delete](/android/management/reference/rest/v1/enterprises.webApps/delete) | Deletes a web app. |\n| ### [get](/android/management/reference/rest/v1/enterprises.webApps/get) | Gets a web app. |\n| ### [list](/android/management/reference/rest/v1/enterprises.webApps/list) | Lists web apps for a given enterprise. |\n| ### [patch](/android/management/reference/rest/v1/enterprises.webApps/patch) | Updates a web app. |"]]
