Method: projects.addFirebase

Adds Firebase resources and enables Firebase services in the specified existingGoogle 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.

The result of this call is anOperation. Poll theOperation to track the provisioning process by callingoperations.get untildone istrue. Whendone istrue, theOperation has either succeeded or failed. If theOperation succeeded, itsresponse is set to aFirebaseProject; if theOperation failed, itserror is set to agoogle.rpc.Status. TheOperation is automatically deleted after completion, so there is no need to calloperations.delete.

This method does not modify any billing account information on the underlying Google CloudProject.

To callprojects.addFirebase, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions):firebase.projects.update,resourcemanager.projects.get,serviceusage.services.enable, andserviceusage.services.get.

HTTP request

POST https://firebase.googleapis.com/v1beta1/{project=projects/*}:addFirebase

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
project

string

The resource name of the Google CloudProject in which Firebase resources will be added and Firebase services enabled, in the format:

projects/PROJECT_IDENTIFIER

Refer to theFirebaseProjectname field for details aboutPROJECT_IDENTIFIER values.

After callingprojects.addFirebase, the unique Project identifiers (projectNumber andprojectId) of the underlying Google CloudProject are also the identifiers of theFirebaseProject.

Request body

The request body contains data with the following structure:

JSON representation
{"locationId":string}
Fields
locationId

string

DEPRECATED.Instead, use product-specific REST APIs to work with the location of each resource in a Project. This field may be ignored, especially for newly provisioned projects after October 30, 2024.

The ID of the Project's"location for default Google Cloud resources", which are resources associated with Google App Engine. The location must be one of the availableGoogle App Engine locations.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

For more information, see theAuthentication Overview.

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.