Debian Codegraph @

docs/dyn/androidenterprise_v1.webapps.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(enterpriseId, webAppId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes an existing web app.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(enterpriseId, webAppId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets an existing web app.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a new web app for the enterprise.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the details of all web apps for a given enterprise.</p>
92 <p class="toc_element">
93 <code><a href="#update">update(enterpriseId, webAppId, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates an existing web app.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="delete">delete(enterpriseId, webAppId, x__xgafv=None)</code>
103 <pre>Deletes an existing web app.
104
105 Args:
106 enterpriseId: string, The ID of the enterprise. (required)
107 webAppId: string, The ID of the web app. (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112 </pre>
113 </div>
114
115 <div class="method">
116 <code class="details" id="get">get(enterpriseId, webAppId, x__xgafv=None)</code>
117 <pre>Gets an existing web app.
118
119 Args:
120 enterpriseId: string, The ID of the enterprise. (required)
121 webAppId: string, The ID of the web app. (required)
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127 Returns:
128 An object of the form:
129
130 { # 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.
131 &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>
143 </div>
144
145 <div class="method">
146 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
147 <pre>Creates a new web app for the enterprise.
148
149 Args:
150 enterpriseId: string, The ID of the enterprise. (required)
151 body: object, The request body.
152 The object takes the form of:
153
154 { # 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.
155 &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.
156 &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 ],
161 &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.
166 }
167
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173 Returns:
174 An object of the form:
175
176 { # 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.
177 &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>
189 </div>
190
191 <div class="method">
192 <code class="details" id="list">list(enterpriseId, x__xgafv=None)</code>
193 <pre>Retrieves the details of all web apps for a given enterprise.
194
195 Args:
196 enterpriseId: string, The ID of the enterprise. (required)
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202 Returns:
203 An object of the form:
204
205 {
206 &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>
222 </div>
223
224 <div class="method">
225 <code class="details" id="update">update(enterpriseId, webAppId, body=None, x__xgafv=None)</code>
226 <pre>Updates an existing web app.
227
228 Args:
229 enterpriseId: string, The ID of the enterprise. (required)
230 webAppId: string, The ID of the web app. (required)
231 body: object, The request body.
232 The object takes the form of:
233
234 { # 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.
235 &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.
236 &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 ],
241 &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.
246 }
247
248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253 Returns:
254 An object of the form:
255
256 { # 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.
257 &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>
269 </div>
270
271 </body></html>