Unreal
最新版本：v1.0.0
更新时间：2025-01-09
资源下载：下载
Beta版本：无
1. 概述
从 AE 4.4 版本开始，运营模块上线了“配置中心”功能，支持在 AE 后台添加功能参数配置，通过客户端 SDK 拉取至App，精细化定制您与玩家的互动内容。
本文介绍客户端SDK的集成过程，App 端只需要关注与数数 SDK 的交互即可，不需要关心 AE 后台配置细节。
2. 集成 SDK
客户端触发式任务需要依赖以下数数 SDK：
| SDK 名称 | 功能介绍 | 版本要求 |
|---|---|---|
| TDAnalytics | 实现数据采集与处理 | >= 2.1.0 |
| TDRemoteConfig | 拉取 AE 后台的配置信息 | >= 1.0.0 |
2.1 集成插件
下载 Unreal SDK，解压后将TDAnalytics、TDRemoteConfig 放入您项目的Plugins目录； 如果 Plugins 目录不存在，首先在项目根目录下创建 Plugins 目录，然后将这两个插件放入其中。
2.2 激活插件
-
重启 Unreal Editor
-
打开 编辑 > 插件，在项目
TDAnalyticsTDRemoteConfig类别下，启用TDAnalyticsTDRemoteConfig -
打开 编辑>项目设置，在插件类别下，设置
TDAnalyticsTDRemoteConfig参数：- Server Url: 必填。接收端地址，需使用 https 类型的地址
- App ID: 必填。您项目的 APP ID，在 AE 后台项目管理页可以查看
- Enable Log：是否开启调试日志
-
在
Config目录下的DefaultEngine.ini文件中添加以下内容:[Analytics]ProviderModuleName=TDAnalytics -
如果您希望直接在 C++ 代码中使用，需要在您项目的
*.Build.cs文件中添加以下内容：PrivateDependencyModuleNames.AddRange(new string[] { "TDAnalytics","TDRemoteConfig" });PrivateIncludePathModuleNames.AddRange(new string[] { "TDAnalytics","TDRemoteConfig" });
3. 初始化
在主线程初始化 SDK
#include "TDAnalytics.h"
#include "TDRemoteConfig.h"
//初始化SDK
UTDAnalytics::Initialize();
UTDRemoteConfig::Initialize();
4. 使用
4.1 数据结构样例
"configId" : {
"templateId" : [
{
"#strategy_id" : "2024121001",
"paramater_x" : "1111",
"#ops_receipt_properties" : {}
}
],
"#custom_params" : {
}
}
其中：
configId：在运营后台配置中心模块创建的“配置项ID”，用于标识业务模块信息。配置项说明详见配置项管理
templateId：业务在“配置项”下添加的“模版ID”，用于标识具体的功能模块信息。配置模板说明详见配置模板管理
#strategy_id：策略的唯一ID，用于策略生命周期管理。配置策略说明见配置策略管理
paramater_x：配置模板参数，对应功能模块所需的配置参数
#ops_receipt_properties：用于事件回收统计，当你需要自动统计策略效果（暂未支持）时，回收事件需要携带此属性
#custom_params：客户端配置通道上的自定义参数，可定义需要携带到客户端的用户属性信息。
4.2 设置本地默认值
您可以在 TDRemoteConfig SDK 中设置配置项默认值，在 AE 服务端未添加配置项、或者本地未拉取到远端值时，SDK 会获取到本地默认值。
格式
本地默认值的结构需要保持以下格式：
{
"configId": {
"templateId": [
{
"paramater_x" : ""
}
]
}
}
直接设置
UTDRemoteConfig::SetDefaultValues("{\"key1\":\"value1\"}");
清空默认值
UTDRemoteConfig::ClearDefaultValues();
4.3 获取值的方式
获取配置项下某一类已经发布上线中的策略内容：
FString str = UTDRemoteConfig::GetAllData(TEXT("configId_xxx"),TEXT("template_xxx"));
其中：
configId：在运营后台配置中心模块创建的“配置项ID”，用于标识业务模块信息。配置项说明详见配置项管理
templateId：业务在“配置项”下添加的“模版ID”，用于标识具体的功能模块信息。配置模板说明详见配置模板管理
取值规则
某一个key 的取值过程：
- 优先取该 key 对应的远端配置的值
- 若远端没有配置该 key，则去查找该 key 的本地默认值
- 若本地默认值也没有该 key，返回空。
5. 发送测试
为了快速的验证接入的可用性，与配置策略的有效性，SDK 支持开启测试模式。
客户端开启 debug 模式后，会每 5s 拉取一次测试策略。在 AE 运营模块可以创建模版测试或者策略测试，等待拉取配置的过程中，可以关注前端页面的进度节点。
参考操作文档 配置模板管理 中的客户端发送测试部分。
客户端SDK发送测试需要使用测试设备，您可在测试设备列表中选择或添加测试设备。