配置模板
配置模板用于承载业务功能参数,您可在配置项下创建一个或多个配置模板,使用场景如:
- 为应用内站内信配置项创建承载站内信功能参数的模板
- 活动中心配置,创建多个模板承载不同的活动形式
- 同一业务功能在不同平台功能参数设计存在不同,通过创建多个模板对接多平台配置下发
- 站点类配置项,涉及多个资源位的接入,使用多个模板承接不同资源位
创建配置模板
- 模板名称:模板的显示名,如公告、连续登录奖励、累充奖励等
- 模板ID:模板的唯一标识,用于配置获取。模板ID将随配置策略下发,用于标识策略所属具体的子功能。创建后,模板 ID 不支持修改。技术对接详情见配置中心技术接入文档。
- 备注(选填):描述模板使用的业务场景等。
添加模板参数
模板参数即下游业务可解析的功能参数。如游戏内公告的模板参数示例:
| 参数名 | 类型 | 是否必填 | 含义 |
|---|---|---|---|
| title | 字符串 | 是 | 公告标题 |
| content | 字符串 | 是 | 公告内容 |
| begintime | 数值 | 是 | 公告生效时间 |
| expiretime | 数值 | 是 | 过期时长,单位:秒 |
每个配置项拥有独立的参数命名空间(i.e.配置项下参数名唯一,不同配置项下参数名可重复)。配置项层级的参数可在多个模板中使用。
方式一: 新建创建
进入模板参数编辑页面,可从右侧配置项参数列表中直接选择已添加的参数。
若需新增参数,可点击右上方[+],新建参数。新建后,可添加至模板中使用。
方式二:导入 JSON 文件创建
在创建配置项模板参数时,对于新的业务模块,您可以在 AE 系统中手动添加参数,但是对于已有业务模块来说,若您系统内已经有了完善的配置表或者 json 文件,也可以通过导入 json 文件的方式直接创建配置项模板。
在模板编辑页右侧的「可选参数」栏,点击搜索框旁的上传图标(悬停提示「导入参数」),并上传您需要解析的 json 文件。
选择导入方式
- 替换导入:将自动弃用该模板内所有已选用参数,重新选用 json 文件解析出的新参数,并在系统内保存新参数。
- 增量导入:保留该模板内所有已选用参数(数据类型也以原有参数为准),添加 json 文件解析出的增量新参数,并在系统内保存新参数。
注: 如果用户是创建了一个新的空模板,则导入时,无论选择「替换导入」还是「增量导入」,则都会全量导入所有已选参数。
参数类型解析规则
- 若为空字符串
"",文字,或字母,则类型为 String - 若识别到 true/false,则类型为 Boolean(注:0,1 会识别成数字,您可修改类型)
- 若识别到 数字,则类型为 Number
- 正则表达式识别 日期
- 正则表达式识别 时间
- 若识别到
[],则类型为数组 - 若识别到 { },则类型为对象
- 导入时暂不识别为 json 格式
- 导入时不支持识别 “枚举” 类型
- 另,数组下嵌套层级识别规则与上述一致
可能存在的解析失败原因:
- JSON格式错误:JSON 数据必须符合严格的语法规则,包括正确的括号匹配、引号使用等。JSON 格式错误,无法正确解析数据。
- 数据类型错误:JSON中的值必须是有效的数据类型,如字符串、数字、布尔值、数组、对象或 null。数据类型不正确,无法正确解析数据。
- JSON 数据缺失:JSON 数据中某些属性缺失,可能无法正确解析该数据。
- 编码问题:JSON 数据可能会遇到编码问题,特别是当数据包含非 ASCII 字符时。确保解析 JSON 数据时使用相同的字符编码。
确认模板参数结构
- 参数名:为 JSON 解析出的参数名称
- 显示名:默认填入相同的参数名作为显示名,您可自行修改。
- 参数类型:为推断解析所得,您可自行修改。
- 是否必填:默认解析出的所有参数都 是 必填,您可自行修改。
- 提示文案:默认为空
保存参数并编辑模板
导入成功后跳转至「模板管理」页面,您可二次编辑并保存模板。
参数管理详见配置参数管理。
模板发送测试
在模板参数准备完毕 并为配置项绑定获取方式 后,可对配置模板进行发送测试,检查接入通道和内容格式是否正常。
通道的接入方式详见配置通道设置。
测试目标和范围
配置中心的提供游戏内容配置,一般需要经过严格的测试流程后对外发布。因此,配置中心支持 配置模板发送测试、策略发送测试。其中模板和策略测试包括上线、暂停、下线全流程的测试,通道测试可与模板测试一起测试(通道与配置项绑定才有具体的发送内容)
模板测试时机
| 测试 | 状态细分 | 说明 |
|---|---|---|
模板 | 开启、关闭均可测试 |
|
模板测试方法
Webhook 模板测试
测试流程:
在操作列表中点击 「发送测试」,即可进入发送测试界面。
可选择 正式环境 or 测试环境 进行测试(仅在添加了测试地址时,可点击使用测试环境)。
选择测试账号
- 正式环境:测试账号必填;测试环境:测试账号选填
- 测试账号从「白名单」中选择,支持多选,最多10个。
客户端模板测试
测试流程:
在操作列表中点击 「发送测试」,即可进入发送测试界面。
您需要在测试设备端打开 debug 模式。
在选择完测试设备,并填入模板参数内容后,点击“确认发送”即可发起测试任务。
您可以选择只测试「上线」,也可以选择测试「上线 - 下线」或者「上线-暂停-下线」的全链路。
客户端模板发送测试内容
客户端配置项模板进行测试时,系统会自动生成一个“测试策略”,并在测试完成后自动下线此策略。
| 模块 | 发送测试处理 | 备注 |
|---|---|---|
| 通道 | 发送测试会携带 通道自定义参数 | |
| 目标环境条件 | 模板发送测试不测环境条件 | |
| 目标用户 | 默认测试 全部用户 | |
| 配置内容 | 模板参数内容(参数结构和值) 按发送测试时用户填入的内容下发,有必填校验 | |
| 上线时间 | 为 点击发送测试的时间 | |
| 下线时间 | 默认为 永久 | 页面点击完成测试、点击取消测试时删除测试策略 |
模板状态管理
配置模板默认为关闭状态,在测试过确认配置模板可正常使用后,可开启模板。
开启后,具有配置策略创建权限的用户可在「我的策略」中创建并发布具体的内容策略。
为保证策略的稳定运行,若您需要增加或修改模板参数,需先关闭模板,再执行编辑操作。当关闭模板会影响策略状态时,无法操作关闭。
模板 JSON 结构
为方便您校验和检查配置完成的模板参数结构是否符合线上业务参数结构的要求,在模板编辑页面和模板列表页面,都支持查看模板 JSON 结构体,并支持下载。

