Method: projects.webApps.getConfig

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 Realtime Database URL。
storageBucket

string

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

string

プロジェクトのデフォルト GCP リソース ロケーションの ID。ロケーションは、使用可能な GCP リソース ロケーションのいずれかです。

デフォルトの 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 アナリティクス ウェブ ストリームに Google によって割り当てられた固有の識別子。Firebase SDK はこの ID を使用して、Google アナリティクス API とやり取りします。

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

measurementId を生成し、WebApp を Google アナリティクスのウェブ ストリームにリンクするには、projects.addGoogleAnalytics を呼び出します。

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

認可スコープ

次の 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

詳細については、認証の概要をご覧ください。