Method: projects.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 locationId. 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 underlying GCP Project already has an App Engine application or defaultLocation.finalize was previously called with a specified locationId. Any new calls to defaultLocation.finalize with a different specified locationId 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 operations.get 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 operations.delete.

All fields listed in the request body are required.

To call defaultLocation.finalize, a member must be an Owner of the Project.

HTTP request

POST https://firebase.googleapis.com/v1beta1/{parent=projects/*}/defaultLocation:finalize

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The resource name of the FirebaseProject for which the default GCP resource location will be set, in the format:

projects/PROJECT_IDENTIFIER

Refer to the FirebaseProject name field for details about PROJECT_IDENTIFIER values.

Request body

The request body contains data with the following structure:

JSON representation
{
  "locationId": string
}
Fields
locationId

string

The ID of the Project's default GCP resource location. The location must be one of the available GCP resource 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.