AI-ready documentation
演练模式
说明 HarmonyOS SDK 如何通过 dryRunEventWithCallback 接入引力演练模式，包含 trace_id 获取、回调处理与付费/关键行为向媒体回传的示例代码。
此文档主要说明引力 HarmonyOS SDK 演练模式相关的代码接入部分。运营和投放的后台配置请参考引力 & 回传演练模式。
鸿蒙（HarmonyOS）仅支持巨量。
为了该模式更灵活的使用，建议将演练模式在代码中配置为一个开关，方便联调和测试。
接入事项
因演练模式主要是为了付费的自定义回传，为了减少投放每次调整映射策略，导致的客户端频繁改动，引力提供了演练模式，支持客户端技术从引力获取具体订单对应的回传结果，再执行给媒体的回传。
请客户端技术务必确认下面的流程图步骤明确后开始接入。
HarmonyOS SDK 演练
以下是 HarmonyOS SDK，技术需要处理的 5 大步骤：
- 升级引力 SDK 到 2.0.3 及以上版本，建议通过 ohpm 集成 的方式引入；
- 正常按照引力接入文档接入，建议您一定上报用户初始化渠道，对应字段
channel值，不上报无法选择渠道包相关归因； - 在用户发生付费行为时，客户端需要获取到
trace_id，获取方式：- 如果历史是通过客户端上报付费事件给引力：调用引力 SDK 付费事件上报接口
trackPayEvent，该接口会返回一个trace_id，请使用变量保存好； - 如果历史是通过服务端 API 上报付费事件给引力：API 上报之后，您的服务端需要返回本次事件上报的
$order_id给您的客户端，此时$order_id即为trace_id
- 如果历史是通过客户端上报付费事件给引力：调用引力 SDK 付费事件上报接口
- 然后调用
dryRunEventWithCallback接口，传入上一步获取的trace_id； - 客户在
dryRunEventWithCallback方法的回调函数中获取当前事件所映射的媒体回传事件，并根据返回的信息来执行向媒体 SDK 上报事件的逻辑；
核心代码实现逻辑如下，请注意看注释！（包含了关键行为和付费相关代码，根据实际取用）
const trace_id = GravityEngineSDK.trackPayEvent({
payAmount: 300,
payType: "CNY",
orderId: "jHSGFtgaefgvygftFStydgyuhuyw016",
payReason: "月卡",
payMethod: "支付宝",
});
GravityEngineSDK.dryRunEventWithCallback(trace_id, { myDataKey: "myDataValue" }, {
onFailed: (errorMsg: string): void => {
console.log(
"gravityAnalytics dryRunEventWithCallback onFailed error:", errorMsg
);
},
onEmpty: (type: string): void => {
// EMPTY_TYPE_NOT_ENABLE 当前用户归因媒体未开启演练模式
// EMPTY_TYPE_NO_IN_POSTBACK_WINDOW 不在窗口期
// EMPTY_TYPE_SKIP 跳过
console.log(
"gravityAnalytics dryRunEventWithCallback onEmpty type:", type
);
},
onTrackPay: (dryRunEventMediaType: string, payAmount: number, traceId: string, otherParams: object): void => {
console.log(
"gravityAnalytics dryRunEventWithCallback onTrackPay dryRunEventMediaType:" + dryRunEventMediaType + " payAmount:" + payAmount + " traceId:" + traceId + " otherParams:" + otherParams
);
},
onTrackKeyActive: (dryRunEventMediaType: string, traceId: string, otherParams: object): void => {
console.log(
"gravityAnalytics dryRunEventWithCallback onTrackKeyActive dryRunEventMediaType:" + dryRunEventMediaType + " traceId:" + traceId + " otherParams:" + otherParams
);
}
})上述示例中 GravityEngineSDK 为引力 HarmonyOS SDK 的实例，请先完成 SDK 初始化后再调用演练模式接口。
onTrackPay 回调中的 payAmount 参数单位是分，给具体媒体回传的时候，请留意是否需要转化成元~
常见问题
-
如果代码执行了演练模式的部分，但是应用没有配置，演练模式是否生效？
- 不开启演练模式，调用演练模式的接口会返回
onEmpty（当前用户归因媒体未开启演练模式）； - 需同时开启，否则演练模式不生效。
- 不开启演练模式，调用演练模式的接口会返回
-
是否有相关接口能获取到应用管理的演练模式是否开启以及选择的类型？
- 暂时无法获取。
-
如何验证演练模式接入是否成功？
- 在引力后台开启演练模式，调用演练模式之后验证返回的数据是否符合配置的映射。
-
当前用户归因媒体未开启演练模式怎么理解？
- 当用户来自暂不支持演练的渠道或未开启演练模式时会显示此提示。目前鸿蒙端仅巨量的归因用户可开启演练，其他渠道及自然量用户均会返回此状态。
-
订单细查 SDK 回传状态分别是什么含义？
- 等待判断：条件映射状态为未通过的；
- 无需 SDK 回传：满足 SDK 映射的条件及回传比例，执行扣传；
- SDK 待回传：等待 SDK 返回回传结果，一般是没有调用演练模式接口；
- SDK 已回传：已通过 SDK 回传。