blob: 915dbf00a3c28f4adfdf956abd24cf7b6ee88122 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(enterpriseId, webAppId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Deletes an existing web app.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084 <code><a href="#get">get(enterpriseId, webAppId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Gets an existing web app.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Creates a new web app for the enterprise.</p>
89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Retrieves the details of all web apps for a given enterprise.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093 <code><a href="#update">update(enterpriseId, webAppId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Updates an existing web app.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700102 <code class="details" id="delete">delete(enterpriseId, webAppId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103 <pre>Deletes an existing web app.
104
105Args:
106 enterpriseId: string, The ID of the enterprise. (required)
107 webAppId: string, The ID of the web app. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112</pre>
113</div>
114
115<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700116 <code class="details" id="get">get(enterpriseId, webAppId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 <pre>Gets an existing web app.
118
119Args:
120 enterpriseId: string, The ID of the enterprise. (required)
121 webAppId: string, The ID of the web app. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 { # 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&#x27;s device, a web app opens its specified URL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800131 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
132 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
133 { # Icon for a web app.
134 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
135 },
136 ],
137 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
138 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
139 &quot;title&quot;: &quot;A String&quot;, # 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).
140 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
141 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
142}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143</div>
144
145<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700146 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147 <pre>Creates a new web app for the enterprise.
148
149Args:
150 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700151 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700152 The object takes the form of:
153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154{ # 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&#x27;s device, a web app opens its specified URL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800155 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800156 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
157 { # Icon for a web app.
158 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
159 },
160 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800161 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
162 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
163 &quot;title&quot;: &quot;A String&quot;, # 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).
164 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
165 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800166}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700167
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172
173Returns:
174 An object of the form:
175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700176 { # 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&#x27;s device, a web app opens its specified URL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800177 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
178 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
179 { # Icon for a web app.
180 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
181 },
182 ],
183 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
184 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
185 &quot;title&quot;: &quot;A String&quot;, # 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).
186 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
187 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
188}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189</div>
190
191<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700192 <code class="details" id="list">list(enterpriseId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193 <pre>Retrieves the details of all web apps for a given enterprise.
194
195Args:
196 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201
202Returns:
203 An object of the form:
204
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800206 &quot;webApp&quot;: [ # The manifest describing a web app.
207 { # 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&#x27;s device, a web app opens its specified URL.
208 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
209 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
210 { # Icon for a web app.
211 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
212 },
213 ],
214 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
215 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
216 &quot;title&quot;: &quot;A String&quot;, # 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).
217 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
218 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
219 },
220 ],
221}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700222</div>
223
224<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700225 <code class="details" id="update">update(enterpriseId, webAppId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700226 <pre>Updates an existing web app.
227
228Args:
229 enterpriseId: string, The ID of the enterprise. (required)
230 webAppId: string, The ID of the web app. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700231 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 The object takes the form of:
233
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234{ # 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&#x27;s device, a web app opens its specified URL.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800235 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800236 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
237 { # Icon for a web app.
238 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
239 },
240 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800241 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
242 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
243 &quot;title&quot;: &quot;A String&quot;, # 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).
244 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
245 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700247
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700252
253Returns:
254 An object of the form:
255
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700256 { # 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&#x27;s device, a web app opens its specified URL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257 &quot;displayMode&quot;: &quot;A String&quot;, # The display mode of the web app. Possible values include: - &quot;minimalUi&quot;, the device&#x27;s status bar, navigation bar, the app&#x27;s URL, and a refresh button are visible when the app is open. For HTTP URLs, you can only select this option. - &quot;standalone&quot;, the device&#x27;s status bar and navigation bar are visible when the app is open. - &quot;fullScreen&quot;, the app opens in full screen mode, hiding the device&#x27;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.
258 &quot;icons&quot;: [ # A list of icons representing this website. If absent, a default icon (for create) or the current icon (for update) will be used.
259 { # Icon for a web app.
260 &quot;imageData&quot;: &quot;A String&quot;, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, section 5 &quot;Base 64 Encoding with URL and Filename Safe Alphabet&quot;). - The image type can be png or jpg. - The image should ideally be square. - The image should ideally have a size of 512x512.
261 },
262 ],
263 &quot;isPublished&quot;: True or False, # A flag whether the app has been published to the Play store yet.
264 &quot;startUrl&quot;: &quot;A String&quot;, # The start URL, i.e. the URL that should load when the user opens the application.
265 &quot;title&quot;: &quot;A String&quot;, # 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).
266 &quot;versionCode&quot;: &quot;A String&quot;, # 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.
267 &quot;webAppId&quot;: &quot;A String&quot;, # The ID of the application. A string of the form &quot;app:&lt;package name&gt;&quot; where the package name always starts with the prefix &quot;com.google.enterprise.webapp.&quot; followed by a random id.
268}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269</div>
270
271</body></html>