REST Resource: projects.webApps

資源:WebApp

Firebase 應用程式網頁版的詳細資料。

JSON 表示法
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
欄位
name

string

WebApp 的資源名稱,格式如下:

projects/PROJECT_IDENTIFIER/webApps/APP_ID

  • PROJECT_IDENTIFIER:父項專案的 ProjectNumber (建議) 或其 ProjectId。進一步瞭解如何在 Google AIP 2510 標準中使用專案 ID。
    請注意,任何回應主體中的 PROJECT_IDENTIFIER 值會是 ProjectId
  • APP_ID:由 Firebase 指派給應用程式的全域專屬 ID (請參閱 appId)。
appId

string

僅供輸出。不可變動。Firebase 指派的全域專屬 WebApp ID。

由於未指定資料格式,因此這個 ID 應視為不透明權杖。

displayName

string

使用者為 WebApp 指派的顯示名稱。

projectId

string

僅供輸出。不可變動。使用者針對 WebApp 的父項 FirebaseProject 指派的專屬 ID。

appUrls[]

string

代管 WebApp 的網址。

webId
(deprecated)

string

僅供輸出。不可變動。Firebase 為 WebApp 指派的專屬 ID。

這個 ID 只會用於填入 WebAppnamespace 值。在大多數情況下,請使用 appId 來識別或參照應用程式。webId 值在 FirebaseProject 及其相關應用程式中是唯一的。

apiKeyId

string

Google 為與 WebApp 相關聯的 Firebase API 金鑰指定的全域專屬 ID (UID)。

請注意,這個值是 API 金鑰的 UID,而「不是」API 金鑰的 keyStringkeyString 是可在應用程式的設定構件中找到的值。

如果未在傳送至 webApps.Create 的要求中設定 apiKeyId,Firebase 就會自動將 apiKeyIdWebApp 建立關聯。這組自動建立關聯的金鑰可能是現有的有效金鑰,如果沒有有效的金鑰,則會佈建新的金鑰。

在修補要求中,apiKeyId 不得設為空白值,且新 UID 沒有限制,或僅設有對相關聯 WebApp 有效的限制。建議您使用 Google Cloud 控制台管理 API 金鑰。

state

enum (State)

僅供輸出。應用程式的生命週期狀態。

etag

string

伺服器會根據其他欄位的值計算這個總和檢查碼,且可能會與更新要求一併傳送,確保用戶端已取得最新的值再繼續。

進一步瞭解 Google 的 AIP-154 標準 etag

這個 eTag 已經過嚴格驗證。

方法

create

要求在指定的 FirebaseProject 中建立新的 WebApp

get

取得指定的 WebApp

getConfig

取得與指定 WebApp 相關聯的設定構件。

list

列出與指定 FirebaseProject 相關聯的每個 WebApp

patch

更新指定 WebApp 的屬性。

remove

FirebaseProject 中移除指定的 WebApp

undelete

將指定的 WebApp 還原至 FirebaseProject