REST Resource: projects

リソース: Firebaseプロジェクト

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 識別子 ( projectNumberprojectId ) があります。これにより、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 が割り当てたプロジェクトの正規識別子。この識別子は、統合を構成したり、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 は強力に検証されています。

デフォルトリソース

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

JSON表現
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
田畑
hostingSite

string

出力のみ。デフォルトの Firebase Hosting サイト名。形式は次のとおりです。

PROJECT_ID

まれに、 projectIdが別のプロジェクトの既存のホスティング サイトの名前としてすでに使用されている場合があります (デフォルト以外の追加サイトの作成について詳しくは、こちらをご覧ください)。このような場合、 projectIdにハイフン、その後 5 文字の英数字が追加されて、デフォルトのホスティング サイト名が作成されます。たとえば、 projectIdmyproject123の場合、デフォルトのホスティング サイト名はmyproject123-a5c16になります。

realtimeDatabaseInstance

string

出力のみ。デフォルトの Firebase Realtime Database インスタンス名 (形式:)

PROJECT_ID

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

storageBucket

string

出力のみ。デフォルトの Cloud Storage for Firebase ストレージ バケットの形式は次のとおりです。

PROJECT_ID .appspot.com

locationId

string

出力のみ。プロジェクトのデフォルトの GCP リソースの場所の ID。この場所は、利用可能なGCP リソースの場所の 1 つです。

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

プロジェクトの考えられるライフサイクル状態。 Google のAIP-216 標準の状態について詳しくは、こちらをご覧ください。

列挙型
STATE_UNSPECIFIED未指定の状態。
ACTIVEプロジェクトはアクティブです。
DELETEDプロジェクトは論理的に削除されました。

メソッド

addFirebase

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

addGoogleAnalytics

指定されたFirebaseProject既存のGoogle Analytics アカウントにリンクします。

get

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

getAdminSdkConfig

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

getAnalyticsDetails

指定されたFirebaseProjectに現在関連付けられている Google Analytics の詳細を取得します。

list

呼び出し元がアクセスできる各FirebaseProjectをリストします。

patch

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

removeAnalytics

指定されたFirebaseProject Google Analytics アカウントからリンク解除します。

searchApps

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