Unity SDK
一、说明
1.功能概述
应用的文案或者运营策略更新经常需要通过发版解决，为了减少开发者频繁更新应用版本，热力引擎推出参数下发功能，通过参数下发可以随时远程调整应用中的参数值实现应用内容更新
2.适用范围
本文档适用于使用 Unity 来开发的移动端 APP 或产品。 本文档适用于 Android 5.0 及以上的安卓系统，及 iOS 11.0 及以上的 iOS 系统.
3.SDK 下载
- 最新 SDK 版本为：V1.2.9.2
- 如果开发者要使用参数下发功能，需要去Unity SDK 集成文档中下载带有参数下发功能的SDK压缩包
二、接入SDK
由于参数下发SDK属于热力引擎SDK的一个插件，开发者在接入参数下发SDK时不需要再进行配置，只需要将参数下发SDK对应的桥文件以及源文件导入到项目即可，具体可参考Unity SDK集成文档
三、SDK 方法说明
1.初始化 SDK
参数下发SDK作为热力引擎SDK的一个插件，参数下发SDK初始化依赖于热力引擎SDK的初始化方法，具体初始化方法参考Unity SDK集成文档中热力引擎SDK初始化方法
方法示例
public static void initSeSdk(string appKey, SEConfig seConfig, RCConfig rcConfig)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| appKey | 应用的appKey，需要联系商务人员从热力引擎后台获取 | string | 是 |
| seConfig | 热力引擎SDK配置项 | SEConfig | 是 |
| rcConfig | 热力引擎参数下发SDK配置项 | RCConfig | 是 |
SEConfig参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| isDebug | 是否开启 Debug 模式，默认为关闭状态 | bool | 否 |
| customUrl | 自定义URL | string | 否 |
| isGDPRArea | 是否为GDPR区域,默认为false | bool | 否 |
RCConfig参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| enable | 是否启用参数下发SDK，默认为关闭状态，必传字段 | bool | 是 |
| mergeType | SDK配置合并策略，默认情况下服务端配置跟本地缓存配置合并，具体释义参考下方参数解释,可选字段 | SERCMergeType | 否 |
| pollingInterval | 轮询间隔时间（单位：分），区间：30分钟-24小时,默认为30分钟 | int | 否 |
| customIDProperties | 自定义ID，跟用户在后台设置的使用自定义ID匹配对应 | Dictionary<string, object> | 否 |
| customIDEventProperties | 自定义ID事件属性值，跟用户在后台设置的使用自定义ID事件属性值匹配对应,可选字段 | Dictionary<string, object> | 否 |
| customIDUserProperties | 自定义ID用户属性值，跟用户在后台设置的使用自定义ID用户属性值匹配对应,可选字段 | Dictionary<string, object> | 否 |
| customIDEventProperties | 自定义ID设备属性值，跟用户在后台设置的使用自定义ID设备属性值匹配对应,可选字段 | Dictionary<string, object> | 否 |
mergeType(合并策略)介绍
| 参数名称 | 参数含义 |
| SERCMergeTypeUser | app首次启动或版本更新时, 使用服务端配置跟用户默认配置合并，此方法可以清除本地缓存配置 |
| SERCMergeTypeDefault | 使用服务端配置跟用户本地已有缓存配置合并，参数下发SDK默认合并策略 |
注：开发者使用参数下发SDK需要通过API预置一份默认配置配置到App中，SDK使用该默认配置用来兜底，具体方法参考设置默认配置
调用示例
SEConfig seConfig = new SEConfig();
seConfig.logEnabled = true;
seConfig.customUrl = "开发者自定义url";
seConfig.isGDPRArea = true;
seConfig.isDebugModel = true;
RCConfig rcConfig = new RCConfig();
rcConfig.enable = true;
rcConfig.mergeType = SERCMergeType.SERCMergeTypeUser;
Dictionary<string, object> customIDProperties = new Dictionary<string, object>();
customIDProperties.Add("id_key1", "id_value1");
customIDProperties.Add("id_key2", "id_value2");
rcConfig.customIDProperties = customIDProperties;
Dictionary<string, object> customIDEventProperties = new Dictionary<string, object>();
customIDEventProperties.Add("event_key1", "event_value1");
customIDEventProperties.Add("event_key2", "event_value2");
rcConfig.customIDEventProperties = customIDEventProperties;
Dictionary<string, object> customIDUserProperties = new Dictionary<string, object>();
customIDUserProperties.Add("user_key1", "user_value1");
customIDUserProperties.Add("user_key2", "user_value2");
rcConfig.customIDUserProperties = customIDUserProperties;
Dictionary<string, object> customIDDeviceProperties = new Dictionary<string, object>();
customIDDeviceProperties.Add("device_key1", "device_value1");
customIDDeviceProperties.Add("device_key2", "device_value2");
rcConfig.customIDDeviceProperties = customIDDeviceProperties;
SolarEngine.Analytics.initSeSdk("开发者申请的appkey",seConfig, rcConfig);2. 设置默认配置
参数下发SDK需要开发者预置一份默认配置到用户app中，方便参数下发SDK使用此默认配置进行兜底操作
方法示例
public void SetRemoteDefaultConfig(Dictionary<string, object>[] defaultConfig)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| defaultConfig | 默认配置 | Dictionary<string, object>[] | 是 |
调用示例
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
Dictionary<string, object> defaultConfigInt = new Dictionary<string, object>();
defaultConfigInt.Add("name", "int_test");
defaultConfigInt.Add("value", 2023);
defaultConfigInt.Add("type", 2);
Dictionary<string, object> defaultConfigString = new Dictionary<string, object>();
defaultConfigString.Add("name", "string_test");
defaultConfigString.Add("value", "string_value");
defaultConfigString.Add("type", 1);
Dictionary<string, object> defaultConfigBool = new Dictionary<string, object>();
defaultConfigBool.Add("name", "bool_test");
defaultConfigBool.Add("value", false);
defaultConfigBool.Add("type", 3);
Dictionary<string, object>[] defaultConfigArray = new Dictionary<string, object>[]{defaultConfigInt, defaultConfigString, defaultConfigBool};
remoteConfig.SetRemoteDefaultConfig(defaultConfigArray);3. 设置事件自定义属性
开发者可以为事件设置自定义属性，参数下发SDK在请求服务端配置时会带上该属性，用于服务端参数匹配
方法示例
public void SetRemoteConfigEventProperties(Dictionary<string, object> properties)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| properties | 事件自定义属性 | Dictionary<string, object> | 是 |
调用示例
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
Dictionary<string, object> eventProperties = new Dictionary<string, object>();
eventProperties.Add("event_pro1", "event_value1");
eventProperties.Add("event_pro2", "event_value2");
remoteConfig.SetRemoteConfigEventProperties(eventProperties);
注：给事件设置的自定义属性不支持开发者传入"_"下划线开头的key值，SDK会默认丢弃该条属性
4. 设置用户自定义属性
开发者可以为用户设置自定义属性，参数下发SDK在请求服务端配置时会带上该属性，用于服务端参数匹配
方法示例
public void SetRemoteConfigUserProperties(Dictionary<string, object> properties)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| properties | 用户自定义属性 | Dictionary<string, object> | 是 |
调用示例
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
Dictionary<string, object> userProperties = new Dictionary<string, object>();
userProperties.Add("user_pro1", "user_value1");
userProperties.Add("user_pro2", "user_value2");
remoteConfig.SetRemoteConfigUserProperties(userProperties);
注：给用户设置的自定义属性不支持开发者传入"_"下划线开头的key值，SDK会默认丢弃该条属性
5. 获取参数下发配置
参数下发SDK获取参数下发配置分为两种情况，一种是同步获取方法，通过此方法开发者可以直接获取返回结果。另一种是异步获取方法，返回结果需要等待回调完成才可以获取
注：通过同步或异步方式获取参数时，sdk 会触发上报用户命中试验的事件，所以获取参数的时机应该在用户到达试验场景时读取（获取参数代表用户到达试验场景，用户命中该参数对应的试验），请勿提前读取参数
5.1 同步获取参数下发配置
方法示例
public string FastFetchRemoteConfig(string key)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| key | 参数下发key，跟用户在后台配置参数key对应 | string | 是 |
返回值:返回key对应的value值，类型为string
调用示例
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
//获取参数下发的方法返回值为string类型，需要开发者根据自己的业务配置进行属性转换，此处以bool类型为例
string result = remoteConfig.FastFetchRemoteConfig("key");
bool boolResult = bool.Parse(result);5.2 同步获取所有参数下发配置
方法示例
public Dictionary<string, object> FastFetchRemoteConfig()返回值:返回所有参数下发配置的值，类型为Dictionary<string, object>
调用示例
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
Dictionary<string,object> result = remoteConfig.FastFetchRemoteConfig()5.3 异步获取参数下发配置
方法示例
public void AsyncFetchRemoteConfig(string key, FetchRemoteConfigCallback callback)参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| key | 参数下发key，跟用户在后台配置参数key对应 | string | 是 |
| callback | 参数下发异步回调 | FetchRemoteConfigCallback | 是 |
调用示例
private void onFetchRemoteConfigCallback(string result) {
//异步获取参数下发的回调为string类型，需要开发者根据自己的业务配置进行属性转换，此处以bool类型为例
bool boolResult = bool.Parse(result);
}
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
remoteConfig.AsyncFetchRemoteConfig("key", onFetchRemoteConfigCallback);5.4 异步获取所有参数下发配置
方法示例
public void AsyncFetchRemoteConfig(FetchAllRemoteConfigCallback callback)
参数说明
| 参数名称 | 参数含义 | 参数类型 | 是否必传 |
| callback | 参数下发异步回调 | FetchAllRemoteConfigCallback | 是 |
调用示例
private void onFetchAllRemoteConfigCallback(Dictionary<string, object> result) {
//result:异步获取到的所有在线参数配置
}
SESDKRemoteConfig remoteConfig = new SESDKRemoteConfig();
remoteConfig.AsyncFetchRemoteConfig(onFetchAllRemoteConfigCallback);SDK 更新记录
2024-11-21 1.2.9.2
基于Android 1.2.9.1 iOS 1.2.9.2
2024-11-07 1.2.9.1
基于Android 1.2.9.1 iOS 1.2.9.1
2024-9-23 1.2.8.3
基于Android 1.2.8.3 iOS 1.2.8.2
•Android：优化在线参数逻辑
2024-2-4 1.2.7.0
基于Android 1.2.7.0 iOS 1.2.7.0
•Android：优化在线参数分流逻辑
2023-12-28 1.2.6.1
基于Android 1.2.6.1 iOS 1.2.6.1
•Android：优化在线参数SDK获取所有参数回调方法
2023-12-14 1.2.6.0
基于Android 1.2.6.0 iOS 1.2.6.0
•iOS&Android：在线参数SDK支持同步获取所有在线参数配置
•iOS&Android：在线参数SDK支持异步获取所有在线参数配置
2023-04-26 1.0.3.0
基于Android 1.0.3.0 iOS 1.0.3.0
- iOS&Android：SDK日志功能优化
2023-03-30 1.0.2.0
基于Android 1.0.2.0 iOS 1.0.2.0
- iOS&Android：优化、兼容debug模式
2023-03-29 1.0.1.2
基于Android 1.0.1.2 iOS 1.0.1.0
- Android：参数下发模块功能优化
2023-03-23 1.0.1.1
基于Android 1.0.0.1 iOS 1.0.0.1
- Android：优化参数下发模块数据格式
2023-03-20 1.0.1.0
基于Android 1.0.1.0 iOS 1.0.1.0
- iOS&Android：参数下发模块支持AB测试功能
2023-03-10 1.0.0.1
基于Android 1.0.0.1 iOS 1.0.0.1
- iOS&Android：参数下发添加日志打点
2023-02-08 1.0.0.0
基于Android 1.0.0.0 iOS 1.0.0.0
- iOS&Android：参数下发SDK初版
;}.cls-2{fill:%230868f7;}.cls-3{fill:url(%23未命名的渐变_44);}.cls-4{fill:%23333;}%3c/style%3e%3clinearGradient%20id='未命名的渐变_8'%20x1='33.73'%20y1='100.61'%20x2='-0.03'%20y2='-1.06'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%237ae9fb'/%3e%3cstop%20offset='0.67'%20stop-color='%232b90f8'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3clinearGradient%20id='未命名的渐变_44'%20x1='27.86'%20y1='18.67'%20x2='68.36'%20y2='22.22'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%235ac7f2'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3c/defs%3e%3cpath%20class='cls-1'%20d='M29,28.74V81.91l-9.51-3.68v0L8.52,74A7.17,7.17,0,0,1,4,67.32V24.54A3.76,3.76,0,0,1,9.08,21Z'/%3e%3cpath%20class='cls-2'%20d='M68.09,78.07a13.15,13.15,0,0,1-17.9,12.06L29,81.91h0V28.74L50.19,37A13.17,13.17,0,0,0,68.08,25.3h0Z'/%3e%3cpath%20class='cls-3'%20d='M68.08,25.3a13.19,13.19,0,0,1-6.73,10.87A13.09,13.09,0,0,1,50.19,37L29,28.74V6A3.76,3.76,0,0,1,34.1,2.52l25.59,9.91A13.22,13.22,0,0,1,68.08,25.3Z'/%3e%3cpath%20class='cls-4'%20d='M129.06,81.76a4.33,4.33,0,0,1-3.19-1.31,4.4,4.4,0,0,1-1.31-3.24V56.86H97.65V77.21a4.36,4.36,0,0,1-1.35,3.2A4.68,4.68,0,0,1,93,81.76a4.32,4.32,0,0,1-3.19-1.31,4.37,4.37,0,0,1-1.32-3.24V27.27A4.58,4.58,0,0,1,89.83,24a4.59,4.59,0,0,1,7.82,3.27V48.15h26.91V27.27A4.58,4.58,0,0,1,125.91,24a4.59,4.59,0,0,1,7.82,3.27V77.21a4.37,4.37,0,0,1-1.36,3.2A4.65,4.65,0,0,1,129.06,81.76Z'/%3e%3cpath%20class='cls-4'%20d='M163.77,81.66c-6.57,0-11.76-1.92-15.44-5.7s-5.54-9.07-5.54-15.74a26.76,26.76,0,0,1,2.09-10.43,17.72,17.72,0,0,1,6.67-8.06,19.15,19.15,0,0,1,10.68-2.95,19,19,0,0,1,10.46,2.8,18.7,18.7,0,0,1,6.55,7.36,22.53,22.53,0,0,1,2.36,10.28A4.51,4.51,0,0,1,177,63.77H152.23a10.8,10.8,0,0,0,3.49,6.65c2,1.68,4.88,2.52,8.66,2.52a22.25,22.25,0,0,0,7.54-1.21c.74-.3,1.55-.67,2.37-1.07a3.75,3.75,0,0,1,1.84-.4,4.09,4.09,0,0,1,3,1.15,4,4,0,0,1,1.12,3,4.38,4.38,0,0,1-2.58,3.82,32.34,32.34,0,0,1-6.36,2.61A28.67,28.67,0,0,1,163.77,81.66ZM172.4,55.9a9.72,9.72,0,0,0-1.63-4.56A9.9,9.9,0,0,0,167,48a10.38,10.38,0,0,0-4.64-1.14,12,12,0,0,0-4.77,1.06,9.54,9.54,0,0,0-4.89,5.66,11.78,11.78,0,0,0-.51,2.3Z'/%3e%3cpath%20class='cls-4'%20d='M193,81.64a4.49,4.49,0,0,1-4.51-4.55V27.28A4.58,4.58,0,0,1,189.84,24a4.48,4.48,0,0,1,3.28-1.36A4.36,4.36,0,0,1,196.35,24a4.46,4.46,0,0,1,1.31,3.31V77.09a4.34,4.34,0,0,1-1.35,3.2A4.67,4.67,0,0,1,193,81.64Z'/%3e%3cpath%20class='cls-4'%20d='M263.79,81.71a5.7,5.7,0,0,1-4.2-1.74,5.76,5.76,0,0,1-1.73-4.19V27.37a4.58,4.58,0,0,1,1.35-3.27A4.59,4.59,0,0,1,267,27.37V72.53h24a4.58,4.58,0,0,1,3.27,7.82A4.66,4.66,0,0,1,291,81.71Z'/%3e%3cpath%20class='cls-4'%20d='M424.48,81.74a4.71,4.71,0,0,1-2.71-.88,5.43,5.43,0,0,1-1-1l-.07-.09-12.41-17-5.41,5v9.44a4.31,4.31,0,0,1-1.36,3.19,4.66,4.66,0,0,1-3.3,1.36A4.29,4.29,0,0,1,395,80.42a4.36,4.36,0,0,1-1.32-3.23V27.37A4.58,4.58,0,0,1,395,24.1a4.52,4.52,0,0,1,6.58.12,4.54,4.54,0,0,1,1.24,3.15V56.31l17.72-16.38.05,0a4.8,4.8,0,0,1,2.94-1.11,4.4,4.4,0,0,1,3.27,1.2,4.57,4.57,0,0,1,1.2,3.27,4.44,4.44,0,0,1-.77,2.33,7.45,7.45,0,0,1-1.43,1.65l-11,9.64,13.34,17.68a5,5,0,0,1,1,2.71,4.12,4.12,0,0,1-1.36,3.24A4.64,4.64,0,0,1,424.48,81.74Z'/%3e%3cpath%20class='cls-4'%20d='M317.93,81.76a21.5,21.5,0,1,1,21.17-21.5A21.37,21.37,0,0,1,317.93,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,317.93,47.66Z'/%3e%3cpath%20class='cls-4'%20d='M212.18,101.22a4.12,4.12,0,0,1-3.05-1.26,4.17,4.17,0,0,1-1.26-3.1V43.34a4.37,4.37,0,0,1,1.3-3.14,4.26,4.26,0,0,1,3.13-1.3,4.19,4.19,0,0,1,3.1,1.26,4.32,4.32,0,0,1,1.26,3.16,20.77,20.77,0,0,1,13-4.54,21.51,21.51,0,0,1,0,43,20.51,20.51,0,0,1-13-4.57V96.86a4.15,4.15,0,0,1-1.3,3.06A4.5,4.5,0,0,1,212.18,101.22Zm17.43-53.63c-6.23,0-12.93,4.11-12.93,12.72a12.73,12.73,0,0,0,25.46,0A12.71,12.71,0,0,0,229.61,47.59Z'/%3e%3cpath%20class='cls-4'%20d='M365.76,81.76a21.5,21.5,0,1,1,21.18-21.5A21.37,21.37,0,0,1,365.76,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,365.76,47.66Z'/%3e%3c/svg%3e)