Method: projects.defaultLocation.finalize

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

このメソッドは、指定されたlocationIdにあるデフォルトの Cloud Storage バケットを使用して App Engine アプリケーションを作成します。この場所は、利用可能なGCP リソースの場所の 1 つである必要があります。

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

この呼び出しの結果はOperationであり、プロビジョニング プロセスを追跡するために使用できます。 Operationresponseタイプはgoogle.protobuf.Emptyです。

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

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

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

HTTPリクエスト

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

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

デフォルトの GCP リソースの場所が設定されるFirebaseProjectのリソース名。次の形式です。

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER値の詳細については、 FirebaseProject nameフィールドを参照してください。

リクエストボディ

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

JSON表現
{
  "locationId": string
}
田畑
locationId

string

プロジェクトのデフォルトの GCP リソースの場所の ID。この場所は、利用可能なGCP リソースの場所の1 つである必要があります。

レスポンスボディ

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

認可の範囲

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

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

詳細については、 「認証の概要」を参照してください。