OCPX关键行为上报指南
接入前必读说明
在进行任何技术对接或代码开发前,必须完成以下操作:
- 由广告投放团队(或运营 / 投放人员)登录【启明广告投放平台】,创建 "API 转化跟踪" 配置。
- 此步骤是实现关键行为回传的核心前提,未完成配置将导致后续数据回传失败。
注意:如何创建 API 转化跟踪?请参考文档:《小游戏转化跟踪上报及前期配置说明》
功能描述
该接口由客户端通过集成的SDK调用,用于上报用户在小游戏或应用内完成的关键行为事件(如付费、按钮点击等)。SDK将事件信息传递至客户端,由客户端触发上报流程,最终通过服务端完成向启明平台的数据回传。
转化跟踪回传支持两种方式,您可根据业务需求选择:
- SDK 回传方式:reportOcpxKeyAction
- 服务端回传方式:keyBehaviorsReport
注意:两种方式的差异说明(如适用场景、技术链路等),请参考文档:《小游戏转化跟踪上报及前期配置说明》。
回传使用场景及说明
SDK回传使用场景及说明
- 使用场景:用户完成指定关键行为时(如支付成功、点击激励视频按钮、页面跳转等),由客户端通过SDK发起回传。
- 使用流程:
- 当用户触发关键行为时,调用SDK上报OCPX接口,上报 eventType
- SDK将事件信息发送至服务端,由服务端确认当前uuid在该appid下是否存在biz_id。
- 若存在biz_id则直接上报,若不存在biz_id则返回错误。
- 启明平台接收并验证数据,计入转化统计。
服务端回传使用场景及说明
- 使用场景:用户完成关键行为后,由游戏服务端发起回传,一般用于较为复杂的判断关键行为,且判断结果时玩家不一定在游戏中时。
- 使用流程:
- 当用户触发关键行为时,调用服务端OCPX上报接口。上报eventType,uuid,appid,biz_id(注意,biz_id请自行从广告监测链接中提起)
- 服务端接收事件,校验 uuid+appid 对应的 biz_id 是否存在且与服务端中记录的信息一致。
- 若校验一致性通过则直接上报,若校验一致性不通过则返回错误。
- 启明平台接收并验证数据,计入转化统计。
注意:本接口不直接回传至启明,仅为客户端向自身服务端发起事件通知。
✅ 支持事件类型:5(付费)、6(PV)、7(按钮点击)、8(页面跳转)
注意:若eventType为付费则额外需要上报金额。
关键事件ID与自定义说明
| eventType | 中文名称 |
|---|---|
| 5 | 付费 |
| 6 | PV |
| 7 | 按钮点击 |
| 8 | 页面跳转 |
注意: 表格里的"付费"、"按钮点击"等名称,只是启明平台用来区分不同 eventType 的标签。您可以完全自定义每个 eventType 代表的实际业务目标。
示例: 您创建了一个 eventType=7的转化跟踪。您不必把它当作"按钮点击",完全可以定义为:"用户注册时间<24小时,并且看完了10个激励视频。"只要用户满足该条件,您即可上报 eventType=7。