JS
最新版本:v1.3.0
更新时间:2026-07-24
资源下载:下载
1. 概述
从 AE 4.4 版本开始,运营模块上线了“配置中心”功能,支持在 AE 后台添加功能参数配置,通过客户端 SDK 拉取至App,精细化定制您与玩家的互动内容。
本文介绍客户端 SDK 的集成过程,客户端只需要关注与数数 SDK 的交互即可,不需要关心 AE 后台的任务细节。
2. 集成
2.1 手动集成 SDK
配置中心需要依赖以下数数 SDK:
| SDK名称 | 介绍 | 版本要求 |
|---|---|---|
| TDAnalytics | 实现数据采集与处理 | >= 2.1.0 |
| TDRemoteconfig | 拉取 AE 后台的配置信息 | >= 1.1.0 |
| TDCore | 提供统一初始化能力 | >= 1.1.0 |
- 点击页面上方资源下载链接,下载 SDK 并解压
- 将
tdcore.umd.min.js、thinkingdata.umd.min.js、tdremoteconfig.umd.min.js拖入 项目同一目录下
3. 初始化
切换当前集成方式后,SDK初始化使用TDApp 实例,其他数据采集和上报使用 window.thinkingdata实例。
<script src="./thinkingdata.umd.min.js"></script>
<script src="./tdcore.umd.min.js"></script>
<script src="./tdremoteconfig.umd.min.js"></script>
TDApp.init({
appId: "AppId",
serverUrl:"ServerUrl",
enableLog:true
});
4. 使用
4.1 数据结构样例
"configId" : {
"templateId" : [
{
"#strategy_id" : "f712dff93afb1e79caefdf094bda4ba2",
"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" : ""
}
]
}
}
直接设置
TDRemoteConfig.setDefaultValues({
"configId":{
"templateId":{
"paramater_x":""
}
}
});
清空默认值
TDRemoteConfig.clearDefaultValues()
4.3 获取值
获取配置项下某一类已经发布上线中的策略内容:
let array = TDRemoteConfig.getData().get("configId").get("templateId").arrayValue();
其中:
configId:在智能运营配置中心设置的“配置项ID”。配置项说明详见配置项管理
templateId:在智能运营配置中心“配置项”下设置的“模版ID”。配置模板说明详见配置模板管理
取值规则
某一个key 的取值过程:
- 优先取该 key 对应的远端配置的值
- 若远端没有配置该 key,则去查找该 key 的本地默认值
- 若本地默认值也没有该 key,返回空。
4.4 监听更新
SDK 初始化之前,添加对配置拉取成功的通知监听
TDRemoteConfig.addConfigFetchListener((status)=>{
});
通知携带的参数
通知将默认携带本次请求和上次请求期间,变更为暂停生效(suspend)、强制下线(force_offline)的策略状态,您可结合业务需求取用。若无需使用,可直接忽略。
使用以下方式获取通知参数
let map = statusData["strategy_status_map"];
kTDRemoteConfigStrategyStatusMap 对应的 value 结构如下,用来描述配置项模版中策略id为 20241209 的策略状态 。
{
"configId" : {
"templateId" : {
"20241209" : "suspend"
}
}
}
5. 发送测试
为了快速的验证接入的可用性,与配置策略的有效性,SDK 支持开启测试模式。
TDApp.init({
appId: "AppId",
serverUrl:"ServerUrl",
enableLog:true,
mode:"debug"
});
客户端开启 debug 模式后,会每 5s 拉取一次测试策略。在 AE 运营模块可以创建模版测试或者策略测试,等待配置拉取的过程中,可以关注前端页面的进度节点。
参考操作文档 配置模板管理 中的客户端发送测试部分。
客户端SDK发送测试需要使用测试设备,您可在测试设备列表中选择或添加测试设备。

