进阶指南

最近更新 2026/09/16

1. 初始化参数

Cocos Creator 通过 TDRemoteConfig.init 传入配置。Web / 小游戏走 JS 通道；Android / iOS / HarmonyOS 原生包体会把参数桥接到原生 TDRemoteConfig。

1.1 配置项

属性名	类型	说明
appId	String	在 AE 后台创建的项目的 app id，必填
serverUrl	String	在 AE 后台创建的项目的 server url，必填
debugMode	String	SDK 运行模式，见 1.2。原生通道只识别 'debug'
enableLog	Boolean	是否开启日志打印。只控制日志，不会进入测试模式
templateCode	String	模板编码，可选
customFetchParams	Object	初始化时携带的自定义 Fetch 参数，可选

TDRemoteConfig.init({
  appId: 'YOUR-APP-ID',
  serverUrl: 'https://your-server-url',
  enableLog: true,
  debugMode: 'debug',
  customFetchParams: { channel: 'cocos' }
});

1.2 SDK 运行模式

取值	说明
不传 / 其他值	正常模式。按线上策略拉取配置并入库。
debug	测试模式。设备需添加到 AE 控制台的测试设备列表。客户端会按较短间隔拉取测试策略，便于在 AE 运营模块验证模版测试或策略测试。
debugOnly	仅 Web / 小游戏 JS 通道支持。原生 Android / iOS / HarmonyOS 不识别该值，效果等同正常模式。

2. 自定义拉取时机

2.1 自动拉取

在以下场景，SDK 会自动拉取远端配置数据。

Web / 小游戏（JS 通道）

• SDK 初始化成功后
• 应用前后台切换，且距上次拉取超过 6 小时
• TDAnalytics SDK 账号系统发生了变更，例如 login、logout

Android / iOS / HarmonyOS（原生通道）

初始化后由原生 TDRemoteConfig 自动拉取，并跟随 App 生命周期与账号变更。请先初始化分析 SDK，再初始化配置中心，账号变更才能同步到配置拉取。

2.2 手动拉取

手动调用 SDK 方法，随时拉取远端配置。原生通道会转发到 TDRemoteConfigProxyApi。

TDRemoteConfig.fetch();
// 多实例时可指定 appId / templateCode
TDRemoteConfig.fetch(appId, templateCode);

该 API 内部有频控限制，避免频繁拉取。

3. 自定义 Fetch 参数

Fetch 参数为客户端 SDK 请求 AE 服务端取值时可用的参数。您可自定义 Fetch 参数，将参数添加为配置通道的环境参数，即可在配置策略时使用 Fetch 参数自定义目标受众。

3.1 添加

TDRemoteConfig.setCustomFetchParams({
  demo_param: 'from_demo'
}, appId);

3.2 删除

根据指定的 key 进行删除

TDRemoteConfig.removeCustomFetchParam('demo_param', appId);

4. Client Params

v1.3.1 起，Cocos Creator 支持 Client Params。与 Fetch 参数类似，客户端参数也可参与远端策略匹配；区别是参数保存在客户端本地，并由 SDK 在请求时带上。Android / iOS / HarmonyOS 原生桥已同步。

TDRemoteConfig.addClientParams({
  client_tag: 'demo',
  client_count: 1
});
TDRemoteConfig.removeClientParam('client_tag');
TDRemoteConfig.accumulateNum('client_count', 1);
const tag = TDRemoteConfig.getClientParamValueForKey('client_tag');
const all = TDRemoteConfig.getClientParams();