REST Resource: projects

Resource: FirebaseProject

AFirebaseProject 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 aFirebaseProject by callingprojects.addFirebase and specifying anexistingGoogle CloudProject. This adds Firebase resources to the existing Google CloudProject.

Since aFirebaseProject is actually also a Google CloudProject, aFirebaseProject has the same underlying Google Cloud identifiers (projectNumber andprojectId). 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'sProjectNumber(recommended) or itsProjectId.
Learn more about using project identifiers in Google'sAIP 2510 standard.
Note that the value forPROJECT_IDENTIFIER in any response body will be theProjectId.

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 theFirebaseProject.
Learn more about annotations in Google'sAIP-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 aboutetag in Google'sAIP-154 standard.

This etag is strongly validated.

State

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

Enums
STATE_UNSPECIFIEDUnspecified state.
ACTIVEThe Project is active.
DELETEDThe Project has been soft-deleted.

Methods

addFirebase

 Adds Firebase resources and enables Firebase services in the specified existingGoogle CloudProject.

addGoogleAnalytics

 Links the specifiedFirebaseProject with an existingGoogle Analytics account.

get

 Gets the specifiedFirebaseProject.

getAdminSdkConfig

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

getAnalyticsDetails

 Gets the Google Analytics details currently associated with the specifiedFirebaseProject.

list

 Lists eachFirebaseProject accessible to the caller.

patch

 Updates the attributes of the specifiedFirebaseProject.

removeAnalytics

 Unlinks the specifiedFirebaseProject from its Google Analytics account.

searchApps

 Lists all available Apps for the specifiedFirebaseProject.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-11-01 UTC.