blob: 7ec24f8986abe0204faac831d922275e44d0639e [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="firebase_v1beta1.projects.androidApps.html">androidApps()</a></code>
79</p>
80<p class="firstline">Returns the androidApps Resource.</p>
81
82<p class="toc_element">
83 <code><a href="firebase_v1beta1.projects.availableLocations.html">availableLocations()</a></code>
84</p>
85<p class="firstline">Returns the availableLocations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="firebase_v1beta1.projects.defaultLocation.html">defaultLocation()</a></code>
89</p>
90<p class="firstline">Returns the defaultLocation Resource.</p>
91
92<p class="toc_element">
93 <code><a href="firebase_v1beta1.projects.iosApps.html">iosApps()</a></code>
94</p>
95<p class="firstline">Returns the iosApps Resource.</p>
96
97<p class="toc_element">
98 <code><a href="firebase_v1beta1.projects.webApps.html">webApps()</a></code>
99</p>
100<p class="firstline">Returns the webApps Resource.</p>
101
102<p class="toc_element">
103 <code><a href="#addFirebase">addFirebase(project, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104<p class="firstline">Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs. The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying GCP `Project`. To call `AddFirebase`, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`, and `serviceusage.services.get`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700105<p class="toc_element">
106 <code><a href="#addGoogleAnalytics">addGoogleAnalytics(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107<p class="firstline">Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). Using this call, you can either: - Specify an `analyticsAccountId` to provision a new Google Analytics property within the specified account and associate the new property with the `FirebaseProject`. - Specify an existing `analyticsPropertyId` to associate the property with the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the `FirebaseProject` (based on the `packageName` or `bundleId` associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics documentation](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To call `AddGoogleAnalytics`, a project member must be an Owner for the existing `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account. If the `FirebaseProject` already has Google Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase).</p>
108<p class="toc_element">
109 <code><a href="#close">close()</a></code></p>
110<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700111<p class="toc_element">
112 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113<p class="firstline">Gets the specified FirebaseProject.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700114<p class="toc_element">
115 <code><a href="#getAdminSdkConfig">getAdminSdkConfig(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700116<p class="firstline">Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700117<p class="toc_element">
118 <code><a href="#getAnalyticsDetails">getAnalyticsDetails(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119<p class="firstline">Gets the Google Analytics details currently associated with the specified FirebaseProject. If the `FirebaseProject` is not yet linked to Google Analytics, then the response to `GetAnalyticsDetails` is `NOT_FOUND`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700120<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800121 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700122<p class="firstline">Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700123<p class="toc_element">
124 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
125<p class="firstline">Retrieves the next page of results.</p>
126<p class="toc_element">
127 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700128<p class="firstline">Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700129<p class="toc_element">
130 <code><a href="#removeAnalytics">removeAnalytics(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700131<p class="firstline">Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified `FirebaseProject` with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a *new* data stream for each Web App. To call `RemoveAnalytics`, a project member must be an Owner for the `FirebaseProject`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700132<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800133 <code><a href="#searchApps">searchApps(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134<p class="firstline">Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700135<p class="toc_element">
136 <code><a href="#searchApps_next">searchApps_next(previous_request, previous_response)</a></code></p>
137<p class="firstline">Retrieves the next page of results.</p>
138<h3>Method Details</h3>
139<div class="method">
140 <code class="details" id="addFirebase">addFirebase(project, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 <pre>Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs. The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying GCP `Project`. To call `AddFirebase`, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`, and `serviceusage.services.get`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142
143Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144 project: string, The resource name of the GCP `Project` to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. After calling `AddFirebase`, the unique Project identifiers ( [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number) and [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id)) of the underlying GCP `Project` are also the identifiers of the FirebaseProject. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 body: object, The request body.
146 The object takes the form of:
147
148{ # All fields are required.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800149 &quot;locationId&quot;: &quot;A String&quot;, # Deprecated. Instead, to set a Project&#x27;s default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the GCP `Project`. The ID of the Project&#x27;s default GCP resource location. The location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700150 &quot;timeZone&quot;: &quot;A String&quot;, # Deprecated. Instead, to link a Project with a Google Analytics account, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add Firebase resources to the GCP `Project`. The time zone that the account will use for Google Analytics data. For example: America/Los_Angeles or Africa/Abidjan
151 &quot;regionCode&quot;: &quot;A String&quot;, # Deprecated. Instead, to link a Project with a Google Analytics account, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add Firebase resources to the GCP `Project`. The region code (CLDR) that the account will use for Google Analytics data For example: US, GB, or DE In Java, use `com.google.i18n.identifiers.RegionCode`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700152 }
153
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700162 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800163 &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}`.
164 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800165 &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.
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800168 &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`.
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700171 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 &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 -0700173 {
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800177 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800178 &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 -0700179 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700180 }</pre>
181</div>
182
183<div class="method">
184 <code class="details" id="addGoogleAnalytics">addGoogleAnalytics(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 <pre>Links the specified FirebaseProject with an existing [Google Analytics account](http://www.google.com/analytics/). Using this call, you can either: - Specify an `analyticsAccountId` to provision a new Google Analytics property within the specified account and associate the new property with the `FirebaseProject`. - Specify an existing `analyticsPropertyId` to associate the property with the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the `FirebaseProject` (based on the `packageName` or `bundleId` associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the [Analytics documentation](https://support.google.com/analytics/answer/9303323). The result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling GetOperation until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To call `AddGoogleAnalytics`, a project member must be an Owner for the existing `FirebaseProject` and have the [`Edit` permission](https://support.google.com/analytics/answer/2884495) for the Google Analytics account. If the `FirebaseProject` already has Google Analytics enabled, and you call `AddGoogleAnalytics` using an `analyticsPropertyId` that&#x27;s different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying `timeZone` and `regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase).
Bu Sun Kim65020912020-05-20 12:08:20 -0700186
187Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700188 parent: string, The resource name of the FirebaseProject to link to an existing Google Analytics account, in the format: projects/PROJECT_IDENTIFIER 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 -0700189 body: object, The request body.
190 The object takes the form of:
191
192{
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800193 &quot;analyticsPropertyId&quot;: &quot;A String&quot;, # The ID for the existing Google Analytics property that you want to associate with the `FirebaseProject`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800194 &quot;analyticsAccountId&quot;: &quot;A String&quot;, # The ID for the existing [Google Analytics account](http://www.google.com/analytics/) that you want to link with the `FirebaseProject`. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with the `FirebaseProject`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700195 }
196
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202Returns:
203 An object of the form:
204
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700205 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800206 &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}`.
207 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800208 &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.
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800211 &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`.
212 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
213 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700214 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700215 &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 -0700216 {
217 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
218 },
219 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800220 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800221 &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 -0700222 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 }</pre>
224</div>
225
226<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700227 <code class="details" id="close">close()</code>
228 <pre>Close httplib2 connections.</pre>
229</div>
230
231<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700233 <pre>Gets the specified FirebaseProject.
Bu Sun Kim65020912020-05-20 12:08:20 -0700234
235Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 name: string, The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER 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 -0700237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242Returns:
243 An object of the form:
244
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700245 { # A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing GCP `Project`. Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800246 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the Project.
247 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`.
248 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800249 &quot;resources&quot;: { # The default resources associated with the Project. # The default Firebase resources associated with the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800250 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800251 &quot;hostingSite&quot;: &quot;A String&quot;, # The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800252 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com
253 &quot;realtimeDatabaseInstance&quot;: &quot;A String&quot;, # The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800254 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800255 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800256 &quot;projectNumber&quot;: &quot;A String&quot;, # Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
257 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700258</div>
259
260<div class="method">
261 <code class="details" id="getAdminSdkConfig">getAdminSdkConfig(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262 <pre>Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with the Firebase Admin SDK [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) command.
Bu Sun Kim65020912020-05-20 12:08:20 -0700263
264Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700265 name: string, The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/adminSdkConfig 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 -0700266 x__xgafv: string, V1 error format.
267 Allowed values
268 1 - v1 error format
269 2 - v2 error format
270
271Returns:
272 An object of the form:
273
274 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700275 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the `FirebaseProject`. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800276 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800277 &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.
278 &quot;databaseURL&quot;: &quot;A String&quot;, # The default Firebase Realtime Database URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 }</pre>
280</div>
281
282<div class="method">
283 <code class="details" id="getAnalyticsDetails">getAnalyticsDetails(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700284 <pre>Gets the Google Analytics details currently associated with the specified FirebaseProject. If the `FirebaseProject` is not yet linked to Google Analytics, then the response to `GetAnalyticsDetails` is `NOT_FOUND`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700285
286Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700287 name: string, The resource name of the FirebaseProject, in the format: projects/ PROJECT_IDENTIFIER/analyticsDetails 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 -0700288 x__xgafv: string, V1 error format.
289 Allowed values
290 1 - v1 error format
291 2 - v2 error format
292
293Returns:
294 An object of the form:
295
296 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700297 &quot;streamMappings&quot;: [ # - For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each Firebase App in the specified `FirebaseProject`. Each `app` and `streamId` appears only once. - For `WebApps`: a map of `app` to `streamId` and `measurementId` for each `WebApp` in the specified `FirebaseProject`. Each `app`, `streamId`, and `measurementId` appears only once.
298 { # A mapping of a Firebase App to a Google Analytics data stream
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800299 &quot;app&quot;: &quot;A String&quot;, # The resource name of the Firebase App associated with the Google Analytics data stream, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID or projects/PROJECT_IDENTIFIER/iosApps/APP_ID or projects/PROJECT_IDENTIFIER /webApps/APP_ID Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800300 &quot;streamId&quot;: &quot;A String&quot;, # The unique Google-assigned identifier of the Google Analytics data stream associated with the Firebase App. Learn more about Google Analytics data streams in the [Analytics documentation](https://support.google.com/analytics/answer/9303323).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800301 &quot;measurementId&quot;: &quot;A String&quot;, # Applicable for Firebase Web Apps only. The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to interact with Google Analytics APIs. Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/topic/9303475).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700302 },
303 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800304 &quot;analyticsProperty&quot;: { # Details of a Google Analytics property # The Analytics Property object associated with the specified `FirebaseProject`. This object contains the details of the Google Analytics property associated with the Project.
305 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the Google Analytics property associated with the specified `FirebaseProject`.
306 &quot;id&quot;: &quot;A String&quot;, # The globally unique, Google-assigned identifier of the Google Analytics property associated with the specified `FirebaseProject`. If you called [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link the `FirebaseProject` with a Google Analytics account, the value in this `id` field is the same as the ID of the property either specified or provisioned with that call to `AddGoogleAnalytics`.
307 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700308 }</pre>
309</div>
310
311<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800312 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700313 <pre>Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.
Bu Sun Kim65020912020-05-20 12:08:20 -0700314
315Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800316 pageSize: integer, The maximum number of Projects to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. This value cannot be negative.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800317 pageToken: string, Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323Returns:
324 An object of the form:
325
326 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700327 &quot;results&quot;: [ # One page of the list of Projects that are accessible to the caller.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700328 { # A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing GCP `Project`. Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800329 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the Project.
330 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`.
331 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800332 &quot;resources&quot;: { # The default resources associated with the Project. # The default Firebase resources associated with the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800333 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800334 &quot;hostingSite&quot;: &quot;A String&quot;, # The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800335 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com
336 &quot;realtimeDatabaseInstance&quot;: &quot;A String&quot;, # The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`
Bu Sun Kim65020912020-05-20 12:08:20 -0700337 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800338 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800339 &quot;projectNumber&quot;: &quot;A String&quot;, # Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
340 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800342 &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 calls to `ListFirebaseProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
348 <pre>Retrieves the next page of results.
349
350Args:
351 previous_request: The request for the previous page. (required)
352 previous_response: The response from the request for the previous page. (required)
353
354Returns:
355 A request object that you can call &#x27;execute()&#x27; on to request the next
356 page. Returns None if there are no more items in the collection.
357 </pre>
358</div>
359
360<div class="method">
361 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700362 <pre>Updates the attributes of the specified FirebaseProject. All [query parameters](#query-parameters) are required.
Bu Sun Kim65020912020-05-20 12:08:20 -0700363
364Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700365 name: string, The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700366 body: object, The request body.
367 The object takes the form of:
368
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700369{ # A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing GCP `Project`. Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800370 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the Project.
371 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`.
372 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800373 &quot;resources&quot;: { # The default resources associated with the Project. # The default Firebase resources associated with the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800374 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800375 &quot;hostingSite&quot;: &quot;A String&quot;, # The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800376 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com
377 &quot;realtimeDatabaseInstance&quot;: &quot;A String&quot;, # The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800378 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800379 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800380 &quot;projectNumber&quot;: &quot;A String&quot;, # Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
381}
Bu Sun Kim65020912020-05-20 12:08:20 -0700382
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700383 updateMask: string, Specifies which fields to update. If this list is empty, then no state will be updated. Note that the fields `name`, `projectId`, and `projectNumber` are all immutable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700384 x__xgafv: string, V1 error format.
385 Allowed values
386 1 - v1 error format
387 2 - v2 error format
388
389Returns:
390 An object of the form:
391
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700392 { # A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing GCP `Project`. Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800393 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the Project.
394 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`.
395 &quot;state&quot;: &quot;A String&quot;, # Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800396 &quot;resources&quot;: { # The default resources associated with the Project. # The default Firebase resources associated with the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800397 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800398 &quot;hostingSite&quot;: &quot;A String&quot;, # The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800399 &quot;storageBucket&quot;: &quot;A String&quot;, # The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com
400 &quot;realtimeDatabaseInstance&quot;: &quot;A String&quot;, # The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800401 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800402 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800403 &quot;projectNumber&quot;: &quot;A String&quot;, # Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
404 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700405</div>
406
407<div class="method">
408 <code class="details" id="removeAnalytics">removeAnalytics(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700409 <pre>Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified `FirebaseProject` with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to the `FirebaseProject` by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a *new* data stream for each Web App. To call `RemoveAnalytics`, a project member must be an Owner for the `FirebaseProject`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700410
411Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700412 parent: string, The resource name of the FirebaseProject to unlink from its Google Analytics account, in the format: projects/PROJECT_IDENTIFIER 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 -0700413 body: object, The request body.
414 The object takes the form of:
415
416{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700417 &quot;analyticsPropertyId&quot;: &quot;A String&quot;, # Optional. The ID of the Google Analytics property associated with the specified `FirebaseProject`. - If not set, then the Google Analytics property that is currently associated with the specified `FirebaseProject` is removed. - If set, and the specified `FirebaseProject` is currently associated with a *different* Google Analytics property, then the response is a `412 Precondition Failed` error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 }
419
420 x__xgafv: string, V1 error format.
421 Allowed values
422 1 - v1 error format
423 2 - v2 error format
424
425Returns:
426 An object of the form:
427
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700428 { # 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 Kim65020912020-05-20 12:08:20 -0700429 }</pre>
430</div>
431
432<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800433 <code class="details" id="searchApps">searchApps(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700434 <pre>Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).
Bu Sun Kim65020912020-05-20 12:08:20 -0700435
436Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700437 parent: string, The parent FirebaseProject for which to list Apps, in the format: projects/ PROJECT_IDENTIFIER 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 -0700438 filter: string, A query string compatible with Google&#x27;s [AIP-160](https://google.aip.dev/160) standard. Use any of the following fields in a query: * [`app_id`](../projects.apps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects.apps#FirebaseAppInfo.FIELDS.namespace) * [`platform`](../projects.apps#FirebaseAppInfo.FIELDS.platform) We also support the following &quot;virtual&quot; fields (fields which are not actually part of the returned resource object, but can be queried as if they are pre-populated with specific values): * `sha1_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `sha256_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `app_store_id`: This field is considered to be a singular `string` field, populated with the Apple App Store ID registered with the app. This field is empty if the app is not an iOS app. * `team_id`: This field is considered to be a singular `string` field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800439 pageToken: string, Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800440 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. This value cannot be negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700441 x__xgafv: string, V1 error format.
442 Allowed values
443 1 - v1 error format
444 2 - v2 error format
445
446Returns:
447 An object of the form:
448
449 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800450 &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. This token can be used in a subsequent calls to `SearchFirebaseApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700451 &quot;apps&quot;: [ # One page of results from a call to `SearchFirebaseApps`.
452 { # A high-level summary of an App.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800453 &quot;appId&quot;: &quot;A String&quot;, # Output only. 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 Botb6971b02020-11-26 17:16:03 -0800454 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the Firebase App.
455 &quot;platform&quot;: &quot;A String&quot;, # The platform of the Firebase App.
456 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Firebase App, in the format: projects/PROJECT_ID /iosApps/APP_ID or projects/PROJECT_ID/androidApps/APP_ID or projects/ PROJECT_ID/webApps/APP_ID
457 &quot;namespace&quot;: &quot;A String&quot;, # Output only. Immutable. The platform-specific identifier of the App. *Note:* For most use cases, use `appId`, which is the canonical, globally unique identifier for referencing an App. This string is derived from a native identifier for each platform: `packageName` for an `AndroidApp`, `bundleId` for an `IosApp`, and `webId` for a `WebApp`. Its contents should be treated as opaque, as the native identifier format may change as platforms evolve. This string is only unique within a `FirebaseProject` and its associated Apps.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700458 },
459 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700460 }</pre>
461</div>
462
463<div class="method">
464 <code class="details" id="searchApps_next">searchApps_next(previous_request, previous_response)</code>
465 <pre>Retrieves the next page of results.
466
467Args:
468 previous_request: The request for the previous page. (required)
469 previous_response: The response from the request for the previous page. (required)
470
471Returns:
472 A request object that you can call &#x27;execute()&#x27; on to request the next
473 page. Returns None if there are no more items in the collection.
474 </pre>
475</div>
476
477</body></html>