REST Resource: projects.webApps

リソース: ウェブアプリ

ウェブ用 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の一意の識別子。

この識別子は、 WebAppnamespace値を設定するためにのみ使用されます。ほとんどの使用例では、 appId使用してアプリを識別または参照します。 webId値は、 FirebaseProjectとそれに関連付けられたアプリ内でのみ一意です。

apiKeyId

string

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

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

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

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

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に復元します。