REST Resource: projects

資源：FirebaseProject

FirebaseProject 是頂層 Firebase 實體。這是存放 Firebase 應用程式、Firebase 託管網站、儲存系統 (Firebase 即時資料庫、Cloud Firestore、Cloud Storage 值區) 及其他 Firebase 和 Google Cloud Platform (GCP) 資源的容器。

呼叫 projects.addFirebase 並指定現有的 GCP Project，即可建立 FirebaseProject。這會將 Firebase 資源新增至現有的 GCP Project。

由於 FirebaseProject 實際上也是 GCP Project，因此 FirebaseProject 有相同的基礎 GCP ID (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

僅供輸出。不可變動。使用者指派的專案專屬 ID。

這個 ID 可能會出現在與專案相關聯的部分 Firebase 資源的網址或名稱中，但通常應視為方便參照專案的別名。
projectNumber

string (int64 format)

僅供輸出。不可變動。Google 為專案指定的全域專屬標準 ID。設定整合作業和/或向 Firebase 或第三方服務發出 API 呼叫時，請使用這個 ID。
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 託管網站名稱，格式如下：

PROJECT_ID

雖然很少見，您的 projectId 可能已經是其他專案中現有託管網站的名稱 (進一步瞭解如何建立非預設的其他網站)。在這種情況下，您的 projectId 會加上連字號再加上 5 個英數字元，以便建立預設託管網站名稱。舉例來說，如果 projectId 是 myproject123，預設的代管網站名稱可能是：myproject123-a5c16
realtimeDatabaseInstance

string

僅供輸出。預設的 Firebase 即時資料庫執行個體名稱，格式如下：

PROJECT_ID

雖然很少見，您的 projectId 可能已做為其他專案中現有即時資料庫執行個體的名稱 (進一步瞭解資料庫資料分割)。在這些情況下，您的 projectId 會附加連字號再加上五個英數字元，以便建立預設的即時資料庫執行個體名稱。舉例來說，如果 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

 將 Firebase 資源新增至指定的現有 Google Cloud Platform (GCP) Project。

addGoogleAnalytics

 將指定的 FirebaseProject 連結至現有的 Google Analytics 帳戶。

get

 取得指定的 FirebaseProject。

getAdminSdkConfig

 取得與指定 FirebaseProject 相關聯的設定構件，可供伺服器用來簡化初始化作業。

getAnalyticsDetails

 取得目前與指定 FirebaseProject 相關聯的 Google Analytics 詳細資料。

list

 列出呼叫端可存取的每個 FirebaseProject。

patch

 更新指定 FirebaseProject 的屬性。

removeAnalytics

 將指定的FirebaseProject與 Google Analytics 帳戶取消連結。

searchApps

 列出指定 FirebaseProject 的所有可用應用程式。