| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.webApps.html">webApps</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Requests that a new WebApp be created.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets the WebApp identified by the specified resource name.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets the configuration artifact associated with the specified WebApp.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists each WebApp associated with the specified parent Project.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates the attributes of the WebApp identified by the specified</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 98 | <pre>Requests that a new WebApp be created. |
| 99 | <br> |
| 100 | <br>The result of this call is an `Operation` which can be used to track |
| 101 | the provisioning process. The `Operation` is automatically deleted after |
| 102 | completion, so there is no need to call `DeleteOperation`. |
| 103 | |
| 104 | Args: |
| 105 | parent: string, The parent Project in which to create an App, in the format: |
| 106 | <br><code>projects/<var>projectId</var></code> (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { # Details of a Firebase App for the web. |
| 111 | "appUrls": [ # The fully qualified URLs where the App is hosted. |
| 112 | "A String", |
| 113 | ], |
| 114 | "name": "A String", # The fully qualified resource name of the App, for example: |
| 115 | # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 116 | "displayName": "A String", # The user-assigned display name of the App. |
| 117 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 118 | # <br> |
| 119 | # <br>This identifier should be treated as an opaque token, as the data |
| 120 | # format is not specified. |
| 121 | "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. |
| 122 | } |
| 123 | |
| 124 | x__xgafv: string, V1 error format. |
| 125 | Allowed values |
| 126 | 1 - v1 error format |
| 127 | 2 - v2 error format |
| 128 | |
| 129 | Returns: |
| 130 | An object of the form: |
| 131 | |
| 132 | { # This resource represents a long-running operation that is the result of a |
| 133 | # network API call. |
| 134 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 135 | # If `true`, the operation is completed, and either `error` or `response` is |
| 136 | # available. |
| 137 | "response": { # The normal response of the operation in case of success. If the original |
| 138 | # method returns no data on success, such as `Delete`, the response is |
| 139 | # `google.protobuf.Empty`. If the original method is standard |
| 140 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 141 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 142 | # is the original method name. For example, if the original method name |
| 143 | # is `TakeSnapshot()`, the inferred response type is |
| 144 | # `TakeSnapshotResponse`. |
| 145 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 146 | }, |
| 147 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 148 | # originally returns it. If you use the default HTTP mapping, the |
| 149 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 150 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 151 | # different programming environments, including REST APIs and RPC APIs. It is |
| 152 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 153 | # three pieces of data: error code, error message, and error details. |
| 154 | # |
| 155 | # You can find out more about this error model and how to work with it in the |
| 156 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 157 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 158 | # user-facing error message should be localized and sent in the |
| 159 | # google.rpc.Status.details field, or localized by the client. |
| 160 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 161 | # message types for APIs to use. |
| 162 | { |
| 163 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 164 | }, |
| 165 | ], |
| 166 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 167 | }, |
| 168 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 169 | # contains progress information and common metadata such as create time. |
| 170 | # Some services might not provide such metadata. Any method that returns a |
| 171 | # long-running operation should document the metadata type, if any. |
| 172 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 173 | }, |
| 174 | }</pre> |
| 175 | </div> |
| 176 | |
| 177 | <div class="method"> |
| 178 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 179 | <pre>Gets the WebApp identified by the specified resource name. |
| 180 | |
| 181 | Args: |
| 182 | name: string, The fully qualified resource name of the App, in the format: |
| 183 | <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 184 | <br>As an <var>appId</var> is a unique identifier, the Unique Resource |
| 185 | from Sub-Collection access pattern may be used here, in the format: |
| 186 | <br><code>projects/-/webApps/<var>appId</var></code> (required) |
| 187 | x__xgafv: string, V1 error format. |
| 188 | Allowed values |
| 189 | 1 - v1 error format |
| 190 | 2 - v2 error format |
| 191 | |
| 192 | Returns: |
| 193 | An object of the form: |
| 194 | |
| 195 | { # Details of a Firebase App for the web. |
| 196 | "appUrls": [ # The fully qualified URLs where the App is hosted. |
| 197 | "A String", |
| 198 | ], |
| 199 | "name": "A String", # The fully qualified resource name of the App, for example: |
| 200 | # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 201 | "displayName": "A String", # The user-assigned display name of the App. |
| 202 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 203 | # <br> |
| 204 | # <br>This identifier should be treated as an opaque token, as the data |
| 205 | # format is not specified. |
| 206 | "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. |
| 207 | }</pre> |
| 208 | </div> |
| 209 | |
| 210 | <div class="method"> |
| 211 | <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> |
| 212 | <pre>Gets the configuration artifact associated with the specified WebApp. |
| 213 | |
| 214 | Args: |
| 215 | name: string, The resource name of the App configuration to download, in the format: |
| 216 | <br><code>projects/<var>projectId</var>/webApps/<var>appId</var>/config</code> |
| 217 | <br>As an <var>appId</var> is a unique identifier, the Unique Resource |
| 218 | from Sub-Collection access pattern may be used here, in the format: |
| 219 | <br><code>projects/-/webApps/<var>appId</var></code> (required) |
| 220 | x__xgafv: string, V1 error format. |
| 221 | Allowed values |
| 222 | 1 - v1 error format |
| 223 | 2 - v2 error format |
| 224 | |
| 225 | Returns: |
| 226 | An object of the form: |
| 227 | |
| 228 | { # Configuration metadata of a single Firebase App for the web. |
| 229 | "messagingSenderId": "A String", # The sender ID for use with Firebase Cloud Messaging. |
| 230 | "apiKey": "A String", # The API key associated with the web App. |
| 231 | "projectId": "A String", # Immutable. The globally unique, user-assigned project ID of the parent |
| 232 | # Project for the App. |
| 233 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 234 | "databaseURL": "A String", # The default Firebase Realtime Database URL. |
| 235 | "authDomain": "A String", # The domain Firebase Auth configures for OAuth redirects, in the format: |
| 236 | # <br><code><var>projectId</var>.firebaseapp.com</code> |
| 237 | "measurementId": "A String", # This field will no longer be provided here. Instead, use |
| 238 | # `GetAnalyticsDetails` |
| 239 | "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket name. |
| 240 | "locationId": "A String", # The ID of the project's default GCP resource location. The location is one |
| 241 | # of the available |
| 242 | # [GCP resource |
| 243 | # locations](https://firebase.google.com/docs/projects/locations). <br> |
| 244 | # <br>This field is omitted if the default GCP resource location has not been |
| 245 | # finalized yet. To set your project's default GCP resource location, |
| 246 | # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) |
| 247 | # after you add Firebase services to your project. |
| 248 | }</pre> |
| 249 | </div> |
| 250 | |
| 251 | <div class="method"> |
| 252 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 253 | <pre>Lists each WebApp associated with the specified parent Project. |
| 254 | <br> |
| 255 | <br>The elements are returned in no particular order, but will be a |
| 256 | consistent view of the Apps when additional requests are made with a |
| 257 | `pageToken`. |
| 258 | |
| 259 | Args: |
| 260 | parent: string, The parent Project for which to list Apps, in the format: |
| 261 | <br><code>projects/<var>projectId</var></code> (required) |
| 262 | pageToken: string, Token returned from a previous call to `ListWebApps` indicating where in |
| 263 | the set of Apps to resume listing. |
| 264 | pageSize: integer, The maximum number of Apps to return in the response. |
| 265 | <br> |
| 266 | <br>The server may return fewer than this value at its discretion. |
| 267 | If no value is specified (or too large a value is specified), then the |
| 268 | server will impose its own limit. |
| 269 | x__xgafv: string, V1 error format. |
| 270 | Allowed values |
| 271 | 1 - v1 error format |
| 272 | 2 - v2 error format |
| 273 | |
| 274 | Returns: |
| 275 | An object of the form: |
| 276 | |
| 277 | { |
| 278 | "apps": [ # List of each WebApp that is in the parent Firebase Project. |
| 279 | { # Details of a Firebase App for the web. |
| 280 | "appUrls": [ # The fully qualified URLs where the App is hosted. |
| 281 | "A String", |
| 282 | ], |
| 283 | "name": "A String", # The fully qualified resource name of the App, for example: |
| 284 | # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 285 | "displayName": "A String", # The user-assigned display name of the App. |
| 286 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 287 | # <br> |
| 288 | # <br>This identifier should be treated as an opaque token, as the data |
| 289 | # format is not specified. |
| 290 | "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. |
| 291 | }, |
| 292 | ], |
| 293 | "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token |
| 294 | # is returned. If the string is empty, then this response is the last page of |
| 295 | # results. |
| 296 | # <br> |
| 297 | # <br>This token can be used in a subsequent call to `ListWebApps` to find |
| 298 | # the next group of Apps. |
| 299 | # <br> |
| 300 | # <br>Page tokens are short-lived and should not be persisted. |
| 301 | }</pre> |
| 302 | </div> |
| 303 | |
| 304 | <div class="method"> |
| 305 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 306 | <pre>Retrieves the next page of results. |
| 307 | |
| 308 | Args: |
| 309 | previous_request: The request for the previous page. (required) |
| 310 | previous_response: The response from the request for the previous page. (required) |
| 311 | |
| 312 | Returns: |
| 313 | A request object that you can call 'execute()' on to request the next |
| 314 | page. Returns None if there are no more items in the collection. |
| 315 | </pre> |
| 316 | </div> |
| 317 | |
| 318 | <div class="method"> |
| 319 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 320 | <pre>Updates the attributes of the WebApp identified by the specified |
| 321 | resource name. |
| 322 | |
| 323 | Args: |
| 324 | name: string, The fully qualified resource name of the App, for example: |
| 325 | <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> (required) |
| 326 | body: object, The request body. |
| 327 | The object takes the form of: |
| 328 | |
| 329 | { # Details of a Firebase App for the web. |
| 330 | "appUrls": [ # The fully qualified URLs where the App is hosted. |
| 331 | "A String", |
| 332 | ], |
| 333 | "name": "A String", # The fully qualified resource name of the App, for example: |
| 334 | # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 335 | "displayName": "A String", # The user-assigned display name of the App. |
| 336 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 337 | # <br> |
| 338 | # <br>This identifier should be treated as an opaque token, as the data |
| 339 | # format is not specified. |
| 340 | "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. |
| 341 | } |
| 342 | |
| 343 | updateMask: string, Specifies which fields to update. |
| 344 | <br>Note that the fields `name`, `appId`, and `projectId` are all |
| 345 | immutable. |
| 346 | x__xgafv: string, V1 error format. |
| 347 | Allowed values |
| 348 | 1 - v1 error format |
| 349 | 2 - v2 error format |
| 350 | |
| 351 | Returns: |
| 352 | An object of the form: |
| 353 | |
| 354 | { # Details of a Firebase App for the web. |
| 355 | "appUrls": [ # The fully qualified URLs where the App is hosted. |
| 356 | "A String", |
| 357 | ], |
| 358 | "name": "A String", # The fully qualified resource name of the App, for example: |
| 359 | # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> |
| 360 | "displayName": "A String", # The user-assigned display name of the App. |
| 361 | "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. |
| 362 | # <br> |
| 363 | # <br>This identifier should be treated as an opaque token, as the data |
| 364 | # format is not specified. |
| 365 | "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. |
| 366 | }</pre> |
| 367 | </div> |
| 368 | |
| 369 | </body></html> |