REST Resource: projects

リソース: FirebaseProject

FirebaseProject は最上位の Firebase エンティティです。Firebase アプリ、Firebase Hosting サイト、ストレージ システム（Firebase Realtime Database、Cloud Firestore、Cloud Storage バケット）、その他の Firebase と Google Cloud Platform（GCP）のリソースのコンテナです。

FirebaseProject を作成するには、projects.addFirebase を呼び出して、既存の GCP Project を指定します。これにより、Firebase リソースが既存の GCP Project に追加されます。

FirebaseProject は実際には GCP Project でもあるため、FirebaseProject の基盤となる GCP 識別子（projectNumber と projectId）は同じです。これにより、Google API との相互運用が容易になります。

JSON 表現 
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
フィールド
name

string

プロジェクトのリソース名。形式:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: プロジェクトのProjectNumber （推奨）または ProjectId。
Google の AIP 2510 規格のプロジェクト ID の使用に関する詳細をご覧ください。
すべてのレスポンス本文の PROJECT_IDENTIFIER の値は ProjectId になるので注意してください。
projectId

string

出力専用。変更不可。ユーザーがプロジェクトに割り当てる一意の識別子。

この識別子は、プロジェクトに関連付けられた一部の Firebase リソースの URL または名前に表示される場合がありますが、通常はプロジェクトを参照するための便宜的なエイリアスとして扱う必要があります。
projectNumber

string (int64 format)

出力専用。変更不可。Google によってプロジェクトに割り当てられたグローバルに一意の正規 ID。この ID は、統合を構成する場合や、Firebase またはサードパーティ サービスへの API 呼び出しを行う場合に使用します。
displayName

string

ユーザーが割り当てたプロジェクトの表示名。
resources

object (DefaultResources)

出力専用。プロジェクトに関連付けられているデフォルトの Firebase リソース。
state

enum (State)

出力専用。プロジェクトのライフサイクルの状態。
annotations

map (key: string, value: string)

FirebaseProject のユーザー定義アノテーションのセット。
Google の AIP-128 規格のアノテーションについての詳細をご覧ください。

これらのアノテーションは、デベロッパーとクライアントサイド ツールのみを対象としています。Firebase サービスは、このアノテーション セットを変更しません。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算され、続行する前にクライアントが最新の値を持っていることを確認するために、更新リクエストとともに送信されることもあります。

Google の AIP-154 規格の etag の詳細をご確認ください。

この ETag は厳格に検証されています。

DefaultResources

プロジェクトに関連付けられたデフォルトのリソース。

JSON 表現 
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
フィールド
hostingSite

string

出力専用。デフォルトの Firebase Hosting サイト名。形式:

PROJECT_ID

まれに、別のプロジェクトの既存の Hosting サイトの名前として projectId がすでに使用されている場合があります（デフォルト以外の追加のサイトの作成について詳細をご確認ください）。このような場合、projectId にハイフン、その後に 5 文字の英数字が付加されて、デフォルトの Hosting サイト名が作成されます。たとえば、projectId が myproject123 の場合、デフォルトの Hosting サイト名は myproject123-a5c16 のようになります。
realtimeDatabaseInstance

string

出力専用。デフォルトの Firebase Realtime Database インスタンス名。形式は次のとおりです。

PROJECT_ID

まれに、別のプロジェクトの既存の Realtime Database インスタンスの名前として projectId がすでに使用されている場合があります（詳しくは、データベース シャーディングをご覧ください）。このような場合、projectId にハイフンの後に英数字 5 文字が付加され、デフォルトの Realtime Database インスタンス名が作成されます。たとえば、projectId が myproject123 の場合、デフォルトのデータベース インスタンス名は myproject123-a5c16 のようになります。
storageBucket

string

出力専用。デフォルトの Cloud Storage for Firebase ストレージ バケット。形式:

PROJECT_ID.appspot.com
locationId

string

出力専用。プロジェクトのデフォルト GCP リソース ロケーションの ID。ロケーションは、使用可能な GCP リソース ロケーションのいずれかです。

デフォルトの GCP リソース ロケーションがまだ確定していない場合、このフィールドは省略されます。プロジェクトのデフォルトの GCP リソース ロケーションを設定するには、Firebase リソースをプロジェクトに追加した後に defaultLocation.finalize を呼び出します。

状態

プロジェクトのライフサイクルの状態。詳しくは、Google の AIP-216 規格をご覧ください。

列挙型
STATE_UNSPECIFIED 未指定の状態
ACTIVE プロジェクトは有効です。
DELETED プロジェクトが削除（復元可能）されました。

メソッド

addFirebase

 指定した既存の Google Cloud Platform（GCP）Project に Firebase リソースを追加します。

addGoogleAnalytics

 指定された FirebaseProject を既存の Google アナリティクス アカウントにリンクします。

get

 指定された FirebaseProject を取得します。

getAdminSdkConfig

 指定された FirebaseProject に関連付けられた構成アーティファクトを取得します。サーバーはこれを使用して初期化を簡素化できます。

getAnalyticsDetails

 指定された FirebaseProject に現在関連付けられている Google アナリティクスの詳細を取得します。

list

 呼び出し元がアクセスできる各 FirebaseProject を一覧表示します。

patch

 指定された FirebaseProject の属性を更新します。

removeAnalytics

 指定されたFirebaseProjectと Google アナリティクス アカウントのリンクを解除します。

searchApps

 指定された FirebaseProject で利用可能なすべてのアプリのリストを取得します。