Method: projects.webApps.getConfig

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

HTTPリクエスト

GET https://firebase.googleapis.com/v1beta1/{name=projects/*/webApps/*/config}

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
name

string

ダウンロードするWebApp構成のリソース名 (形式:)

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


APP_IDは一意の識別子であるため、ここではサブコレクションからの一意のリソース アクセス パターンを次の形式で使用できます。

projects/-/webApps/ APP_ID


PROJECT_IDENTIFIERおよびAPP_ID値の詳細については、 WebApp nameフィールドを参照してください。

リクエストボディ

リクエストの本文は空である必要があります。

レスポンスボディ

成功した場合、応答本文には次の構造のデータが含まれます。

ウェブ用の単一の Firebase アプリの構成メタデータ。

JSON表現
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
田畑
projectId

string

不変。ユーザーが割り当てたFirebaseProjectの一意の識別子。

appId

string

不変。 Firebase によって割り当てられたWebAppのグローバルに一意な識別子。

databaseURL

string

デフォルトの Firebase リアルタイム データベース URL。

storageBucket

string

デフォルトの Cloud Storage for Firebase ストレージ バケット名。

locationId

string

プロジェクトのデフォルトの GCP リソースの場所の ID。この場所は、利用可能なGCP リソースの場所の 1 つです。

デフォルトの GCP リソースの場所がまだ確定していない場合、このフィールドは省略されます。プロジェクトのデフォルトの GCP リソースの場所を設定するには、Firebase リソースをプロジェクトに追加した後、 defaultLocation.finalizeを呼び出します。

apiKey

string

WebAppに関連付けられた API キーのkeyString

この値は、 WebAppに関連付けられた API キーのapiKeyId (UID) ではないことに注意してください。

authDomain

string

Firebase Auth が OAuth リダイレクト用に構成するドメインは次の形式です。

PROJECT_ID .firebaseapp.com

messagingSenderId

string

Firebase Cloud Messaging で使用する送信者 ID。

measurementId

string

WebAppに関連付けられた Google アナリティクス Web ストリームの、Google が割り当てた一意の識別子。 Firebase SDK は、この ID を使用して Google Analytics API とやり取りします。

このフィールドは、 WebApp Google アナリティクス アプリ + ウェブ プロパティの Web ストリームにリンクされている場合にのみ存在します。この ID と Google Analytics Web ストリームの詳細については、 Analytics のドキュメントを参照してください。

measurementIdを生成し、 WebApp Google Analytics Web ストリームにリンクするには、 projects.addGoogleAnalyticsを呼び出します。

Firebase JavaScript SDK v7.20.0 以降を使用するアプリの場合、アプリが Analytics を初期化するときに、Firebase は動的にmeasurementIdを取得します。構成オブジェクトにこの ID を含めることはオプションですが、動的フェッチが失敗するというまれなケースでのフォールバックとして機能します。

認可の範囲

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

詳細については、 「認証の概要」を参照してください。