Firebase Remote Config を使ってみる

Firebase Remote Config を使ってアプリ内パラメータを定義し、その値をクラウドで更新できます。これにより、アプリのアップデートを配布しなくてもアプリの外観や動作を変更できます。

Remote Config ライブラリは、アプリ内のデフォルトのパラメータ値の保存、Remote Config バックエンドからの更新されたパラメータ値のフェッチ、フェッチされた値がアプリで使用できるようになるタイミングの制御に使用されます。詳細については、Remote Config の読み込み方法をご覧ください。

このガイドでは、作業を開始するための手順について説明し、サンプルコードを示します（すべてのサンプルコードは firebase/quickstart-unity GitHub リポジトリからクローンを作成またはダウンロードできます）。

Remote Config をアプリに追加する

Remote Config を使用するには、次の作業が必要です。

• Firebase を使用するように Unity プロジェクトを登録して構成する。

  • Unity プロジェクトですでに Firebase を使用している場合、この登録と構成はすでに行われています。

  • Unity プロジェクトがない場合は、サンプルアプリをダウンロードできます。

• Unity プロジェクトに Firebase Unity SDK（具体的には FirebaseRemoteConfig.unitypackage）を追加する。

Firebase を Unity プロジェクトに追加するには、Firebase コンソールと開いている Unity プロジェクトの両方でタスクを行う必要があります（コンソールから Firebase 構成ファイルをダウンロードし、それを Unity プロジェクトに移動するなど）。

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

アプリ内デフォルト パラメータ値を Remote Config オブジェクトに設定すると、Remote Config バックエンドに接続する前にアプリを意図したとおりに動作させることができます。また、バックエンド側に値が設定されていない場合は、これらのデフォルト値を使用できます。

これを行うには、文字列辞書を作成し、追加するデフォルトを表す Key-Value ペアを入力します。Remote Config バックエンド パラメータ値をすでに構成している場合は、これらの Key-Value ペアを含むファイルをダウンロードし、これを使用して文字列辞書を作成できます。詳しくは、Remote Config テンプレートのデフォルトをダウンロードするをご覧ください。

（SetDefaultsAsync() を呼び出すと、文字列以外のプロパティはそのプロパティの型に変換されます）。

System.Collections.Generic.Dictionary<string, object> defaults =
  new System.Collections.Generic.Dictionary<string, object>();

// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);

Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
  .ContinueWithOnMainThread(task => {

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

ここまでの手順で、パラメータ値を Remote Config オブジェクトから取得できるようになりました。Remote Config バックエンドに値を設定し、フェッチして有効化すると、それらの値をアプリで使用できるようになります。それ以外の場合に構成したアプリ内パラメータ値を取得するには、SetDefaultsAsync() を使用します。

アプリ内パラメータ値を取得するには、GetValue() を呼び出します。このとき、引数としてパラメータキーを指定します。これは、ConfigValue を返します。ConfigValue には、値をさまざまな基本タイプに変換するプロパティがあります。

Firebase コンソールでアプリを接続する

Firebase コンソールでアプリを Firebase プロジェクトに追加します。

パラメータ値を設定する

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

値をフェッチして有効にする（必要な場合）

Remote Config バックエンドからパラメータ値をフェッチするには、FetchAsync() メソッドを呼び出します。バックエンドに設定したすべての値がフェッチされ、Remote Config オブジェクトにキャッシュ保存されます。

// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan.  Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
  DebugLog("Fetching data...");
  System.Threading.Tasks.Task fetchTask =
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
      TimeSpan.Zero);
  return fetchTask.ContinueWithOnMainThread(FetchComplete);
}

FetchAsync() 経由でフェッチされた値は、フェッチが完了するとローカルにキャッシュ保存されますが、ActivateFetched() が呼び出されるまでは使用できません。FetchAsync() は非同期で実行されるため、計算途中の場合や、問題や異常な動作を引き起こす可能性のある場合は、新しい値が適用されないようにできます。

（省略可）デベロッパー モードを有効にする

開発中にスロットル処理を無効にするためにデベロッパー モードを有効にするには、FirebaseRemoteConfig.Setting プロパティを使用します。このとき、IsDeveloperMode を true に設定した新しい ConfigSettings を設定します。

次のステップ

Remote Config のユースケースに関する詳細な情報が必要な方は、主要なコンセプトと高度な戦略に関する以下のドキュメントをご覧ください。

• テンプレートとバージョニング
• Config の読み込み方法