REST Resource: projects

Resource: FirebaseProject

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

You create a FirebaseProject by calling projects.addFirebase and specifying an existing Google Cloud Project. This adds Firebase resources to the existing Google Cloud Project.

Since a FirebaseProject is actually also a Google Cloud Project, a FirebaseProject has the same underlying Google Cloud identifiers (projectNumber and projectId). This allows for easy interop with Google APIs.

JSON representation 
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Fields
name

string

The resource name of the Project, in the format:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: the Project's ProjectNumber (recommended) or its ProjectId.
Learn more about using project identifiers in Google's AIP 2510 standard.
Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId.
projectId

string

Output only. Immutable. A user-assigned unique identifier for the Project.

This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
projectNumber

string (int64 format)

Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
displayName

string

The user-assigned display name of the Project.
state

enum (State)

Output only. The lifecycle state of the Project.
annotations

map (key: string, value: string)

A set of user-defined annotations for the FirebaseProject.
Learn more about annotations in Google's AIP-128 standard.

These annotations are intended solely for developers and client-side tools. Firebase services will not mutate this annotations set.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
etag

string

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding.

Learn more about etag in Google's AIP-154 standard.

This etag is strongly validated.

State

The possible lifecycle states of the Project. Learn more about states in Google's AIP-216 standard.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE The Project is active.
DELETED The Project has been soft-deleted.

Methods

addFirebase

 Adds Firebase resources and enables Firebase services in the specified existing Google Cloud Project.

addGoogleAnalytics

 Links the specified FirebaseProject with an existing Google Analytics account.

get

 Gets the specified FirebaseProject.

getAdminSdkConfig

 Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization.

getAnalyticsDetails

 Gets the Google Analytics details currently associated with the specified FirebaseProject.

list

 Lists each FirebaseProject accessible to the caller.

patch

 Updates the attributes of the specified FirebaseProject.

removeAnalytics

 Unlinks the specified FirebaseProject from its Google Analytics account.

searchApps

 Lists all available Apps for the specified FirebaseProject.