integrationlatest接入文档 / Unreal
Unreal
提示
目前支持 Android和iOS平台。
最新版本:v1.0.0
更新时间:2025-01-09
资源下载:下载
Beta版本:无
1. 概述
从 AE 4.4 版本开始,运营模块上线了“客户端触发式任务”功能,支持端内新用户注册、创角等场景中的毫秒级触发需求,并支持实时 A/B 分流。客户端侧由数数 SDK 来实现与 AE 后端的通信,完成任务的拉取与计算。
在 App 端需要集成数数 SDK。App 端只需要关注与数数 SDK 的交互即可,不需要关心 AE 后台的任务细节。
2. 集成SDK
客户端触发式任务需要依赖以下数数 SDK:
| SDK 名称 | 功能介绍 | 版本要求 |
|---|---|---|
| TDAnalytics | 实现数据采集与处理 | >= 2.1.0 |
| TDRemoteConfig | 拉取 AE 后台的配置信息 | >= 1.0.0 |
| TDStrategy | 提供客户端触发式能力 | >=1.0.0 |
2.1 集成插件
下载 Unreal SDK,解压后将TDAnalytics TDRemoteConfig TDStrategy放入您项目的Plugins目录; 如果 Plugins 目录不存在,首先在项目根目录下创建 Plugins 目录,然后将这三个插件放入其中。
2.2 激活插件
-
重启 Unreal Editor
-
打开 编辑 > 插件,在项目
TDAnalyticsTDRemoteConfigTDStrategy类别下,启用TDAnalyticsTDRemoteConfigTDStrategy -
打开 编辑 > 项目设置,在插件类别下,设置
TDAnalyticsTDRemoteConfigTDStrategy参数:- 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","TDStrategy" });
PrivateIncludePathModuleNames.AddRange(new string[] { "TDAnalytics","TDRemoteConfig","TDStrategy" });
3. 初始化
初始化 SDK
#include "TDAnalytics.h"
#include "TDRemoteConfig.h"
#include "TDStrategy.h"
//初始化SDK
UTDAnalytics::Initialize();
UTDRemoteConfig::Initialize();
UTDStrategy::Initialize();
4. 设置回调监听
初始化 SDK 成功后,给 TDStrategy SDK 设置一个回调监听。
void OnTriggerResult(FString str){
}
UTDStrategy::SetTriggerListener(OnTriggerResult);
4.1 回调的数据模型
属性说明
| 属性名 | 类型 | 说明 |
|---|---|---|
| channelMsgType | String | 通道消息类型 |
| appId | String | 您的 AE 项目的 app id |
| pushId | String | 运营任务的通道发送 ID |
| taskId | String | 运营任务的 ID |
| content | JSONObject | 运营任务的推送内容 |
| userParams | JSONObject | 客户端通道中的自定义参数 |
| opsProperties | JSONObject | 客户端触发任务携带的通道信息,用于触达漏斗事件的回执参数。 |
这篇文档对你有帮助吗?

