Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / firebase_v1beta1.projects.webApps.html
blob: 6ba38420344b3311b0678a60e30f63ae1a67f90a [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<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="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">
Dmitry Frenkel3e17f892020-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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Requests the creation of a new WebApp in the specified FirebaseProject. 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`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Gets the specified WebApp.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the configuration artifact associated with the specified WebApp.</p>
89<p class="toc_element">
Yoshi Automation Bot0d561ef2020-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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Lists each WebApp associated with the specified FirebaseProject. 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`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Updates the attributes of the specified WebApp.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 <pre>Requests the creation of a new WebApp in the specified FirebaseProject. 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 parent: string, The resource name of the parent FirebaseProject in which to create a WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 body: object, The request body.
111 The object takes the form of:
112
113{ # Details of a Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]114 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `WebApp`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]115 &quot;webId&quot;: &quot;A String&quot;, # Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
116 &quot;name&quot;: &quot;A String&quot;, # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
117 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.
118 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]119 &quot;appUrls&quot;: [ # The URLs where the `WebApp` is hosted.
120 &quot;A String&quot;,
121 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]122 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]133 &quot;metadata&quot;: { # 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.
134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
135 },
136 &quot;done&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]138 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 {
141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
142 },
143 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]144 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 &quot;response&quot;: { # 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]149 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 <pre>Gets the specified WebApp.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156
157Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 name: string, The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # Details of a Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]168 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `WebApp`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]169 &quot;webId&quot;: &quot;A String&quot;, # Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
170 &quot;name&quot;: &quot;A String&quot;, # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
171 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.
172 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]173 &quot;appUrls&quot;: [ # The URLs where the `WebApp` is hosted.
174 &quot;A String&quot;,
175 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]176 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177</div>
178
179<div class="method">
180 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
181 <pre>Gets the configuration artifact associated with the specified WebApp.
182
183Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 name: string, The resource name of the WebApp configuration to download, in the format: projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190Returns:
191 An object of the form:
192
193 { # Configuration metadata of a single Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]194 &quot;databaseURL&quot;: &quot;A String&quot;, # The default Firebase Realtime Database URL.
195 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]196 &quot;measurementId&quot;: &quot;A String&quot;, # The unique Google-assigned identifier of the Google Analytics web stream associated with the `WebApp`. Firebase SDKs use this ID to interact with Google Analytics APIs. This field is only present if the `WebApp` is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/topic/9303475). To generate a `measurementId` and link the `WebApp` with a Google Analytics web stream, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches the `measurementId` when your app initializes Analytics. Having this ID in your config object is optional, but it does serve as a fallback in the rare case that the dynamic fetch fails.
197 &quot;locationId&quot;: &quot;A String&quot;, # The ID of the Project&#x27;s default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project&#x27;s default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
198 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`.
199 &quot;authDomain&quot;: &quot;A String&quot;, # The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com
200 &quot;messagingSenderId&quot;: &quot;A String&quot;, # The sender ID for use with Firebase Cloud Messaging.
201 &quot;apiKey&quot;: &quot;A String&quot;, # The API key associated with the `WebApp`.
202 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the `FirebaseProject`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 }</pre>
204</div>
205
206<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]207 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]208 <pre>Lists each WebApp associated with the specified FirebaseProject. 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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209
210Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 parent: string, The resource name of the parent FirebaseProject for which to list each associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]212 pageToken: string, Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]213 pageSize: integer, The maximum number of Apps to return in the response. 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219Returns:
220 An object of the form:
221
222 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]223 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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. This token can be used in a subsequent call to `ListWebApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]224 &quot;apps&quot;: [ # List of each `WebApp` associated with the specified `FirebaseProject`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 { # Details of a Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]226 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `WebApp`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]227 &quot;webId&quot;: &quot;A String&quot;, # Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
228 &quot;name&quot;: &quot;A String&quot;, # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
229 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.
230 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]231 &quot;appUrls&quot;: [ # The URLs where the `WebApp` is hosted.
232 &quot;A String&quot;,
233 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]234 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
241 <pre>Retrieves the next page of results.
242
243Args:
244 previous_request: The request for the previous page. (required)
245 previous_response: The response from the request for the previous page. (required)
246
247Returns:
248 A request object that you can call &#x27;execute()&#x27; on to request the next
249 page. Returns None if there are no more items in the collection.
250 </pre>
251</div>
252
253<div class="method">
254 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 <pre>Updates the attributes of the specified WebApp.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256
257Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]258 name: string, The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)). (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]259 body: object, The request body.
260 The object takes the form of:
261
262{ # Details of a Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]263 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `WebApp`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]264 &quot;webId&quot;: &quot;A String&quot;, # Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
265 &quot;name&quot;: &quot;A String&quot;, # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
266 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.
267 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]268 &quot;appUrls&quot;: [ # The URLs where the `WebApp` is hosted.
269 &quot;A String&quot;,
270 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]271 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]272
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]273 updateMask: string, Specifies which fields to update. Note that the fields `name`, `appId`, and `projectId` are all immutable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
278
279Returns:
280 An object of the form:
281
282 { # Details of a Firebase App for the web.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]283 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `WebApp`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]284 &quot;webId&quot;: &quot;A String&quot;, # Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`. This identifier is only used to populate the `namespace` value for the `WebApp`. For most use cases, use `appId` to identify or reference the App. The `webId` value is only unique within a `FirebaseProject` and its associated Apps.
285 &quot;name&quot;: &quot;A String&quot;, # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
286 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.
287 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]288 &quot;appUrls&quot;: [ # The URLs where the `WebApp` is hosted.
289 &quot;A String&quot;,
290 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]291 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292</div>
293
294</body></html>