Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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="androidmanagement_v1.html">Android Management API</a> . <a href="androidmanagement_v1.enterprises.html">enterprises</a> . <a href="androidmanagement_v1.enterprises.webApps.html">webApps</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a web app.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a web app.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Gets a web app.</p> |
| 89 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 90 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists web apps for a given enterprise.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Updates a web app.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | <pre>Creates a web app. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | The object takes the form of: |
| 112 | |
| 113 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 114 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 115 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 116 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 117 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 118 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 119 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 120 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 121 | "imageData": "A 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. |
| 122 | }, |
| 123 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 124 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | |
| 126 | x__xgafv: string, V1 error format. |
| 127 | Allowed values |
| 128 | 1 - v1 error format |
| 129 | 2 - v2 error format |
| 130 | |
| 131 | Returns: |
| 132 | An object of the form: |
| 133 | |
| 134 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 135 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 136 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 137 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 138 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 139 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 140 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 141 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 142 | "imageData": "A 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. |
| 143 | }, |
| 144 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 145 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | </div> |
| 147 | |
| 148 | <div class="method"> |
| 149 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 150 | <pre>Deletes a web app. |
| 151 | |
| 152 | Args: |
| 153 | name: string, The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. (required) |
| 154 | x__xgafv: string, V1 error format. |
| 155 | Allowed values |
| 156 | 1 - v1 error format |
| 157 | 2 - v2 error format |
| 158 | |
| 159 | Returns: |
| 160 | An object of the form: |
| 161 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 162 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 163 | }</pre> |
| 164 | </div> |
| 165 | |
| 166 | <div class="method"> |
| 167 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 168 | <pre>Gets a web app. |
| 169 | |
| 170 | Args: |
| 171 | name: string, The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}. (required) |
| 172 | x__xgafv: string, V1 error format. |
| 173 | Allowed values |
| 174 | 1 - v1 error format |
| 175 | 2 - v2 error format |
| 176 | |
| 177 | Returns: |
| 178 | An object of the form: |
| 179 | |
| 180 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 181 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 182 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 183 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 184 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 185 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 186 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 187 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 188 | "imageData": "A 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. |
| 189 | }, |
| 190 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 191 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 192 | </div> |
| 193 | |
| 194 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 195 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 196 | <pre>Lists web apps for a given enterprise. |
| 197 | |
| 198 | Args: |
| 199 | parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 200 | pageToken: string, A token identifying a page of results returned by the server. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 201 | pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 202 | x__xgafv: string, V1 error format. |
| 203 | Allowed values |
| 204 | 1 - v1 error format |
| 205 | 2 - v2 error format |
| 206 | |
| 207 | Returns: |
| 208 | An object of the form: |
| 209 | |
| 210 | { # Response to a request to list web apps for a given enterprise. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 211 | "nextPageToken": "A String", # If there are more results, a token to retrieve next page of results. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 212 | "webApps": [ # The list of web apps. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 213 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 214 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 215 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 216 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 217 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 218 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 219 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 220 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 221 | "imageData": "A 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. |
| 222 | }, |
| 223 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 224 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 225 | ], |
| 226 | }</pre> |
| 227 | </div> |
| 228 | |
| 229 | <div class="method"> |
| 230 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 231 | <pre>Retrieves the next page of results. |
| 232 | |
| 233 | Args: |
| 234 | previous_request: The request for the previous page. (required) |
| 235 | previous_response: The response from the request for the previous page. (required) |
| 236 | |
| 237 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 238 | A request object that you can call 'execute()' on to request the next |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 239 | page. Returns None if there are no more items in the collection. |
| 240 | </pre> |
| 241 | </div> |
| 242 | |
| 243 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 244 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 245 | <pre>Updates a web app. |
| 246 | |
| 247 | Args: |
| 248 | name: string, The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 249 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 250 | The object takes the form of: |
| 251 | |
| 252 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 253 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 254 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 255 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 256 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 257 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 258 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 259 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 260 | "imageData": "A 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. |
| 261 | }, |
| 262 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 263 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | |
| 265 | updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified. |
| 266 | x__xgafv: string, V1 error format. |
| 267 | Allowed values |
| 268 | 1 - v1 error format |
| 269 | 2 - v2 error format |
| 270 | |
| 271 | Returns: |
| 272 | An object of the form: |
| 273 | |
| 274 | { # A web app. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 275 | "title": "A 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). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 276 | "versionCode": "A String", # 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. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 277 | "displayMode": "A String", # The display mode of the web app. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 278 | "name": "A String", # The name of the web app, which is generated by the server during creation in the form enterprises/{enterpriseId}/webApps/{packageName}. |
| 279 | "startUrl": "A String", # The start URL, i.e. the URL that should load when the user opens the application. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 280 | "icons": [ # A list of icons for the web app. Must have at least one element. |
| 281 | { # An icon for a web app. Supported formats are: png, jpg and webp. |
| 282 | "imageData": "A 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. |
| 283 | }, |
| 284 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 285 | }</pre> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 286 | </div> |
| 287 | |
| 288 | </body></html> |