Google - API Firebase Management

Google / Firebase Management

Firebase Management

The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.

License: Creative Commons Attribution 3.0

Resources

availableProjects

GET

/v1beta1/availableProjects

Returns a list of [Google Cloud Platform (GCP) Projects] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that are available to have Firebase resources added to them.

A GCP Project will only be returned if:

The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.
The GCP `Project` is not already a FirebaseProject.
The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.

Request

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListAvailableProjects` indicating where in the set of GCP `Projects` to resume listing.
`pageSize`	integer	The maximum number of GCP `Projects` 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), the server will impose its own limit. This value cannot be negative.

Responses

200Successful response

Body

Name	Data Type	Description
`ListAvailableProjectsResponse`	object

Properties


                        projectInfo

array [ProjectInfo]

The list of GCP Projects which can have Firebase resources added to them.


                        ProjectInfo

object

A reference to a Google Cloud Platform (GCP) Project.

Properties

`project`	string	The resource name of the GCP `Project` to which Firebase resources can be added, in the format: `projects/projectId`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. Not all projects will have this field populated. If it is not populated, it means that the project does not yet have a default GCP resource location. To set your project's default GCP resource location, call `FinalizeDefaultLocation` after you add Firebase resources to your project.
`displayName`	string	The user-assigned display name of the GCP `Project`, for example: `My App`


                        nextPageToken

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.

This token can be used in a subsequent calls to ListAvailableProjects to find the next group of GCP Projects.

Page tokens are short-lived and should not be persisted.

operations

GET

/v1beta1/{name}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource.

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object

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.


                        name

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}.


                        metadata

object

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.


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

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. 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.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

projects

GET

/v1beta1/projects

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.

Request

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.
`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.

Responses

200Successful response

Body

Name	Data Type	Description
`ListFirebaseProjectsResponse`	object

Properties


                        results

array [FirebaseProject]

One page of the list of Projects that are accessible to the caller.


                        FirebaseProject

object

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 can create a new FirebaseProject in the Firebase console, or you can add Firebase resources to an existing GCP Project by calling AddFirebase.

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.

Properties


                        resources

DefaultResources

The default Firebase resources associated with the Project.


                        DefaultResources

object

The default resources associated with a FirebaseProject.

Properties

`storageBucket`	string	The default Cloud Storage for Firebase storage bucket, in the format: `projectId.appspot.com`
`realtimeDatabaseInstance`	string	The default Firebase Realtime Database instance name, in the format: `projectId` 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). 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`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. 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` after you add Firebase services to your project.
`hostingSite`	string	The default Firebase Hosting site name, in the format: `projectId` 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). 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`


                        projectNumber

string

The globally unique, Google-assigned identifier of the Project.


                        projectId

string

Immutable. The globally unique, user-assigned ID of the Project.


                        name

string

The fully qualified resource name of the Project, in the format:
projects/projectId


                        displayName

string

The user-assigned display name of the Project.


                        nextPageToken

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.

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.

DELETE

/v1beta1/{name}

Removes a SHA certificate from the specified AndroidApp.

Request

Path

Name	Data Type	Description
`name`	string	The fully qualified resource name of the `sha-key`, in the format: `projects/projectId/androidApps/appId/sha/shaId` You can obtain the full name from the response of `ListShaCertificates` or the original `CreateShaCertificate`.

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Responses

200Successful response

Body

Name	Data Type	Description
`Empty`	object	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 `{}`.

PATCH

/v1beta1/{name}

Updates the attributes of the IosApp identified by the specified resource name.

Request

Path

Name	Data Type	Description
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`updateMask`	string	Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.

Body

Name	Data Type	Description
`IosApp`	object	Details of a Firebase App for iOS.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

Responses

200Successful response

Body

Name	Data Type	Description
`IosApp`	object	Details of a Firebase App for iOS.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

GET

/v1beta1/{parent}/androidApps

Lists each AndroidApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListAndroidApps` indicating where in the set of Apps to resume listing.
`pageSize`	integer	The maximum number of Apps 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), then the server will impose its own limit.

Responses

200Successful response

Body

Name	Data Type	Description
`ListAndroidAppsResponse`	object

Properties


                        nextPageToken

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.

This token can be used in a subsequent call to ListAndroidApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [AndroidApp]

List of each AndroidApp that is in the parent Firebase Project.


                        AndroidApp

object

Details of a Firebase App for Android.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`packageName`	string	The canonical package name of the Android App as would appear in the Google Play Developer Console.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/androidApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

POST

/v1beta1/{parent}/androidApps

Requests that a new AndroidApp be created.

The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`AndroidApp`	object	Details of a Firebase App for Android.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`packageName`	string	The canonical package name of the Android App as would appear in the Google Play Developer Console.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/androidApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

GET

/v1beta1/{parent}/availableLocations

Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

The default GCP resource location of a project defines the geographical location where project resources, such as Cloud Firestore, will be provisioned by default.

The returned list are the available GCP resource locations.

This call checks for any location restrictions for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a projectId (that is, /v1beta1/{parent=projects/-}/listAvailableLocations).

To call ListAvailableLocations with a specified project, a member must be at minimum a Viewer of the project. Calls without a specified project do not require any specific project permissions.

Request

Path

Name	Data Type	Description
`parent`	string	The Project for which to list GCP resource locations, in the format: `projects/projectId` If no project is specified (that is, `projects/-`), the returned list does not take into account org-specific or project-specific location restrictions.

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListAvailableLocations` indicating where in the list of locations to resume listing.
`pageSize`	integer	The maximum number of locations 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.

Responses

200Successful response

Body

Name	Data Type	Description
`ListAvailableLocationsResponse`	object

Properties


                        nextPageToken

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 and all available locations have been listed.

This token can be used in a subsequent call to ListAvailableLocations to find more locations.

Page tokens are short-lived and should not be persisted.


                        locations

array [Location]

One page of results from a call to ListAvailableLocations.


                        Location

object

A GCP resource location that can be selected for a Project.

Properties


                        locationId

string

The ID of the default GCP resource location. It must be one of the available GCP resource locations.

POST

/v1beta1/{parent}/defaultLocation:finalize

Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.

This method creates an App Engine application with a default Cloud Storage bucket, located in the specified location_id. This location must be one of the available GCP resource locations.

After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the GCP Project already has an App Engine application or FinalizeDefaultLocation was previously called with a specified location_id. Any new calls to FinalizeDefaultLocation with a different specified location_id will return a 409 error.

The result of this call is an Operation, which can be used to track the provisioning process. The response type of the Operation is google.protobuf.Empty.

The Operation can be polled by its name using GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation has succeeded, its response will be set to a google.protobuf.Empty; if the Operation has failed, its error will be set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

All fields listed in the request body are required.

To call FinalizeDefaultLocation, a member must be an Owner of the project.

Request

Path

Name	Data Type	Description
`parent`	string	The resource name of the Project for which the default GCP resource location will be set, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`FinalizeDefaultLocationRequest`	object

Properties


                        locationId

string

The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

GET

/v1beta1/{parent}/iosApps

Lists each IosApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.
`pageSize`	integer	The maximum number of Apps 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.

Responses

200Successful response

Body

Name	Data Type	Description
`ListIosAppsResponse`	object

Properties


                        nextPageToken

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.

This token can be used in a subsequent call to ListIosApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [IosApp]

List of each IosApp that is in the parent Firebase Project.


                        IosApp

object

Details of a Firebase App for iOS.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

POST

/v1beta1/{parent}/iosApps

Requests that a new IosApp be created.

The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`IosApp`	object	Details of a Firebase App for iOS.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

GET

/v1beta1/{parent}/sha

Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.

Request

Path

Name	Data Type	Description
`parent`	string	The parent App for which to list SHA certificates, in the format: `projects/projectId/androidApps/appId` As an `appId` is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: `projects/-/androidApps/appId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Responses

200Successful response

Body

Name	Data Type	Description
`ListShaCertificatesResponse`	object

Properties


                        certificates

array [ShaCertificate]

The list of SHA certificates associated with the App.


                        ShaCertificate

object

A SHA-1 or SHA-256 certificate associated with the AndroidApp.

Properties

`shaHash`	string	The certificate hash for the App.
`name`	string	The fully qualified resource name of the `sha-key`, in the format: `projects/projectId/androidApps/appId/sha/shaId`
`certType`	string Allowed values: - `SHA_CERTIFICATE_TYPE_UNSPECIFIED` - `SHA_1` - `SHA_256`	The SHA certificate type.

POST

/v1beta1/{parent}/sha

Adds a SHA certificate to the specified AndroidApp.

Request

Path

Name	Data Type	Description
`parent`	string	The parent App to which a SHA certificate will be added, in the format: `projects/projectId/androidApps/appId` As an `appId` is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: `projects/-/androidApps/appId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`ShaCertificate`	object	A SHA-1 or SHA-256 certificate associated with the AndroidApp.

Properties

`shaHash`	string	The certificate hash for the App.
`name`	string	The fully qualified resource name of the `sha-key`, in the format: `projects/projectId/androidApps/appId/sha/shaId`
`certType`	string Allowed values: - `SHA_CERTIFICATE_TYPE_UNSPECIFIED` - `SHA_1` - `SHA_256`	The SHA certificate type.

Responses

200Successful response

Body

Name	Data Type	Description
`ShaCertificate`	object	A SHA-1 or SHA-256 certificate associated with the AndroidApp.

Properties

`shaHash`	string	The certificate hash for the App.
`name`	string	The fully qualified resource name of the `sha-key`, in the format: `projects/projectId/androidApps/appId/sha/shaId`
`certType`	string Allowed values: - `SHA_CERTIFICATE_TYPE_UNSPECIFIED` - `SHA_1` - `SHA_256`	The SHA certificate type.

GET

/v1beta1/{parent}/webApps

Lists each WebApp associated with the specified parent Project.

The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `ListWebApps` indicating where in the set of Apps to resume listing.
`pageSize`	integer	The maximum number of Apps to return in the response. 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.

Responses

200Successful response

Body

Name	Data Type	Description
`ListWebAppsResponse`	object

Properties


                        nextPageToken

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.

This token can be used in a subsequent call to ListWebApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [WebApp]

List of each WebApp that is in the parent Firebase Project.


                        WebApp

object

Details of a Firebase App for the web.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, for example: `projects/projectId/webApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appUrls`	array [string]	The fully qualified URLs where the App is hosted.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

POST

/v1beta1/{parent}/webApps

Requests that a new WebApp be created.

The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`WebApp`	object	Details of a Firebase App for the web.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, for example: `projects/projectId/webApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appUrls`	array [string]	The fully qualified URLs where the App is hosted.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

POST

/v1beta1/{parent}:addGoogleAnalytics

Links a FirebaseProject with an existing Google Analytics account.

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 your `FirebaseProject`.
Specify an existing `analyticsPropertyId` to associate the property with your `FirebaseProject`.

Note that when you call AddGoogleAnalytics:

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.
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.

Learn more about the hierarchy and structure of Google Analytics accounts in the Analytics documentation.

The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to an AnalyticsDetails; if the Operation failed, its error is set to a google.rpc.Status.

To call AddGoogleAnalytics, a member must be an Owner for the existing FirebaseProject and have the Edit permission for the Google Analytics account.

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.

Request

Path

Name	Data Type	Description
`parent`	string	The parent `FirebaseProject` to link to an existing Google Analytics account, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`AddGoogleAnalyticsRequest`	object

Properties

`analyticsPropertyId`	string	The ID for the existing Google Analytics property that you want to associate with your `FirebaseProject`.
`analyticsAccountId`	string	The ID for the existing Google Analytics account that you want to link with your `FirebaseProject`. Specifying this field will provision a new Google Analytics property in your Google Analytics account and associate the new property with your `FirebaseProject`.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

POST

/v1beta1/{parent}:removeAnalytics

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 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 member must be an Owner for the FirebaseProject.

Request

Path

Name	Data Type	Description
`parent`	string	The parent `FirebaseProject` to unlink from its Google Analytics account, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`RemoveAnalyticsRequest`	object

Properties


                        analyticsPropertyId

string

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.

Responses

200Successful response

Body

Name	Data Type	Description
`Empty`	object	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 `{}`.

GET

/v1beta1/{parent}:searchApps

A convenience method that lists all available Apps for the specified FirebaseProject.

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).

Request

Path

Name	Data Type	Description
`parent`	string	The parent Project for which to list Apps, in the format: `projects/projectId`

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.
`pageToken`	string	Token returned from a previous call to `SearchFirebaseApps` indicating where in the set of Apps to resume listing.
`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.

Responses

200Successful response

Body

Name	Data Type	Description
`SearchFirebaseAppsResponse`	object

Properties


                        nextPageToken

string

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.
If the string is empty, then this response is the last page of results.
Page tokens are short-lived and should not be persisted.


                        apps

array [FirebaseAppInfo]

One page of results from a call to SearchFirebaseApps.


                        FirebaseAppInfo

object

A high-level summary of an App.

Properties

`platform`	string Allowed values: - `PLATFORM_UNSPECIFIED` - `IOS` - `ANDROID` - `WEB`	The platform of the Firebase App.
`name`	string	The fully qualified resource name of the Firebase App, in the format: `projects/projectId/iosApps/appId` or `projects/projectId/androidApps/appId`
`displayName`	string	The user-assigned display name of the Firebase App.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

POST

/v1beta1/{project}:addFirebase

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 uses underlying GCP identifiers (most importantly, the projectId) as its own for easy interop with GCP APIs.

The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to a FirebaseProject; if the Operation failed, its 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 member must be an Editor or Owner for the existing GCP Project. Service accounts cannot call AddFirebase.

Request

Path

Name	Data Type	Description
`project`	string	The resource name of the GCP `Project` to which Firebase resources will be added, in the format: `projects/projectId` After calling `AddFirebase`, the `projectId` of the GCP `Project` is also the `projectId` of the FirebaseProject.

Query

Name	Data Type	Description
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`prettyPrint`	boolean Default value: `true`	Returns response with indentations and line breaks.
`oauth_token`	string	OAuth 2.0 token for the current user.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`fields`	string	Selector specifying which fields to include in a partial response.
`callback`	string	JSONP
`alt`	string Default value: `json` Allowed values: - `json` - `media` - `proto`	Data format for response.
`access_token`	string	OAuth access token.
`$.xgafv`	string Allowed values: - `1` - `2`	V1 error format.

Body

Name	Data Type	Description
`AddFirebaseRequest`	object	All fields are required.

Properties

`timeZone`	string	Deprecated. Instead, to link your Project with a Google Analytics account, call `AddGoogleAnalytics` after you add Firebase resources to your Project. The time zone that the account will use for Firebase Analytics data. For example: America/Los_Angeles or Africa/Abidjan
`regionCode`	string	Deprecated. Instead, to link your Project with a Google Analytics account, call `AddGoogleAnalytics` after you add Firebase resources to your Project. The region code (CLDR) that the account will use for Firebase Analytics data. For example: US, GB, or DE In Java, use `com.google.i18n.identifiers.RegionCode`.
`locationId`	string	Deprecated. Instead, to set your project's default GCP resource location, call `FinalizeDefaultLocation` after you add Firebase resources to your project. The ID of the project's default GCP resource location. The location must be one of the available GCP resource locations.

Responses

200Successful response

Body

Name	Data Type	Description
`Operation`	object	This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

Models

AddFirebaseRequest

AddGoogleAnalyticsRequest

AdminSdkConfig

AnalyticsDetails

Properties

Name Data Type Description


                        streamMappings

array [StreamMapping]

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.

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.


                        StreamMapping

object

A mapping of a Firebase App to a Google Analytics data stream

Properties

`streamId`	string	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.
`measurementId`	string	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.
`app`	string	The fully qualified resource name of the Firebase App associated with the Google Analytics data stream, in the format: `projects/projectId/androidApps/appId` or `projects/projectId/iosApps/appId` or `projects/projectId/webApps/appId`


                        analyticsProperty

AnalyticsProperty

The Analytics Property object associated with the specified FirebaseProject.

This object contains the details of the Google Analytics property associated with the specified FirebaseProject.


                        AnalyticsProperty

object

Details of a Google Analytics property

Properties

`id`	string	The globally unique, Google-assigned identifier of the Google Analytics property associated with the specified `FirebaseProject`. If you called `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`.
`displayName`	string	The display name of the Google Analytics property associated with the specified `FirebaseProject`.

AnalyticsProperty

AndroidApp

AndroidAppConfig

DefaultResources

The default resources associated with a FirebaseProject.

Properties

Name	Data Type	Description
`storageBucket`	string	The default Cloud Storage for Firebase storage bucket, in the format: `projectId.appspot.com`
`realtimeDatabaseInstance`	string	The default Firebase Realtime Database instance name, in the format: `projectId` 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). 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`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. 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` after you add Firebase services to your project.
`hostingSite`	string	The default Firebase Hosting site name, in the format: `projectId` 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). 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`

Empty

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 {}.

Name	Data Type	Description
`Empty`	object	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 `{}`.

FinalizeDefaultLocationRequest

FirebaseAppInfo

FirebaseProject

Properties

Name Data Type Description


                        resources

DefaultResources

The default Firebase resources associated with the Project.


                        DefaultResources

object

The default resources associated with a FirebaseProject.

Properties

`storageBucket`	string	The default Cloud Storage for Firebase storage bucket, in the format: `projectId.appspot.com`
`realtimeDatabaseInstance`	string	The default Firebase Realtime Database instance name, in the format: `projectId` 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). 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`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. 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` after you add Firebase services to your project.
`hostingSite`	string	The default Firebase Hosting site name, in the format: `projectId` 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). 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`


                        projectNumber

string

The globally unique, Google-assigned identifier of the Project.


                        projectId

string

Immutable. The globally unique, user-assigned ID of the Project.


                        name

string

The fully qualified resource name of the Project, in the format:
projects/projectId


                        displayName

string

The user-assigned display name of the Project.

IosApp

Details of a Firebase App for iOS.

Properties

Name	Data Type	Description
`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

IosAppConfig

ListAndroidAppsResponse

Properties

Name Data Type Description


                        nextPageToken

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.

This token can be used in a subsequent call to ListAndroidApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [AndroidApp]

List of each AndroidApp that is in the parent Firebase Project.


                        AndroidApp

object

Details of a Firebase App for Android.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`packageName`	string	The canonical package name of the Android App as would appear in the Google Play Developer Console.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/androidApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

ListAvailableLocationsResponse

ListAvailableProjectsResponse

Properties

Name Data Type Description


                        projectInfo

array [ProjectInfo]

The list of GCP Projects which can have Firebase resources added to them.


                        ProjectInfo

object

A reference to a Google Cloud Platform (GCP) Project.

Properties

`project`	string	The resource name of the GCP `Project` to which Firebase resources can be added, in the format: `projects/projectId`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. Not all projects will have this field populated. If it is not populated, it means that the project does not yet have a default GCP resource location. To set your project's default GCP resource location, call `FinalizeDefaultLocation` after you add Firebase resources to your project.
`displayName`	string	The user-assigned display name of the GCP `Project`, for example: `My App`


                        nextPageToken

string

ListFirebaseProjectsResponse

Properties

Name Data Type Description


                        results

array [FirebaseProject]

One page of the list of Projects that are accessible to the caller.


                        FirebaseProject

object

Properties


                        resources

DefaultResources

The default Firebase resources associated with the Project.


                        DefaultResources

object

The default resources associated with a FirebaseProject.

Properties

`storageBucket`	string	The default Cloud Storage for Firebase storage bucket, in the format: `projectId.appspot.com`
`realtimeDatabaseInstance`	string	The default Firebase Realtime Database instance name, in the format: `projectId` 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). 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`
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. 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` after you add Firebase services to your project.
`hostingSite`	string	The default Firebase Hosting site name, in the format: `projectId` 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). 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`


                        projectNumber

string

The globally unique, Google-assigned identifier of the Project.


                        projectId

string

Immutable. The globally unique, user-assigned ID of the Project.


                        name

string

The fully qualified resource name of the Project, in the format:
projects/projectId


                        displayName

string

The user-assigned display name of the Project.


                        nextPageToken

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.

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.

ListIosAppsResponse

Properties

Name Data Type Description


                        nextPageToken

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.

This token can be used in a subsequent call to ListIosApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [IosApp]

List of each IosApp that is in the parent Firebase Project.


                        IosApp

object

Details of a Firebase App for iOS.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, in the format: `projects/projectId/iosApps/appId`
`displayName`	string	The user-assigned display name of the App.
`bundleId`	string	The canonical bundle ID of the iOS App as it would appear in the iOS AppStore.
`appStoreId`	string	The automatically generated Apple ID assigned to the App by Apple in the iOS App Store.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

ListShaCertificatesResponse

ListWebAppsResponse

Properties

Name Data Type Description


                        nextPageToken

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.

This token can be used in a subsequent call to ListWebApps to find the next group of Apps.

Page tokens are short-lived and should not be persisted.


                        apps

array [WebApp]

List of each WebApp that is in the parent Firebase Project.


                        WebApp

object

Details of a Firebase App for the web.

Properties

`projectId`	string	The globally unique, user-assigned ID of the parent Project for the App.
`name`	string	The fully qualified resource name of the App, for example: `projects/projectId/webApps/appId`
`displayName`	string	The user-assigned display name of the App.
`appUrls`	array [string]	The fully qualified URLs where the App is hosted.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

Location

MessageSet

Operation

This resource represents a long-running operation that is the result of a network API call.

Properties

Name Data Type Description


                        response

object


                        name

string


                        metadata

object


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	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`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

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.

ProjectInfo

RemoveAnalyticsRequest

SearchFirebaseAppsResponse

Properties

Name Data Type Description


                        nextPageToken

string


                        apps

array [FirebaseAppInfo]

One page of results from a call to SearchFirebaseApps.


                        FirebaseAppInfo

object

A high-level summary of an App.

Properties

`platform`	string Allowed values: - `PLATFORM_UNSPECIFIED` - `IOS` - `ANDROID` - `WEB`	The platform of the Firebase App.
`name`	string	The fully qualified resource name of the Firebase App, in the format: `projects/projectId/iosApps/appId` or `projects/projectId/androidApps/appId`
`displayName`	string	The user-assigned display name of the Firebase App.
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.

ShaCertificate

Status

StatusProto

Wire-format for a Status object

Properties

Name Data Type Description


                        space

string

The following are usually only present when code != 0 Space to which this status belongs


                        payload

TypedMessage

DEPRECATED.

This field was deprecated in 2011 with cl/20297133. Java support for the field was moved to a proto1 backward compatibility class in April 2017 with cl/142615857 and cl/154123203. There was never support for this field in Go; if set Go will ignore it. C++ stopped setting StatusProto::payload in October 2015 with cl/106347055, and stopped reading the field in October 2017 with cl/173324114.

In general, newly written code should use only "message_set". If you need to maintain backward compatibility with code written before 3/25/2011, do the following:

During the transition period, either (1) set both "payload" and "message_set", or (2) write the consumer of StatusProto so that it can forge a MessageSet object from "payload" if "message_set" is missing. The C++ util::Status implementation does (2).
Once all the consumers are converted to accept "message_set", then remove the use of "payload" on the producer side.


                        TypedMessage

object

Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set.

To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message());

To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message());

Properties

`typeId`	integer	Identifier for the type.
`message`	byte	Message bytes.


                        messageSet

MessageSet

message_set associates an arbitrary proto message with the status.


                        MessageSet

object

This is proto2's version of MessageSet.


                        message

string

Detail message


                        code

integer

Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto


                        canonicalCode

integer

The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing.

StreamMapping

TypedMessage

WebApp

WebAppConfig

Configuration metadata of a single Firebase App for the web.

Properties

Name	Data Type	Description
`storageBucket`	string	The default Cloud Storage for Firebase storage bucket name.
`projectId`	string	Immutable. The globally unique, user-assigned project ID of the parent Project for the App.
`messagingSenderId`	string	The sender ID for use with Firebase Cloud Messaging.
`measurementId`	string	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. This field is only present if the App is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the Analytics documentation. To generate a `measurementId` and link the Web App with a Google Analytics web stream, call `AddGoogleAnalytics`.
`locationId`	string	The ID of the project's default GCP resource location. The location is one of the available GCP resource locations. 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` after you add Firebase services to your project.
`databaseURL`	string	The default Firebase Realtime Database URL.
`authDomain`	string	The domain Firebase Auth configures for OAuth redirects, in the format: `projectId.firebaseapp.com`
`appId`	string	Immutable. The globally unique, Firebase-assigned identifier of the App.
`apiKey`	string	The API key associated with the web App.

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/firebase: View and administer all your Firebase data and settings
https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
https://www.googleapis.com/auth/firebase.readonly: View all your Firebase data and settings
https://www.googleapis.com/auth/cloud-platform.read-only: View your data across Google Cloud Platform services

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/firebase: View and administer all your Firebase data and settings
https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
https://www.googleapis.com/auth/firebase.readonly: View all your Firebase data and settings
https://www.googleapis.com/auth/cloud-platform.read-only: View your data across Google Cloud Platform services

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

Api Client Registration	`https://console.developers.google.com`
Preferred	`Yes`
Provider Name	`googleapis.com`
Service Name	`firebase`
API Version	`v1beta1`

Comments

Loading comments ...