Firebase Remote Config を使用すると、アプリでパラメータを定義し、それらの値をクラウドで更新できます。これにより、アプリのアップデートを配布しなくてもアプリの外観や動作を変更できます。このガイドでは、作業を開始するための手順について説明し、サンプルコードを示します（すべてのサンプルコードは firebase/quickstart-Android GitHub リポジトリからクローンを作成またはダウンロードできます）。
ステップ 1: Firebase と Remote Config SDK をアプリに追加する
まだ追加していない場合は、Firebase を Android プロジェクトに追加します。
Remote Config で、ユーザー プロパティとオーディエンスを対象としたアプリ インスタンスの条件付きターゲティングを行うには、Google Analytics が必要です。プロジェクトで Google Analytics を有効にしてください。
モジュール（アプリレベル）の Gradle ファイル（通常は
<project>/<app-module>/build.gradle.ktsまたは<project>/<app-module>/build.gradle）に、Android 用 Remote Config ライブラリの依存関係を追加します。ライブラリのバージョニングの制御には、Firebase Android BoM を使用することをおすすめします。また、Analytics の設定の一環として、Google Analytics 用の Firebase SDK をアプリに追加する必要があります。
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:34.1.0")) // Add the dependencies for the Remote Config and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config") implementation("com.google.firebase:firebase-analytics") }
Firebase Android BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。
（代替方法）BoM を使用せずに Firebase ライブラリの依存関係を追加する
Firebase BoM を使用しない場合は、依存関係の行でそれぞれの Firebase ライブラリのバージョンを指定する必要があります。
アプリで複数の Firebase ライブラリを使用する場合は、すべてのバージョンの互換性を確保するため、BoM を使用してライブラリのバージョンを管理することを強くおすすめします。
dependencies { // Add the dependencies for the Remote Config and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config:23.0.0") implementation("com.google.firebase:firebase-analytics:23.0.0") }
ステップ 2: Remote Config シングルトン オブジェクトを取得する
Remote Config オブジェクト インスタンスを取得し、最小フェッチ間隔を設定して頻繁に更新できるようにします。
Kotlin
val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig val configSettings = remoteConfigSettings { minimumFetchIntervalInSeconds = 3600 } remoteConfig.setConfigSettingsAsync(configSettings)
Java
FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance(); FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder() .setMinimumFetchIntervalInSeconds(3600) .build(); mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
このシングルトン オブジェクトは、アプリ内デフォルト パラメータ値の保存、更新されたパラメータ値のバックエンドからのフェッチ、フェッチされた値がアプリで使用できるようになるタイミングの制御に使用されます。
開発時には、比較的短い最小フェッチ間隔を設定することをおすすめします。詳細については、スロットル処理をご覧ください。
ステップ 3: アプリ内のデフォルト パラメータ値を設定する
アプリ内デフォルト パラメータ値を Remote Config オブジェクトに設定すると、Remote Config バックエンドに接続する前にアプリを意図したとおりに動作させることができます。また、バックエンド側に値が設定されていない場合は、これらのデフォルト値を使用できます。
Map オブジェクト、またはアプリの
res/xmlフォルダに格納されている XML リソース ファイルを使用して、一連のパラメータ名とデフォルト パラメータ値を定義します。Remote Config クイックスタート サンプルアプリでは、XML ファイルを使用してデフォルトのパラメータ名や値を定義しています。Remote Config バックエンド パラメータ値をすでに構成している場合は、すべてのデフォルト値を含む生成された XML ファイルをダウンロードして、アプリの
res/xmlディレクトリに保存できます。REST
curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
Firebase コンソール
[パラメータ] タブで メニューを開き、[デフォルト値をダウンロード] を選択します。
プロンプトが表示されたら、[.xml（Android 用）] を有効にして、[ファイルをダウンロード] をクリックします。
次のように
setDefaultsAsync(int)を使用して、これらの値を Remote Config オブジェクトに追加します。Kotlin
remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
Java
mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
ステップ 4: アプリ内で使用するパラメータ値を取得する
ここまでの手順で、パラメータ値を Remote Config オブジェクトから取得できるようになりました。バックエンドに値を設定し、フェッチして有効化すると、それらの値をアプリで使用できるようになります。または、setDefaultsAsync(int) を使用して、構成したアプリ内パラメータ値を取得します。これらの値を取得するには、アプリによって予期されるデータ型に対応した以下のメソッドを呼び出します。このとき、引数としてパラメータキーを指定します。
ステップ 5: Remote Config バックエンドでパラメータ値を設定する
Firebase コンソールまたは Remote Config バックエンド API を使用して、サーバーサイドの新しいデフォルト値を作成できます。このデフォルト値は、目的の条件付きロジックまたはユーザー ターゲティングに従って、アプリ内の値をオーバーライドします。このセクションでは、Firebase コンソールでこれらの値を作成するための手順を説明します。
- Firebase コンソールでプロジェクトを開きます。
- メニューから [Remote Config] を選択して、Remote Config ダッシュボードを表示します。
- アプリで定義したパラメータと同じ名前のパラメータを定義します。それぞれのパラメータにデフォルト値を設定できます（最終的には対応するアプリ内デフォルト値をオーバーライドします）。また、条件値を設定することもできます。詳細については、Remote Config のパラメータと条件をご覧ください。
カスタム シグナル条件を使用する場合は、属性とその値を定義します。次の例は、カスタム シグナル条件を定義する方法を示しています。
Kotlin
val customSignals = customSignals { put("city", "Tokyo") put("preferred_event_category", "sports") } remoteConfig.setCustomSignals(customSignals)
Java
CustomSignals customSignals = new CustomSignals.Builder() .put("city", "Tokyo") .put("preferred_event_category", "sports") .build(); mFirebaseRemoteConfig.setCustomSignals(customSignals);
ステップ 6: 値をフェッチして有効にする
- Remote Config バックエンドからパラメータ値をフェッチするには、
fetch()メソッドを呼び出します。バックエンドに設定したすべての値がフェッチされ、Remote Config オブジェクトに保存されます。 フェッチ済みのパラメータ値をアプリで使用できるようにするには、
activate()メソッドを呼び出します。1 回の呼び出しで値をフェッチして有効化する場合は、
fetchAndActivate()リクエストを使用して Remote Config バックエンドから値をフェッチし、それらをアプリで利用できるようにします。Kotlin
remoteConfig.fetchAndActivate() .addOnCompleteListener(this) { task -> if (task.isSuccessful) { val updated = task.result Log.d(TAG, "Config params updated: $updated") Toast.makeText( this, "Fetch and activate succeeded", Toast.LENGTH_SHORT, ).show() } else { Toast.makeText( this, "Fetch failed", Toast.LENGTH_SHORT, ).show() } displayWelcomeMessage() }
Java
mFirebaseRemoteConfig.fetchAndActivate() .addOnCompleteListener(this, new OnCompleteListener<Boolean>() { @Override public void onComplete(@NonNull Task<Boolean> task) { if (task.isSuccessful()) { boolean updated = task.getResult(); Log.d(TAG, "Config params updated: " + updated); Toast.makeText(MainActivity.this, "Fetch and activate succeeded", Toast.LENGTH_SHORT).show(); } else { Toast.makeText(MainActivity.this, "Fetch failed", Toast.LENGTH_SHORT).show(); } displayWelcomeMessage(); } });
これらの更新されたパラメータ値はアプリの動作と外観に影響するので、スムーズなユーザー エクスペリエンスを実現するタイミング（次にユーザーがアプリを開いたときなど）でフェッチ済みの値を有効化する必要があります。詳細と例については、Remote Config の読み込み方法をご覧ください。
ステップ 7: リアルタイムで更新をリッスンする
パラメータ値をフェッチしたら、リアルタイム Remote Config を使用して、Remote Config バックエンドからの更新をリッスンできます。更新が利用可能になると、リアルタイム Remote Config によって接続済みデバイスに通知され、新しいバージョンの Remote Config を公開すると変更が自動的にフェッチされます。
リアルタイム更新は、Firebase SDK for Android v21.3.0 以降（Firebase BoM v31.2.4 以降）でサポートされています。
アプリで
addOnConfigUpdateListener()を使用して更新のリッスンを開始し、新しいパラメータ値を自動的にフェッチします。onUpdate()コールバックを実装して、更新された構成を有効にします。Kotlin
remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener { override fun onUpdate(configUpdate : ConfigUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys); if (configUpdate.updatedKeys.contains("welcome_message")) { remoteConfig.activate().addOnCompleteListener { displayWelcomeMessage() } } } override fun onError(error : FirebaseRemoteConfigException) { Log.w(TAG, "Config update error with code: " + error.code, error) } })
Java
mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() { @Override public void onUpdate(ConfigUpdate configUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys()); mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() { @Override public void onComplete(@NonNull Task<Boolean> task) { displayWelcomeMessage(); } }); } @Override public void onError(FirebaseRemoteConfigException error) { Log.w(TAG, "Config update error with code: " + error.getCode(), error); } });
新しいバージョンの Remote Config を次回公開すると、アプリを実行して変更をリッスンしているデバイスが
ConfigUpdateListenerを呼び出します。
スロットル処理
アプリが短期間に何度もフェッチすると、フェッチ呼び出しが抑制され、SDK から FirebaseRemoteConfigFetchThrottledException が返されます。バージョン 17.0.0 よりも前の SDK では、フェッチ リクエストは 60 分間に 5 回までと制限されていました（新しいバージョンでは制限が緩和されています）。
アプリの開発では、構成ファイルを頻繁に（1 時間に何度も）フェッチして有効にし、アプリの開発とテストを迅速にイテレーションすることをおすすめします。リアルタイム Remote Config の更新は、サーバーで構成ファイルが更新されると、キャッシュを自動的にバイパスします。10 人程度の開発者がいるプロジェクトで迅速なイテレーションに対応するには、アプリ内で FirebaseRemoteConfigSettings オブジェクトの最小フェッチ間隔（setMinimumFetchIntervalInSeconds）の値を一時的に小さくします。
Remote Config のデフォルトの最小フェッチ間隔は 12 時間です。つまり、実際にフェッチ呼び出しが行われた回数に関係なく、12 時間のウィンドウ内で構成ファイルがバックエンドから複数回フェッチされることはありません。具体的には、次の順で最小フェッチ間隔が決定されます。
fetch(long)のパラメータFirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)のパラメータ- デフォルト値（12 時間）
最小フェッチ間隔のカスタム値を設定するには、FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) を使用します。
次のステップ
Remote Config のユースケースに関する詳細な情報が必要な方は、主要なコンセプトと高度な戦略に関する以下のドキュメントをご覧ください。