Firebase Remote Config。
関数
| 関数 | 説明 |
|---|---|
| getRemoteConfig(app) | デフォルト アプリまたは特定のアプリ用の RemoteConfig サービスを取得します。デフォルト アプリの RemoteConfig サービスにアクセスする場合は、引数なしで getRemoteConfig() を呼び出します。特定のアプリに関連付けられた RemoteConfig サービスにアクセスするには、getRemoteConfig(app) として呼び出します。 |
クラス
| クラス | 説明 |
|---|---|
| RemoteConfig | Firebase RemoteConfig サービス インターフェース。 |
列挙値
| 列挙 | 説明 |
|---|---|
| PercentConditionOperator | パーセント条件でサポートされる演算子を定義します。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| AndCondition | すべてが true の場合に true と評価される条件のコレクションを表します。 |
| ExpressionParameterValue | 明示的なパラメータ値を表すインターフェース。 |
| GetServerTemplateOptions | ServerTemplate をインスタンス化する際に使用できるオプションの引数を表します。 |
| InAppDefaultValue | アプリ内デフォルト値を表すインターフェース。 |
| InitServerTemplateOptions | ServerTemplate を同期的にインスタンス化するときに使用できるオプションの引数を表します。 |
| ListVersionsOptions | Remote Config のバージョンの一覧表示オペレーションのオプションを表すインターフェース。 |
| ListVersionsResult | Remote Config テンプレート バージョンのリストを表すインターフェース。 |
| MicroPercentRange | ターゲットにするパーセンタイルの上限をマイクロパーセントで表します。値は [0 ～ 100000000] の範囲内で指定してください。 |
| NamedCondition | データプレーン内の Remote Config 条件を表します。条件は特定のユーザー グループを対象にしています。これらの条件のリストは Remote Config テンプレートの一部です。 |
| OneOfCondition | いくつかの型のうちの 1 つとなる条件を表します。最初に定義されたフィールドのみが処理されます。 |
| OrCondition | いずれかの条件が true の場合に true と評価される条件のコレクションを表します。 |
| PercentCondition | インスタンスの擬似ランダム パーセンタイルを指定した上限と比較する条件を表します。 |
| RemoteConfigCondition | Remote Config 条件を表すインターフェース。条件は特定のユーザー グループを対象にしています。これらの条件のリストは Remote Config テンプレートの一部です。 |
| RemoteConfigParameter | Remote Config パラメータを表すインターフェース。パラメータを有効にするには、少なくとも defaultValue エントリまたは conditionalValues エントリが必要です。 |
| RemoteConfigParameterGroup | Remote Config パラメータ グループを表すインターフェース。パラメータのグループ化は管理のみを目的としており、クライアントサイドでのパラメータ値のフェッチには影響しません。 |
| RemoteConfigTemplate | Remote Config クライアント テンプレートを表します。 |
| RemoteConfig ユーザー | Remote Config ユーザーを表すインターフェース。 |
| ServerConfig | サーバー テンプレートを評価することによって生成される構成を表します。 |
| ServerTemplate | Remote Config サーバー テンプレートのステートフル抽象化を表します。 |
| ServerTemplateData | Remote Config サーバー テンプレートのデータを表します。 |
| 値 | パラメータ値をメタデータとタイプセーフ ゲッターでラップします。タイプセーフ ゲッターは、アプリケーション ロジックを、パラメータ名や型へのリモート変更から分離します。 |
| バージョン | Remote Config テンプレート バージョンを表すインターフェース。出力専用（バージョンの説明を除く）。Remote Config テンプレートの特定のバージョンに関するメタデータが含まれています。すべてのフィールドは、指定した Remote Config テンプレートの公開時に設定されます。バージョンの説明フィールドは、publishTemplate の呼び出しで指定できます。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| DefaultConfig | アプリ内デフォルト パラメータ値の形式を定義します。 |
| EvaluationContext | テンプレート評価の入力シグナルを表します。 |
| ParameterValueType | Remote Config のパラメータ値のデータ型を表す型。指定しない場合のデフォルトは STRING です。 |
| RemoteConfigParameterValue | Remote Config のパラメータ値を表す型。RemoteConfigParameterValue は、ExplicitParameterValue または InAppDefaultValue のいずれかになります。 |
| ServerTemplateDataType | ServerTemplate で設定できる Remote Config サーバー テンプレートのタイプを表します。ServerTemplateData オブジェクトまたはテンプレート JSON 文字列のいずれかを指定できます。 |
| TagColor | 表示用の条件に関連付けられている色。 |
| ValueSource | 値のソースを示します。
|
getRemoteConfig（アプリ）
デフォルト アプリまたは特定のアプリの RemoteConfig サービスを取得します。
getRemoteConfig() を引数なしで呼び出すと、デフォルト アプリの RemoteConfig サービスにアクセスできます。getRemoteConfig(app) として呼び出すと、特定のアプリに関連付けられた RemoteConfig サービスにアクセスできるようになります。
署名:
export declare function getRemoteConfig(app?: App): RemoteConfig;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | RemoteConfig サービスを返すオプションのアプリ。指定しない場合は、デフォルトの RemoteConfig サービスが返されます。 |
戻り値:
アプリが指定されていない場合は、デフォルトの RemoteConfig サービス、または指定されたアプリに関連付けられた RemoteConfig サービス。
例 1
// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();
例 2
// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);
デフォルト構成
アプリ内デフォルト パラメータ値の形式を定義します。
署名:
export type DefaultConfig = {
[key: string]: string | number | boolean;
};
評価コンテキスト
テンプレート評価の入力シグナルを表します。
署名:
export type EvaluationContext = {
randomizationId?: string;
};
ParameterValueType
Remote Config のパラメータ値のデータ型を表す型。指定しない場合のデフォルトは STRING です。
署名:
export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';
RemoteConfigParameterValue
Remote Config のパラメータ値を表す型。RemoteConfigParameterValue は、ExplicitParameterValue または InAppDefaultValue のいずれかです。
署名:
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
ServerTemplate データ型
ServerTemplate で設定できる Remote Config サーバー テンプレートのタイプを表します。ServerTemplateData オブジェクトまたはテンプレート JSON 文字列のいずれかを指定できます。
署名:
export type ServerTemplateDataType = ServerTemplateData | string;
タグカラー
表示用の条件に関連付けられている色。
署名:
export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';
ValueSource
値のソースを示します。
- 「静的」値が静的定数によって定義されたことを示します。
- 「デフォルト」値はデフォルトの構成で定義されていることを示します。
- 「リモート」値は、テンプレートの評価によって生成された構成によって定義されたことを示します。
署名:
export type ValueSource = 'static' | 'default' | 'remote';
PercentConditionOperator
パーセント条件でサポートされる演算子を定義します。
署名:
export declare enum PercentConditionOperator
列挙型メンバー
| メンバー | 値 | 説明 |
|---|---|---|
| BETWEEN | "BETWEEN" |
下限と上限によって定義された区間内のターゲット パーセンタイル。下限は排他的（開）境界、micro_percent_range_upper_bound は排他的（閉）境界です。この演算子を使用する条件では microPercentRange を指定する必要があります。 |
| GREATER_THAN | "GREATER_THAN" |
ターゲット パーセンタイルがターゲットの割合を超えています。この演算子を使用する条件では microPercent を指定する必要があります。 |
| LESS_OR_EQUAL | "LESS_OR_EQUAL" |
ターゲット パーセンタイルがターゲット パーセンテージ以下の場合。この演算子を使用する条件では microPercent を指定する必要があります。 |
| 不明 | "UNKNOWN" |
キャッチオール エラーケース。 |