Remote Config のパラメータと条件

クライアントとサーバーの両方のユースケース用のテンプレートを構成できます。クライアント テンプレートは、Android、Apple、ウェブ、Unity、Flutter、C++ アプリなど、Remote Config 用の Firebase クライアント SDK を実装するアプリ インスタンスに提供されます。サーバー固有のテンプレートの Remote Config のパラメータと値は、次のサーバー環境を使用する Remote Config 実装（Cloud Run と Cloud Functions を含む）に提供されます。

• Firebase Admin Node.js SDK v12.1.0 以降
• Firebase Admin Python SDK v6.7.0 以降
• Firebase Admin Go SDK（v4.17.0 以降）
• Firebase Admin Java SDK（v9.7.0 以降）

Firebase コンソールまたは Remote Config バックエンド API を使用する場合は、1 つ以上のパラメータ（Key-Value ペア）を定義し、これらのパラメータのアプリ内デフォルト値を指定します。アプリ内デフォルト値は、パラメータ値を定義してオーバーライドできます。パラメータキーとパラメータ値は文字列ですが、パラメータ値はアプリで値を使用するときに他のデータ型にキャストすることができます。

Firebase コンソール、Admin SDK、または Remote Config REST API を使用して、パラメータの新しいデフォルト値を作成できます。また、アプリ インスタンスのグループのターゲット設定に使用する条件値を作成することもできます。Firebase コンソールで構成を更新するたびに、Firebase は Remote Config テンプレートの新しいバージョンを作成してパブリッシュします。以前のバージョンは保存されるため、必要に応じて取得またはロールバックできます。これらのオペレーションは、Firebase コンソール、Firebase Admin SDK、REST API で行うことができます。詳細については、Remote Config テンプレートのバージョンを管理するをご覧ください。

このガイドでは、パラメータ、条件、ルール、条件値について説明します。また、Remote Config バックエンドとアプリでのさまざまなパラメータ値の優先順位について説明します。さらには、条件の作成に使用されるルールのタイプについても詳しく説明します。

条件、ルール、条件値

条件は、アプリ インスタンスのグループをターゲットとして設定するために使用されます。条件は 1 つまたは複数のルールで構成され、特定のアプリ インスタンスに対して条件が true と評価されるには、すべてのルールが true と評価される必要があります。ルールの値が定義されていない場合（値が利用できない場合など）は、そのルールは false と評価されます。

たとえば、アプリのスプラッシュ ページを定義するパラメータでルール if device_os = Android を使用して、OS の種類に基づいて異なる画像を表示できます。

または、時間条件を使用して、アプリに特別なプロモーション アイテムを表示するタイミングを制御することもできます。

パラメータは、異なる条件を使用する複数の条件値を取ることができ、複数のパラメータが単一プロジェクト内の条件を共有できます。Firebase コンソールの [パラメータ] タブで、各パラメータの条件値の取得率を確認できます。この指標は、過去 24 時間に各値を受け取ったリクエストの割合を示します。

パラメータ値の優先順位

パラメータには複数の条件値が関連付けられる場合があります。次のルールによって、Remote Config テンプレートからどの値をフェッチするか、また、特定のタイミングにおいて特定のアプリ インスタンスでどの値を使用するかが決定されます。

1. まず、特定のクライアント リクエストに対して true と評価される条件があれば、その条件値が適用されます。複数の条件が true と評価される場合は、Firebase コンソール UI に表示される最初の（一番上の）条件が優先され、アプリがバックエンドから値をフェッチするときに、その条件に関連付けられた条件値が提供されます。条件の優先順位は、[条件] タブで条件をドラッグ＆ドロップすることにより変更できます。

2. 条件が true と評価される条件値が存在しない場合は、アプリがバックエンドから値をフェッチすると、Remote Config のデフォルト値が提供されます。パラメータがバックエンドに存在しない場合、またはデフォルト値が [アプリ内デフォルト値を使用する] に設定されている場合は、アプリが値をフェッチしても、そのパラメータの値は提供されません。

アプリ内でパラメータ値が get メソッドによって返される優先順位

1. バックエンドから値がフェッチされ、有効化された場合、アプリはそのフェッチされた値を使用します。有効化されたパラメータ値は永続的です。

2. バックエンドから値がフェッチされなかった場合、または Remote Config バックエンドからフェッチされた値が有効化されていない場合、アプリはアプリ内デフォルト値を使用します。

   デフォルト値の取得と設定の詳細については、Remote Config テンプレートのデフォルトをダウンロードするをご覧ください。

3. アプリ内デフォルト値が設定されていない場合、アプリは静的型の値（int の場合は 0、boolean の場合は false など）を使用します。

次の図は、Remote Config バックエンドとアプリ内でパラメータ値の優先順位がどのように決定されるかについて概要を示しています。

パラメータ値のデータ型

Remote Config では、パラメータごとにデータ型を選択できます。テンプレートの更新前に、すべての Remote Config 値がその型に照らし合わせて検証されます。データ型の格納と取得は getRemoteConfig リクエストで行われます。

サポートされているデータ型は次のとおりです。

• String
• Boolean
• Number
• JSON

Firebase コンソールの UI では、パラメータキーの横にあるプルダウンでデータ型を選択できます。REST API では、パラメータ オブジェクト内の value_type フィールドを使用して型を設定できます。

パラメータ グループ

Remote Config を使用すると、パラメータをグループ化して UI を整理し、ユーザビリティを向上させることができます。

たとえば、新しいログイン機能をリリースする際に、3 種類の認証タイプを有効または無効にする必要があるとします。この場合、Remote Config を使用して、それぞれの認証タイプを必要に応じて有効にする 3 つのパラメータを作成し、これらのパラメータを「New login」という名前のグループにまとめると、接頭辞の追加や特殊な並び替えが不要になります。

パラメータ グループを作成するには、Firebase コンソールまたは Remote Config REST API を使用します。作成した各パラメータ グループには、Remote Config テンプレートで一意の名前が付けられます。パラメータ グループを作成する際は、次の点にご注意ください。

• 各パラメータが属することができるグループは常に 1 つのみです。また、パラメータがグループに属していても、パラメータキーはすべてのパラメータで一意でなければなりません。
• パラメータ グループ名の長さは 256 文字に制限されています。
• REST API と Firebase コンソールの両方を使用する場合は、公開時にパラメータ グループを処理するように REST API ロジックを更新してください。

Firebase コンソールを使用してパラメータ グループを作成または変更する

Firebase コンソールの [パラメータ] タブで、パラメータをグループ化できます。グループを作成または変更するには:

1. [グループを管理] を選択します。
2. グループに追加するパラメータのチェックボックスをオンにして、[グループに移動] を選択します。
3. 既存のグループを選択するか、新しいグループを作成します。新しいグループを作成する場合は、名前と説明を入力し、[新しいグループを作成] を選択します。グループを保存した後に [変更を公開] ボタンを使用すると、保存済みのグループを公開できます。

プログラムによってグループを作成する

Remote Config REST API を使用すると、自動的にパラメータ グループを作成して公開できます。REST を十分に理解していて、API に対するリクエストを承認するように設定している場合は、次の手順でグループをプログラムによって管理できます。

1. 現在のテンプレートを取得します。
2. パラメータ グループを表す JSON オブジェクトを追加します。
3. HTTP PUT リクエストを使用してパラメータ グループを公開します。

parameterGroups オブジェクトにグループキーが含まれ、グループ化されたパラメータの説明とリストがネストされます。各グループキーはグローバルに一意である必要があります。

次の例は、pumpkin_spice_season パラメータのみが含まれるパラメータ グループ「new menu」を追加するテンプレート リビジョンからの抜粋です。

{
  "parameters": {},
  "version": {
    "versionNumber": "1",

    …

  },
  "parameterGroups": {
    "new menu": {
      "description": "New Menu",
      "parameters": {
        "pumpkin_spice_season": {
          "defaultValue": {
            "value": "true"
          },
          "description": "Whether it's pumpkin spice season."
        }
      }
    }
  }
}

カスタム シグナル条件

カスタム シグナル条件値を使用すると、アプリで定義して送信する任意のシグナルを、Remote Config のシグナルに基づいて作成した条件と照合できます。これにより、アプリまたはクライアントサイドのエクスペリエンスを調整できます。

カスタム シグナル条件は、次のクライアント環境で使用できます。

• iOS: v11.8.0 以降
• Android: v22.1.0 以降（Firebase BoM v33.8.0 以降）
• ウェブ: v11.2.0 以降
• Flutter: Flutter BoM バージョン 3.6.0 以降

たとえば、ホーム画面にバナーを表示するチケット販売アプリを開発しているとします。クライアントサイドのカスタム シグナル条件を使用すると、ユーザーの位置情報や興味 / 関心に基づいてこれらのバナーをカスタマイズできます。次の操作を実行できます。

1. banner_image_url と banner_link を Remote Config クライアント テンプレートに追加します。これらは、バナーの画像と、この画像に関連付けられたイベントページを表します。
2. アプリからカスタム シグナルの値を city と preferred_event_category に設定します。
3. クライアント固有の Remote Config テンプレートにデフォルト値を追加し、前の手順で設定したカスタム シグナルに基づいて条件値を作成します。
4. クライアント固有の Remote Config テンプレートにデフォルト値を追加し、定義した条件ごとに条件値を追加します。
5. カスタム シグナル条件を設定して使用するように、アプリケーション コードを更新します。

これで、アプリは Remote Config サーバーからこれらのパラメータをフェッチするときに、適切な banner_image_url と banner_link をダウンロードできるようになります。

上限

カスタム シグナル条件を作成する場合は、次の制限に従う必要があります。

• カスタム シグナルの数: アプリ インスタンスごとに最大 100 個のカスタム シグナルを作成できます。カスタム シグナルの値を null に設定すると、カスタム シグナルを未設定にできます。
• カスタム シグナル名: 各カスタム シグナル名は最大 250 文字です。
• カスタム シグナル値: 各カスタム シグナル値は最大 500 文字です。正規表現を使用する場合、最大文字数は 250 文字です。

条件ルールの種類

Firebase コンソールでサポートされるルールの種類は次のとおりです。Remote Config REST API にも同等の機能があります。詳しくは、条件式リファレンスをご覧ください。

検索のパラメータと条件

Firebase コンソールで、Remote Config の [パラメータ] タブの上部にある検索ボックスを使用して、プロジェクトのパラメータキー、パラメータ値、条件を検索できます。

パラメータと条件の制限

Firebase プロジェクト内には、最大 3,000 個のパラメータ、最大 2,000 個の条件を設定できます。パラメータキーの長さは最大 256 文字で、アンダースコアまたはアルファベット（A～Z、a～z）で始める必要があります。数字を使用することもできます。プロジェクト内のパラメータ値文字列の合計長は、1,000,000 文字以内にする必要があります。

パラメータと条件の変更を表示する

Remote Config テンプレートに対する最新の変更は、Firebase コンソールで確認できます。個々のパラメータと条件ごとに、次のことが可能です。

• パラメータまたは条件を最後に更新したユーザーの名前を確認します。

• 変更が同じ日に行われた場合は、アクティブな Remote Config テンプレートに変更を公開してから経過した分数または時間数を表示します。

• 変更が過去 1 日以上前に行われた場合は、変更がアクティブな Remote Config テンプレートに公開された日付を表示します。

パラメータの変更履歴

Remote Config の [パラメータ] ページでは、[最終公開日] 列に、各パラメータを最後に変更したユーザーと、変更の最終公開日が表示されます。

• グループ化されたパラメータの変更メタデータを表示するには、パラメータ グループを展開します。

• 公開日で昇順または降順で並べ替えるには、[最終公開日] 列ラベルをクリックします。

条件の変更履歴

Remote Config の [条件] ページでは、その条件を最後に変更したユーザーとその変更日を、各条件の下の [最終更新日] の横で確認できます。

次のステップ