REST Resource: projects

資源:Firebase項目

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 識別碼( 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 標準中的項目識別碼。
請注意,任何回應正文中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 託管網站名稱,格式為:

PROJECT_ID

雖然很少見,但您的projectId可能已被用作另一個專案中現有託管網站的名稱(以了解有關建立非預設附加網站的更多資訊)。在這些情況下,您的projectId會附加一個連字符,然後是五個字母數字字符,以建立您的預設託管網站名稱。例如,如果您的projectIdmyproject123 ,則您的預設託管網站名稱可能是: myproject123-a5c16

realtimeDatabaseInstance

string

僅輸出。預設 Firebase 即時資料庫實例名稱,格式為:

PROJECT_ID

儘管很少見,但您的projectId可能已用作另一個專案中現有即時資料庫實例的名稱(以了解有關資料庫分片的更多資訊)。在這些情況下,您的projectId會附加一個連字符,然後是五個字母數字字符,以建立預設的即時資料庫實例名稱。例如,如果您的projectIdmyproject123 ,則您的預設資料庫執行個體名稱可能是: 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的所有可用應用程式。