| <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></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="firebase_v1beta1.projects.androidApps.html">androidApps()</a></code> |
| </p> |
| <p class="firstline">Returns the androidApps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="firebase_v1beta1.projects.availableLocations.html">availableLocations()</a></code> |
| </p> |
| <p class="firstline">Returns the availableLocations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="firebase_v1beta1.projects.defaultLocation.html">defaultLocation()</a></code> |
| </p> |
| <p class="firstline">Returns the defaultLocation Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="firebase_v1beta1.projects.iosApps.html">iosApps()</a></code> |
| </p> |
| <p class="firstline">Returns the iosApps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="firebase_v1beta1.projects.webApps.html">webApps()</a></code> |
| </p> |
| <p class="firstline">Returns the webApps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#addFirebase">addFirebase(project, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds Firebase resources to the specified existing</p> |
| <p class="toc_element"> |
| <code><a href="#addGoogleAnalytics">addGoogleAnalytics(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Links a FirebaseProject with an existing</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the FirebaseProject identified by the specified resource name.</p> |
| <p class="toc_element"> |
| <code><a href="#getAdminSdkConfig">getAdminSdkConfig(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the configuration artifact used by servers to simplify initialization.</p> |
| <p class="toc_element"> |
| <code><a href="#getAnalyticsDetails">getAnalyticsDetails(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the Google Analytics details currently associated with a</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists each FirebaseProject accessible to the caller.</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 FirebaseProject identified by the</p> |
| <p class="toc_element"> |
| <code><a href="#removeAnalytics">removeAnalytics(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Unlinks the specified `FirebaseProject` from its Google Analytics account.</p> |
| <p class="toc_element"> |
| <code><a href="#searchApps">searchApps(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">A convenience method that lists all available Apps for the specified</p> |
| <p class="toc_element"> |
| <code><a href="#searchApps_next">searchApps_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="addFirebase">addFirebase(project, body=None, x__xgafv=None)</code> |
| <pre>Adds Firebase resources to the specified existing |
| [Google Cloud Platform (GCP) `Project`] |
| (https://cloud.google.com/resource-manager/reference/rest/v1/projects). |
| <br> |
| <br>Since a FirebaseProject is actually also a GCP `Project`, a |
| `FirebaseProject` uses underlying GCP identifiers (most importantly, |
| the `PROJECT_NUMBER`) as its own for easy interop with GCP APIs. |
| <br> |
| <br>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. |
| <br> |
| <br>This method does not modify any billing account information on the |
| underlying GCP `Project`. |
| <br> |
| <br>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`. |
| |
| Args: |
| project: string, The resource name of the GCP `Project` to which Firebase resources will be |
| added, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var></code> |
| After calling `AddFirebase`, the |
| [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/projects#Project.FIELDS.project_id) |
| of the GCP `Project` is also the `project_id` of the FirebaseProject. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # All fields are required. |
| "timeZone": "A String", # Deprecated. Instead, to link your Project with a Google Analytics account, |
| # call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) |
| # after you add Firebase resources to your Project. |
| # <br> |
| # <br>The time zone that the account will use for Firebase Analytics data. |
| # <br>For example: America/Los_Angeles or Africa/Abidjan |
| "locationId": "A String", # Deprecated. Instead, to set your project's default GCP resource location, |
| # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) |
| # after you add Firebase resources to your project. |
| # <br> |
| # <br>The ID of the project's default GCP resource location. The location |
| # must be one of the available |
| # [GCP resource |
| # locations](https://firebase.google.com/docs/projects/locations). |
| "regionCode": "A String", # Deprecated. Instead, to link your Project with a Google Analytics account, |
| # call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) |
| # after you add Firebase resources to your Project. |
| # <br> |
| # <br>The region code (CLDR) that the account will use for Firebase Analytics |
| # data. |
| # <br>For example: US, GB, or DE |
| # <br> |
| # <br>In Java, use `com.google.i18n.identifiers.RegionCode`. |
| } |
| |
| 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. |
| "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. |
| }, |
| "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. |
| }, |
| "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}`. |
| "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. |
| }, |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="addGoogleAnalytics">addGoogleAnalytics(parent, body=None, x__xgafv=None)</code> |
| <pre>Links a FirebaseProject with an existing |
| [Google Analytics account](http://www.google.com/analytics/). |
| <br> |
| <br>Using this call, you can either: |
| <ul> |
| <li>Specify an `analyticsAccountId` to provision a new Google Analytics |
| property within the specified account and associate the new property with |
| your `FirebaseProject`.</li> |
| <li>Specify an existing `analyticsPropertyId` to associate the property |
| with your `FirebaseProject`.</li> |
| </ul> |
| <br> |
| Note that when you call `AddGoogleAnalytics`: |
| <ol> |
| <li>The first check determines if any existing data streams in the |
| Google Analytics property correspond to any existing Firebase Apps in your |
| `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 Android Apps and iOS |
| Apps.</li> |
| <li>If no corresponding data streams are found for your Firebase Apps, |
| new data streams are provisioned in the Google Analytics property |
| for each of your 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 your Analytics property.</li> |
| </ol> |
| Learn more about the hierarchy and structure of Google Analytics |
| accounts in the |
| [Analytics |
| documentation](https://support.google.com/analytics/answer/9303323). |
| <br> |
| <br>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. |
| <br> |
| <br>To call `AddGoogleAnalytics`, a 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. |
| <br> |
| <br>If a `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). |
| |
| Args: |
| parent: string, The parent `FirebaseProject` to link to an existing Google Analytics |
| account, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var></code> (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "analyticsPropertyId": "A String", # The ID for the existing Google Analytics property that you want to |
| # associate with your `FirebaseProject`. |
| "analyticsAccountId": "A String", # The ID for the existing |
| # [Google Analytics account](http://www.google.com/analytics/) that you |
| # want to link with your `FirebaseProject`. |
| # <br> |
| # <br>Specifying this field will provision a new Google Analytics |
| # property in your Google Analytics account and associate the new property |
| # with your `FirebaseProject`. |
| } |
| |
| 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. |
| "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. |
| }, |
| "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. |
| }, |
| "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}`. |
| "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. |
| }, |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the FirebaseProject identified by the specified resource name. |
| |
| Args: |
| name: string, The fully qualified resource name of the Project, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</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: |
| |
| { # 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. |
| # <br> |
| # <br>You can create a new `FirebaseProject` in the |
| # [Firebase console](https://console.firebase.google.com/), |
| # or you can add Firebase resources to an existing |
| # [GCP |
| # `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) |
| # by calling |
| # AddFirebase. |
| # <br> |
| # <br>A `FirebaseProject` is actually also a GCP `Project`, so a |
| # `FirebaseProject` uses underlying GCP identifiers (most importantly, |
| # `projectId`) as its own for easy interop with GCP APIs. |
| "name": "A String", # The fully qualified resource name of the Project, in the format: |
| # <br><code>projects/<var>projectId</var></code> |
| "resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project. |
| "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. |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format: |
| # <br><code><var>projectId</var>.appspot.com</code> |
| "hostingSite": "A String", # The default Firebase Hosting site name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| "realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| }, |
| "displayName": "A String", # The user-assigned display name of the Project. |
| "projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project. |
| "projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getAdminSdkConfig">getAdminSdkConfig(name, x__xgafv=None)</code> |
| <pre>Gets the configuration artifact used by servers to simplify initialization. |
| <br> |
| <br>Typically, this configuration is used with the Firebase Admin SDK |
| [initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk) |
| command. |
| |
| Args: |
| name: string, The fully qualified resource name of the Project, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var>/adminSdkConfig</code> (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "databaseURL": "A String", # The default Firebase Realtime Database URL. |
| "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. |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket name. |
| "projectId": "A String", # Immutable. The globally unique, user-assigned project ID of the parent |
| # Project. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getAnalyticsDetails">getAnalyticsDetails(name, x__xgafv=None)</code> |
| <pre>Gets the Google Analytics details currently associated with a |
| FirebaseProject. |
| <br> |
| <br>If the `FirebaseProject` is not yet linked to Google Analytics, then |
| the response to `GetAnalyticsDetails` is NOT_FOUND. |
| |
| Args: |
| name: string, The fully qualified resource name, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var>/analyticsDetails</code> (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "analyticsProperty": { # Details of a Google Analytics property # The Analytics Property object associated with the specified |
| # `FirebaseProject`. |
| # <br> |
| # <br>This object contains the details of the Google Analytics property |
| # associated with the specified `FirebaseProject`. |
| "displayName": "A String", # The display name of the Google Analytics property associated with the |
| # specified `FirebaseProject`. |
| "id": "A String", # The globally unique, Google-assigned identifier of the Google Analytics |
| # property associated with the specified `FirebaseProject`. |
| # <br> |
| # <br>If you called |
| # [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link |
| # your `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`. |
| }, |
| "streamMappings": [ # For Android Apps and iOS Apps: A map of `app` to `streamId` for each |
| # Firebase App in the specified `FirebaseProject`. Each `app` and |
| # `streamId` appears only once.<br> |
| # <br> |
| # For Web Apps: A map of `app` to `streamId` and `measurementId` for each |
| # Firebase App in the specified `FirebaseProject`. Each `app`, `streamId`, |
| # and `measurementId` appears only once. |
| { # A mapping of a Firebase App to a Google Analytics data stream |
| "measurementId": "A String", # Applicable for Firebase Web Apps only.<br> |
| # <br>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. |
| # <br> |
| # <br>Learn more about this ID and Google Analytics web streams in the |
| # [Analytics |
| # documentation](https://support.google.com/analytics/topic/9303475). |
| "streamId": "A String", # The unique Google-assigned identifier of the Google Analytics data stream |
| # associated with the Firebase App. |
| # <br> |
| # <br>Learn more about Google Analytics data streams in the |
| # [Analytics |
| # documentation](https://support.google.com/analytics/answer/9303323). |
| "app": "A String", # The fully qualified resource name of the Firebase App associated with the |
| # Google Analytics data stream, in the format: |
| # <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></code> |
| # or |
| # <code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var></code> |
| # or |
| # <code>projects/<var>PROJECT_NUMBER</var>/webApps/<var>APP_ID</var></code> |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists each FirebaseProject accessible to the caller. |
| <br> |
| <br>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`. |
| <br> |
| <br>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. |
| <br> |
| <br>Use |
| GetFirebaseProject |
| for consistent reads as well as for additional Project details. |
| |
| Args: |
| pageSize: integer, The maximum number of Projects to return in the response. |
| <br> |
| <br>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. |
| <br> |
| <br>This value cannot be negative. |
| pageToken: string, Token returned from a previous call to `ListFirebaseProjects` indicating |
| where in the set of Projects to resume listing. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "results": [ # One page of the list of Projects that are accessible to the caller. |
| { # 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. |
| # <br> |
| # <br>You can create a new `FirebaseProject` in the |
| # [Firebase console](https://console.firebase.google.com/), |
| # or you can add Firebase resources to an existing |
| # [GCP |
| # `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) |
| # by calling |
| # AddFirebase. |
| # <br> |
| # <br>A `FirebaseProject` is actually also a GCP `Project`, so a |
| # `FirebaseProject` uses underlying GCP identifiers (most importantly, |
| # `projectId`) as its own for easy interop with GCP APIs. |
| "name": "A String", # The fully qualified resource name of the Project, in the format: |
| # <br><code>projects/<var>projectId</var></code> |
| "resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project. |
| "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. |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format: |
| # <br><code><var>projectId</var>.appspot.com</code> |
| "hostingSite": "A String", # The default Firebase Hosting site name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| "realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| }, |
| "displayName": "A String", # The user-assigned display name of the Project. |
| "projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project. |
| "projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project. |
| }, |
| ], |
| "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 calls to `ListFirebaseProjects` |
| # to find the next group of Projects. |
| # <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 FirebaseProject identified by the |
| specified resource name. |
| <br> |
| <br>All [query parameters](#query-parameters) are required. |
| |
| Args: |
| name: string, The fully qualified resource name of the Project, in the format: |
| <br><code>projects/<var>projectId</var></code> (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # 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. |
| # <br> |
| # <br>You can create a new `FirebaseProject` in the |
| # [Firebase console](https://console.firebase.google.com/), |
| # or you can add Firebase resources to an existing |
| # [GCP |
| # `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) |
| # by calling |
| # AddFirebase. |
| # <br> |
| # <br>A `FirebaseProject` is actually also a GCP `Project`, so a |
| # `FirebaseProject` uses underlying GCP identifiers (most importantly, |
| # `projectId`) as its own for easy interop with GCP APIs. |
| "name": "A String", # The fully qualified resource name of the Project, in the format: |
| # <br><code>projects/<var>projectId</var></code> |
| "resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project. |
| "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. |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format: |
| # <br><code><var>projectId</var>.appspot.com</code> |
| "hostingSite": "A String", # The default Firebase Hosting site name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| "realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| }, |
| "displayName": "A String", # The user-assigned display name of the Project. |
| "projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project. |
| "projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project. |
| } |
| |
| updateMask: string, Specifies which fields to update. |
| <br> |
| <br>If this list is empty, then no state will be updated. |
| <br>Note that the fields `name`, `project_id`, and `project_number` 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: |
| |
| { # 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. |
| # <br> |
| # <br>You can create a new `FirebaseProject` in the |
| # [Firebase console](https://console.firebase.google.com/), |
| # or you can add Firebase resources to an existing |
| # [GCP |
| # `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects) |
| # by calling |
| # AddFirebase. |
| # <br> |
| # <br>A `FirebaseProject` is actually also a GCP `Project`, so a |
| # `FirebaseProject` uses underlying GCP identifiers (most importantly, |
| # `projectId`) as its own for easy interop with GCP APIs. |
| "name": "A String", # The fully qualified resource name of the Project, in the format: |
| # <br><code>projects/<var>projectId</var></code> |
| "resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project. |
| "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. |
| "storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format: |
| # <br><code><var>projectId</var>.appspot.com</code> |
| "hostingSite": "A String", # The default Firebase Hosting site name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| "realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format: |
| # <br><code><var>projectId</var></code> |
| # <br>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: |
| # <br><code>myproject123-a5c16</code> |
| }, |
| "displayName": "A String", # The user-assigned display name of the Project. |
| "projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project. |
| "projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="removeAnalytics">removeAnalytics(parent, body=None, x__xgafv=None)</code> |
| <pre>Unlinks the specified `FirebaseProject` from its Google Analytics account. |
| <br> |
| <br>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. |
| <br> |
| <br>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 <em>new</em> data stream for each Web |
| App. |
| <br> |
| <br>To call `RemoveAnalytics`, a member must be an Owner for |
| the `FirebaseProject`. |
| |
| Args: |
| parent: string, The parent `FirebaseProject` to unlink from its Google Analytics account, |
| in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var></code> (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "analyticsPropertyId": "A String", # Optional. The ID of the Google Analytics property associated with the |
| # specified `FirebaseProject`. |
| # <ul> |
| # <li>If not set, then the Google Analytics property that is currently |
| # associated with the specified `FirebaseProject` is removed.</li> |
| # <li>If set, and the specified `FirebaseProject` is currently associated |
| # with a <em>different</em> Google Analytics property, then the response is a |
| # `412 Precondition Failed` error.</li> |
| # </ul> |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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 `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchApps">searchApps(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>A convenience method that lists all available Apps for the specified |
| FirebaseProject. |
| <br> |
| <br>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). |
| |
| Args: |
| parent: string, The parent Project for which to list Apps, in the format: |
| <br><code>projects/<var>PROJECT_NUMBER</var></code> (required) |
| 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. |
| <br> |
| <br>This value cannot be negative. |
| pageToken: string, Token returned from a previous call to `SearchFirebaseApps` indicating |
| where in the set of Apps to resume listing. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token |
| # is returned. |
| # <br> |
| # <br>This token can be used in a subsequent calls to `SearchFirebaseApps` |
| # to find the next group of Apps. |
| # <br>If the string is empty, then this response is the last page of results. |
| # <br>Page tokens are short-lived and should not be persisted. |
| "apps": [ # One page of results from a call to `SearchFirebaseApps`. |
| { # A high-level summary of an 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. |
| "platform": "A String", # The platform of the Firebase App. |
| "displayName": "A String", # The user-assigned display name of the Firebase App. |
| "name": "A String", # The fully qualified resource name of the Firebase App, in the format: |
| # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> |
| # or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var> |
| # </code> |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchApps_next">searchApps_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> |
| |
| </body></html> |
