Method: projects.addFirebase
Stay organized with collections
Save and categorize content based on your preferences.
Adds Firebase resources and enables Firebase services in the specified 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.
The result of this call is an Operation
. Poll the Operation
to track the provisioning process by calling operations.get
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 operations.delete
.
This method does not modify any billing account information on the underlying Google Cloud Project
.
To call projects.addFirebase
, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): firebase.projects.update
, resourcemanager.projects.get
, serviceusage.services.enable
, and serviceusage.services.get
.
HTTP request
POST https://firebase.googleapis.com/v1beta1/{project=projects/*}:addFirebase
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
project |
string
The resource name of the Google Cloud Project in which Firebase resources will be added and Firebase services enabled, in the format:
projects/PROJECT_IDENTIFIER
Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values. After calling projects.addFirebase , the unique Project identifiers ( projectNumber and projectId ) of the underlying Google Cloud Project are also the identifiers of the FirebaseProject .
|
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 available Google App Engine locations.
|
Response body
If successful, the response body contains an instance of Operation
.
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 the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-01 UTC.
[null,null,["Last updated 2024-11-01 UTC."],[],[],null,["Adds Firebase resources and enables Firebase services in the specified existing [Google Cloud `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects).\n\nSince a [FirebaseProject](/docs/reference/firebase-management/rest/v1beta1/projects#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.\n\nThe result of this call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to track the provisioning process by calling `operations.get` until [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, the `Operation` has either succeeded or failed. If the `Operation` succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to a [FirebaseProject](/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject); if the `Operation` failed, its [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a [google.rpc.Status](/docs/reference/firebase-management/rest/v1beta1/operations#Status). The `Operation` is automatically deleted after completion, so there is no need to call `operations.delete`.\n\nThis method does not modify any billing account information on the underlying Google Cloud `Project`.\n\nTo call `projects.addFirebase`, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): `firebase.projects.update`, `resourcemanager.projects.get`, `serviceusage.services.enable`, and `serviceusage.services.get`.\n\nHTTP request\n\n`POST https://firebase.googleapis.com/v1beta1/{project=projects/*}:addFirebase`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\nRequest body\n\nThe request body contains data with the following structure:\n\nResponse body\n\nIf successful, the response body contains an instance of [Operation](/docs/reference/firebase-management/rest/v1beta1/operations#Operation).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/firebase`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]