Remote Config SDK API リファレンス
Find the Remote Config SDK API you can use to fetch configurations, retrieve and set values, and handle configuration responses.
読み終わるまでの所要時間 2 分最終更新 1ヶ月前
クラス
RemoteConfigService
public sealed class RemoteConfigService
ランタイムに設定を取得および適用するには、このクラスを使用します。 は基礎となる クラスの機能を模倣するラッパークラスです。 クラスのインスタンスを使用し、 のプリミティブクラスにします。
FetchCompleted
public event Action<ConfigResponse> FetchCompleted
このイベントは、設定マネージャーがサービスからの設定の取得に成功したときに発生します。Remote Config の取得の応答を表す構造体を返します。
appConfig
public RuntimeConfig appConfig
Remote Config 設定を処理するための オブジェクトを取得します。このプロパティを使用して、以下のメソッドとクラスにアクセスします。
メソッド | 説明 |
|---|
public string assignmentID
| レポート作成と分析の目的で使用される一意の文字列 ID。Remote Config サービスは、設定リクエスト時にこの ID を生成します。 |
public bool GetBool (string key, bool defaultValue)
| 存在する場合、リモートサービスから対応するキーのブーリアン値を取得します。 |
public float GetFloat (string key, float defaultValue)
| 存在する場合、リモートサービスから対応するキーの Float 値を取得します。 |
public long GetLong (string key, long defaultValue)
| 存在する場合、リモートサービスから対応するキーの long 値を取得します。 |
public int GetInt (string key, int defaultValue)
| 存在する場合、リモートサービスから対応するキーの整数値を取得します。 |
public string GetString (string key, string defaultValue)
| 存在する場合、リモートサービスから対応するキーの文字列値を取得します。 |
public bool HasKey (string key)
| 対応するキーがリモート設定に存在するかどうかを確認します。 |
public string[] GetKeys ()
| リモート設定内のすべてのキーを配列として返します。 |
public string[] GetJson ()
| 存在する場合、リモートサービスから対応するキーの JSON 値の文字列表現を返します。 |
GetConfig
public RuntimeConfig GetConfig(string configType)
configType を渡すことで、複数の設定オブジェクトから特定の設定を取得します。
SetCustomUserID
public void SetCustomUserID(string customUserID)
Remote Config 配信リクエストのペイロードにカスタムユーザー ID を設定します。
SetEnvironmentID
public void SetEnvironmentID(string environmentID)
Remote Config 配信リクエストのペイロードに環境 ID を設定します。
SetPlayerIdentityTokenID
public void SetPlayerIdentityTokenID(string playerIdentityTokenID)
プレイヤー識別トークンを設定します。
SetUserID
public void SetUserID(string iid)
を、Core サービスから取得した ID に設定します。
SetPlayerID
public void SetPlayerID(string playerID)
Authentication サービスから取得したプレイヤー ID を設定します。
SetAnalyticsUserID
public void SetAnalyticsUserID(string analyticsUserID)
Core サービスから取得した Analytics ユーザー ID を設定します。
SetConfigAssignmentHash
public void SetConfigAssignmentHash(string confiAssignmentHashID)
Core サービスから取得した ID を設定します。
FetchConfigsAsync
public Task<RuntimeConfig> FetchConfigsAsync<T, T2, T3>(string configType, T userAttributes, T2 appAttributes, T3 filterAttributes)
リモートサーバーからアプリケーション設定を取得します。
パラメーター | 説明 |
|---|
| を格納した文字列。何も該当しない場合、空の文字列を使用します。 |
| カスタムユーザー属性を格納した構造体。何も該当しない場合、空の構造体を使用します。 |
| カスタムアプリケーション属性を格納した構造体。何も該当しない場合、空の構造体を使用します。 |
| カスタムフィルター属性を格納した構造体。何も該当しない場合、空の構造体を使用します。 |
| 構造体のタイプ。 |
| 構造体のタイプ。 |
| 構造体のタイプ。 |
列挙型
ConfigOrigin
最も最近ロードされた設定の原点を表す列挙型。
値 | 説明 |
|---|
| 現在のセッションにロードされた設定がないことを示します。 |
| 現在のセッションにロードされた設定が前のセッションからキャッシュされていることを示します (つまり新しい設定はロードされていません)。 |
| 現在のセッションで新しい設定がリモートサーバーからロードされていることを示します。 |
ConfigRequestStatus
現在の Remote Config リクエストのステータスを表す列挙型。
値 | 説明 |
|---|
| Remote Config リクエストが行われていないことを示します。 |
| Remote Config リクエストが失敗したことを示します。 |
| Remote Config リクエストが成功したことを示します。 |
| Remote Config リクエストがまだ処理中であることを示します。 |