Firebase Remote Config を Android で使用する

Firebase Remote Config を使ってアプリ内パラメータを定義し、その値をクラウドで更新することができます。これにより、アプリのアップデートを配布しなくてもアプリの外観や動作を変更できます。このガイドでは、次の手順に沿ってアプリで Remote Config を使用する方法について説明します。

  1. アプリに Firebase を追加します。
  2. Remote Config シングルトン オブジェクトを取得します。
  3. アプリ内デフォルト パラメータ値を設定します。
  4. アプリ内で使うパラメータ値を取得します。
  5. 必要に応じて、パラメータ値を Remote Config サーバーに設定します。
  6. 必要に応じて、Remote Config サーバーから値をフェッチし、有効化します。

アプリに Firebase を追加する

Firebase SDK をインストールし、Remote Config への依存関係をアプリレベルの build.gradle ファイルに必ず追加してください。

compile 'com.google.firebase:firebase-config:10.0.1'

Remote Config シングルトン オブジェクトを取得する

Remote Config クイックスタートのサンプルアプリに示されている FirebaseRemoteConfig.getInstance() メソッドを使用して、シングルトン Remote Config オブジェクトを取得します。

シングルトン オブジェクトは、アプリ内デフォルト パラメータ値を格納し、更新されたパラメータ値をサーバーからフェッチし、フェッチ済みの値をアプリで有効にするタイミングを制御するために使用されます。詳しくは Remote Config API の概要をご覧ください。

アプリ内デフォルト パラメータ値を設定する

アプリ内デフォルト パラメータ値を Remote Config オブジェクトに設定して、Remote Config サーバーから値をフェッチする前にアプリが予想通りに動作するようにしておく必要があります。

  1. Map オブジェクトまたはアプリの res/xml フォルダに格納される XML リソース ファイルを使用して、一連のパラメータ名とデフォルト パラメータ値を定義します。Remote Config クイックスタート サンプルアプリでは、XML ファイルを使用してデフォルトのパラメータ名や値を定義しています。
  2. Remote Config クイックスタート サンプルアプリに示されているように、setDefaults() を使用して、それらの値を Remote Config オブジェクトに追加します。

アプリ内で使うパラメータ値を取得する

ここまでの手順で、パラメータ値を Remote Config オブジェクトから取得できるようになりました。Remote Config サーバーに設定した値をフェッチし、有効化すると、それらの値をアプリで使用できるようになります。または setDefaults() を使って設定したアプリ内パラメータ値を取得します。アプリ内パラメータ値を取得するには、アプリによって予期されるデータ型に対応した下記のメソッドを呼び出します。このとき、引数としてパラメータキーを指定します。

必要に応じて、パラメータ値をサーバーに設定する

  1. Firebase console でプロジェクトを開きます。
  2. メニューから [Remote Config] を選択して Remote Config ダッシュボードを表示します。
  3. アプリで定義したパラメータと同じ名前のパラメータを定義します。それぞれのパラメータにデフォルト値を設定することができます(最終的にはアプリ内デフォルト値をオーバーライドします)。また、条件値を設定することもできます。詳しくは Remote Config のパラメータと条件についての記事をご覧ください。

必要に応じて、サーバーから値をフェッチし、有効化する

  1. Remote Config サーバーからパラメータ値をフェッチするには、fetch() メソッドを呼び出します。Remote Config サーバーに設定したすべての値がフェッチされ、Remote Config オブジェクトにキャッシュ保存されます。
  2. フェッチ済みのパラメータ値をアプリで使用できるようにするには、activateFetched() メソッドを呼び出します。

更新されたパラメータ値はアプリの動作と外観に影響するので、スムーズなユーザー エクスペリエンスを邪魔しないタイミングでフェッチ済みの値を有効化する必要があります。たとえば、次にユーザーがアプリを開いたときなどに有効化します。

次のステップ

Remote Config クイックスタート サンプルアプリの詳細については、Firebase Remote Config の Android 向けサンプルアプリのチュートリアルをご覧ください。

Remote Config をアプリで使う方法については、Remote Config に関するよくある質問(FAQ)のパラメータ値のフェッチと有効化デベロッパー モードと調整フェッチのタイミングをご覧ください。

フィードバックを送信...