Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Webapps
Stay organized with collections
Save and categorize content based on your preferences.
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.
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 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eWebApps resources represent web apps published to managed Google Play and distributed like other Android apps, opening a specified URL on the user's device.\u003c/p\u003e\n"],["\u003cp\u003eWeb apps have properties like \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003estartUrl\u003c/code\u003e, \u003ccode\u003edisplayMode\u003c/code\u003e, and \u003ccode\u003eicons\u003c/code\u003e that define their behavior and appearance.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage web apps using methods like \u003ccode\u003einsert\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003eupdate\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, and \u003ccode\u003elist\u003c/code\u003e to create, retrieve, modify, and remove them.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ewebAppId\u003c/code\u003e is a unique identifier for each web app, following the format \u003ccode\u003e"app:<package name>"\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eversionCode\u003c/code\u003e represents the current version of the app and may increase automatically for internal updates.\u003c/p\u003e\n"]]],[],null,["\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n\nA 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.\n\n```text\n{\n \"webAppId\": string,\n \"title\": string,\n \"startUrl\": string,\n \"icons\": [\n {\n \"imageData\": string\n }\n ],\n \"displayMode\": string,\n \"versionCode\": long,\n \"isPublished\": boolean\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `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. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`fullScreen`\" - \"`minimalUi`\" - \"`standalone`\" | |\n| `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. | |\n| 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. | |\n| `isPublished` | `boolean` | A flag whether the app has been published to the Play store yet. | |\n| `startUrl` | `string` | The start URL, i.e. the URL that should load when the user opens the application. | |\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| `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. | |\n| `webAppId` | `string` | The ID of the application. A string of the form `\"app:\u003cpackage name\u003e\"` where the package name always starts with the prefix `\"com.google.enterprise.webapp.\"` followed by a random id. | |\n\nMethods\n\n[delete](/android/work/play/emm-api/v1/webapps/delete)\n: Deletes an existing web app.\n\n[get](/android/work/play/emm-api/v1/webapps/get)\n: Gets an existing web app.\n\n[insert](/android/work/play/emm-api/v1/webapps/insert)\n: Creates a new web app for the enterprise.\n\n[list](/android/work/play/emm-api/v1/webapps/list)\n: Retrieves the details of all web apps for a given enterprise.\n\n[update](/android/work/play/emm-api/v1/webapps/update)\n: Updates an existing web app."]]