| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <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> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Requests that a new WebApp be created.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets the WebApp identified by the specified resource name.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets the configuration artifact associated with the specified WebApp.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists each WebApp associated with the specified parent Project.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates the attributes of the WebApp identified by the specified</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> | |
| <pre>Requests that a new WebApp be created. | |
| <br> | |
| <br>The result of this call is an `Operation` which can be used to track | |
| the provisioning process. The `Operation` is automatically deleted after | |
| completion, so there is no need to call `DeleteOperation`. | |
| Args: | |
| parent: string, The parent Project in which to create an App, in the format: | |
| <br><code>projects/<var>projectId</var></code> (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Details of a Firebase App for the web. | |
| "name": "A String", # The fully qualified resource name of the App, for example: | |
| # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| "displayName": "A String", # The user-assigned display name of the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| # <br> | |
| # <br>This identifier should be treated as an opaque token, as the data | |
| # format is not specified. | |
| "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. | |
| "appUrls": [ # The fully qualified URLs where the App is hosted. | |
| "A String", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a | |
| # network API call. | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. | |
| # If `true`, the operation is completed, and either `error` or `response` is | |
| # available. | |
| "response": { # The normal response of the operation in case of success. If the original | |
| # method returns no data on success, such as `Delete`, the response is | |
| # `google.protobuf.Empty`. If the original method is standard | |
| # `Get`/`Create`/`Update`, the response should be the resource. For other | |
| # methods, the response should have the type `XxxResponse`, where `Xxx` | |
| # is the original method name. For example, if the original method name | |
| # is `TakeSnapshot()`, the inferred response type is | |
| # `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that | |
| # originally returns it. If you use the default HTTP mapping, the | |
| # `name` should be a resource name ending with `operations/{unique_id}`. | |
| "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. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| }, | |
| "metadata": { # Service-specific metadata associated with the operation. It typically | |
| # contains progress information and common metadata such as create time. | |
| # Some services might not provide such metadata. Any method that returns a | |
| # long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets the WebApp identified by the specified resource name. | |
| Args: | |
| name: string, The fully qualified resource name of the App, in the format: | |
| <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| <br>As an <var>appId</var> is a unique identifier, the Unique Resource | |
| from Sub-Collection access pattern may be used here, in the format: | |
| <br><code>projects/-/webApps/<var>appId</var></code> (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Details of a Firebase App for the web. | |
| "name": "A String", # The fully qualified resource name of the App, for example: | |
| # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| "displayName": "A String", # The user-assigned display name of the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| # <br> | |
| # <br>This identifier should be treated as an opaque token, as the data | |
| # format is not specified. | |
| "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. | |
| "appUrls": [ # The fully qualified URLs where the App is hosted. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> | |
| <pre>Gets the configuration artifact associated with the specified WebApp. | |
| Args: | |
| name: string, The resource name of the App configuration to download, in the format: | |
| <br><code>projects/<var>projectId</var>/webApps/<var>appId</var>/config</code> | |
| <br>As an <var>appId</var> is a unique identifier, the Unique Resource | |
| from Sub-Collection access pattern may be used here, in the format: | |
| <br><code>projects/-/webApps/<var>appId</var></code> (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Configuration metadata of a single Firebase App for the web. | |
| "authDomain": "A String", # The domain Firebase Auth configures for OAuth redirects, in the format: | |
| # <br><code><var>projectId</var>.firebaseapp.com</code> | |
| "measurementId": "A String", # This field will no longer be provided here. Instead, use | |
| # `GetAnalyticsDetails` | |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket name. | |
| "locationId": "A String", # The ID of the project's default GCP resource location. The location is one | |
| # of the available | |
| # [GCP resource | |
| # locations](https://firebase.google.com/docs/projects/locations). <br> | |
| # <br>This field is omitted if the default GCP resource location has not been | |
| # finalized yet. To set your project's default GCP resource location, | |
| # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) | |
| # after you add Firebase services to your project. | |
| "messagingSenderId": "A String", # The sender ID for use with Firebase Cloud Messaging. | |
| "apiKey": "A String", # The API key associated with the web App. | |
| "databaseURL": "A String", # The default Firebase Realtime Database URL. | |
| "projectId": "A String", # Immutable. The globally unique, user-assigned project ID of the parent | |
| # Project for the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> | |
| <pre>Lists each WebApp associated with the specified parent Project. | |
| <br> | |
| <br>The elements are returned in no particular order, but will be a | |
| consistent view of the Apps when additional requests are made with a | |
| `pageToken`. | |
| Args: | |
| parent: string, The parent Project for which to list Apps, in the format: | |
| <br><code>projects/<var>projectId</var></code> (required) | |
| pageToken: string, Token returned from a previous call to `ListWebApps` indicating where in | |
| the set of Apps to resume listing. | |
| pageSize: integer, The maximum number of Apps to return in the response. | |
| <br> | |
| <br>The server may return fewer than this value at its discretion. | |
| If no value is specified (or too large a value is specified), then the | |
| server will impose its own limit. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "apps": [ # List of each WebApp that is in the parent Firebase Project. | |
| { # Details of a Firebase App for the web. | |
| "name": "A String", # The fully qualified resource name of the App, for example: | |
| # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| "displayName": "A String", # The user-assigned display name of the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| # <br> | |
| # <br>This identifier should be treated as an opaque token, as the data | |
| # format is not specified. | |
| "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. | |
| "appUrls": [ # The fully qualified URLs where the App is hosted. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token | |
| # is returned. If the string is empty, then this response is the last page of | |
| # results. | |
| # <br> | |
| # <br>This token can be used in a subsequent call to `ListWebApps` to find | |
| # the next group of Apps. | |
| # <br> | |
| # <br>Page tokens are short-lived and should not be persisted. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | |
| <pre>Updates the attributes of the WebApp identified by the specified | |
| resource name. | |
| Args: | |
| name: string, The fully qualified resource name of the App, for example: | |
| <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Details of a Firebase App for the web. | |
| "name": "A String", # The fully qualified resource name of the App, for example: | |
| # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| "displayName": "A String", # The user-assigned display name of the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| # <br> | |
| # <br>This identifier should be treated as an opaque token, as the data | |
| # format is not specified. | |
| "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. | |
| "appUrls": [ # The fully qualified URLs where the App is hosted. | |
| "A String", | |
| ], | |
| } | |
| updateMask: string, Specifies which fields to update. | |
| <br>Note that the fields `name`, `appId`, and `projectId` are all | |
| immutable. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Details of a Firebase App for the web. | |
| "name": "A String", # The fully qualified resource name of the App, for example: | |
| # <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code> | |
| "displayName": "A String", # The user-assigned display name of the App. | |
| "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App. | |
| # <br> | |
| # <br>This identifier should be treated as an opaque token, as the data | |
| # format is not specified. | |
| "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App. | |
| "appUrls": [ # The fully qualified URLs where the App is hosted. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| </body></html> |