Firebase Remote Config。
関数
| 関数 | 説明 |
|---|---|
| getRemoteConfig(アプリ) | デフォルト アプリまたは特定のアプリの RemoteConfig サービスを取得します。引数なしで getRemoteConfig() を呼び出してデフォルト アプリの RemoteConfig サービスにアクセスするか、getRemoteConfig(app) として呼び出して、特定のアプリに関連付けられている RemoteConfig サービスにアクセスできます。 |
クラス
| クラス | 説明 |
|---|---|
| RemoteConfig | Firebase RemoteConfig サービス インターフェース。 |
列挙型
| 列挙 | 説明 |
|---|---|
| PercentConditionOperator | パーセント条件でサポートされる演算子を定義します。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| AndCondition | すべてが true の場合に true と評価される条件のコレクションを表します。 |
| 明示的パラメータ値 | 明示的なパラメータ値を表すインターフェース。 |
| GetServerTemplateOptions | ServerTemplate をインスタンス化する際に使用できるオプションの引数を表します。 |
| InAppDefaultValue | アプリ内デフォルト値を表すインターフェース。 |
| InitServerTemplateOptions | ServerTemplate を同期的にインスタンス化する際に使用できるオプションの引数を表します。 |
| ListVersionsOptions | Remote Config でバージョンを一覧表示するオペレーションのオプションを表すインターフェース。 |
| ListVersionsResult | Remote Config テンプレートのバージョンのリストを表すインターフェース。 |
| MicroPercentRange | ターゲットにするパーセンタイルの上限をマイクロパーセントで表します。値は [0 ～ 100000000] の範囲で指定してください |
| NamedCondition | データプレーン内の Remote Config の条件を表します。条件は特定のユーザー グループをターゲットにします。これらの条件のリストは、Remote Config テンプレートの一部です。 |
| OneOfCondition | 複数の型のいずれかに該当する条件を表します。最初に定義されたフィールドのみが処理されます。 |
| OrCondition | いずれかが true の場合に true と評価される条件のコレクションを表します。 |
| PercentCondition | インスタンスの擬似ランダム パーセンタイルを特定の制限と比較する条件を表します。 |
| RemoteConfigCondition | Remote Config の条件を表すインターフェース。条件は特定のユーザー グループをターゲットにします。これらの条件のリストは Remote Config テンプレートの一部です。 |
| RemoteConfigParameter | Remote Config パラメータを表すインターフェース。パラメータを有効にするには、少なくとも defaultValue または conditionalValues のエントリが必要です。 |
| RemoteConfigParameterGroup | Remote Config パラメータ グループを表すインターフェース。パラメータのグループ化は管理のみを目的としており、クライアントサイドでのパラメータ値の取得には影響しません。 |
| RemoteConfigTemplate | Remote Config クライアント テンプレートを表します。 |
| RemoteConfigUser | 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 文字列のいずれかを指定できます。 |
| タグの色 | 表示目的の条件に関連付けられた色。 |
| 値ソース | 値のソースを示します。
|
getRemoteConfig(アプリ)
デフォルト アプリまたは指定されたアプリの RemoteConfig サービスを取得します。
デフォルト アプリの RemoteConfig サービスにアクセスするには、引数なしで getRemoteConfig() を呼び出すか、getRemoteConfig(app) として呼び出して特定のアプリに関連付けられている RemoteConfig サービスにアクセスします。
署名:
export declare function getRemoteConfig(app?: App): RemoteConfig;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| app | アプリ | 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;
};
EvaluationContext
テンプレート評価入力シグナルを表します。
署名:
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;
ServerTemplateDataType
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';
値のソース
値のソースを示します。
- 「static」は、値が静的定数によって定義されたことを示します。
- 「default」は、値がデフォルトの構成によって定義されていることを示します。
- 「remote」は、テンプレートの評価によって生成された構成によって値が定義されたことを示します。
署名:
export type ValueSource = 'static' | 'default' | 'remote';
PercentConditionOperator
パーセント条件でサポートされる演算子を定義します。
署名:
export declare enum PercentConditionOperator
列挙型メンバー
| Member | 値 | 説明 |
|---|---|---|
| BETWEEN | "BETWEEN" |
下限と上限で定義された区間内のターゲット パーセンタイル。下限は排他的（オープン）境界であり、micro_percent_range_upper_bound は包含的（クローズド）境界です。この演算子を使用する条件では microPercentRange を指定する必要があります。 |
| GREATER_THAN | "GREATER_THAN" |
ターゲット パーセンタイルがターゲット パーセンタイルより大きい。この演算子を使用する条件では microPercent を指定する必要があります。 |
| LESS_OR_EQUAL | "LESS_OR_EQUAL" |
ターゲット パーセンタイル以下のターゲット パーセンタイル。この演算子を使用する条件では microPercent を指定する必要があります。 |
| 不明 | "UNKNOWN" |
キャッチオール エラーのケース。 |