Method: projects.defaultLocation.finalize

指定された FirebaseProject のデフォルトの Google Cloud Platform(GCP)リソース ロケーションを設定します。

この方法では、指定された locationIdデフォルトの Cloud Storage バケットを使用して App Engine アプリケーションを作成します。このロケーションは、使用可能な GCP リソース ロケーションのいずれかである必要があります。

デフォルトの GCP リソース ロケーションが確定した後、またはすでに設定されている場合は、変更できません。指定した FirebaseProject のデフォルトの GCP リソース ロケーションがすでに設定されている可能性があります。これは、基盤となる GCP Project に App Engine アプリケーションがすでに存在するか、以前に指定された locationIddefaultLocation.finalize が呼び出されたためです。別の locationId を指定して defaultLocation.finalize を新たに呼び出すと、409 エラーが返されます。

この呼び出しの結果は Operation で、これを使用してプロビジョニング プロセスを追跡できます。Operationresponse 型は google.protobuf.Empty です。

done が true になるまで、operations.get を使用して name によって Operation をポーリングできます。done が true の場合、Operation は成功したか失敗したかを示します。Operation が成功した場合、responsegoogle.protobuf.Empty に設定されます。Operation が失敗した場合、errorgoogle.rpc.Status に設定されます。Operation は完了後に自動的に削除されるため、operations.delete を呼び出す必要はありません。

リクエストの本文に示されているフィールドはすべて必須です。

defaultLocation.finalize を呼び出すには、メンバーはプロジェクトのオーナーである必要があります。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

デフォルトの GCP リソース ロケーションが設定される FirebaseProject のリソース名。次の形式で指定します。

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER 値の詳細については、FirebaseProjectname フィールドをご覧ください。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "locationId": string
}
フィールド
locationId

string

プロジェクトのデフォルト GCP リソース ロケーションの ID。ロケーションは、使用可能な GCP リソース ロケーションのいずれかである必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。