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 によってアプリに割り当てられたグローバルに一意の識別子（appId を参照）。
appId

string

出力専用。変更不可。Firebase によって割り当てられた WebApp のグローバルに一意の識別子。

この識別子はデータ形式が指定されておらず、不透明トークンとして扱う必要があります。
displayName

string

ユーザーが割り当てた WebApp の表示名。
projectId

string

出力専用。変更不可。WebApp の親 FirebaseProject にユーザーが割り当てた一意の識別子。
appUrls[]

string

WebApp がホストされている URL。
webId
(deprecated)

string

出力専用。変更不可。Firebase によって割り当てられた WebApp の一意の識別子。

この識別子は、WebApp の namespace 値を入力する目的でのみ使用されます。ほとんどのユースケースでは、appId を使用してアプリの識別または参照を行います。webId の値は、FirebaseProject とそれに関連付けられたアプリ内でのみ一意です。
apiKeyId

string

WebApp に関連付けられた Firebase API キーに Google が割り当てた、グローバルに一意の識別子（UID）。

この値は API キーの UID であり、API キーの keyString ではないことに注意してください。keyString は、アプリの構成アーティファクトにある値です。

webApps.Create へのリクエストで apiKeyId が設定されていない場合、Firebase は自動的に apiKeyId を WebApp に関連付けます。この自動関連付けられたキーは、既存の有効なキーである可能性があります。有効なキーが存在しない場合は、新しいキーがプロビジョニングされます。

パッチ リクエストでは、apiKeyId を空の値に設定することはできません。新しい UID に制限を設けないか、関連付けられた WebApp に対して有効な制限のみを設定する必要があります。API キーの管理には、Google Cloud コンソールを使用することをおすすめします。
state

enum (State)

出力専用。アプリのライフサイクルの状態。
etag

string

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

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

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

メソッド

create

 指定された FirebaseProject に新しい WebApp の作成をリクエストします。

get

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

getConfig

 指定された WebApp に関連付けられた構成アーティファクトを取得します。

list

 指定された FirebaseProject に関連付けられている各 WebApp を一覧表示します。

patch

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

remove

 指定された WebApp を FirebaseProject から削除します。

undelete

 指定された WebApp を FirebaseProject に復元します。