# 埋点和日志
# 1、Track 自定义事件上报
# 1.1、接口调用
int result = DHSteamSDK_Track(
sdk,
"game_level_complete",
R"({
"roleId": "0",
"areaId": "100",
"roleLevel": "20",
"eventName": "level_complete",
"eventObj": "level-01",
"eventResult": "success",
"eventCode": "0",
"eventParam": "{\"stage\":\"verify\"}"
})"
);
| 参数 | 类型 | 必传字段 | 说明 |
|---|---|---|---|
handle | DHSteamSDKHandle * | 是 | SDK 句柄。 |
event_name | string | 是 | 业务事件名称,SDK 写入 Track 上报的 log_type。 |
event_params_json | JSON object | 是 | JSON 对象,所有字段值必须为字符串;没有参数时传 {}。 |
返回 0 表示埋点请求已接受,返回 1 表示参数为空、JSON 不是对象或字段值不是字符串。
# 1.2、Track 参数
| 游戏侧参数 | 内部上报字段 | 说明 |
|---|---|---|
roleId | role_id | 角色 ID,无角色时按业务约定传 0。 |
areaId | zid | 大区 ID。 |
roleLevel | role_level | 角色等级。 |
roleVipLevel | vip_level | VIP 等级。 |
roleGender | role_sex | 角色性别。 |
partyName | userGuild | 公会或帮派名称。 |
eventName | event | 行为名称。 |
eventObj | opt_obj | 行为对象。 |
eventResult | opt_res | 行为结果。 |
eventCode | opt_reason | 结果码或原因。 |
eventParam | opt_param | 行为扩展参数,复杂内容先转为 JSON 字符串。 |
stepId | step_id | 步骤 ID。 |
stepState | step_state | 步骤状态。 |
stepType | step_type | 步骤类型。 |
stepParam | step_param | 步骤参数。 |
extendParamJson | extend_param_json | 扩展 JSON 字符串。 |
buttonId | button_id | 按钮 ID。 |
buttonType | button_type | 按钮类型。 |
pageId | page_id | 页面 ID。 |
eventId | event_id | 事件编号。 |
subEventId | sub_event_type | 子事件类型。 |
accountId | account_id | 账号 ID;最终由当前登录账号覆盖。 |
logType | log_type | SDK 会按 event_name 处理 Track 事件名。 |
trackPlatform | track_platform | 传 log 时按日志服务路由。 |
logLevel | log_level | 日志级别字段。 |
logContent | log | 日志内容字段。 |
# 2、Log 埋点日志
# 2.1、接口调用
const char *eventName = "000000::XXX_XXX_XXX";
const char *eventValue = R"({
"trackPlatform": "log",
"logLevel": "d",
"logContent": "test",
"customKey": "customValue"
})";
int result = DHSteamSDK_Log(sdk, eventName, eventValue);
# 2.2、Log 参数
| 参数 | 类型 | 必传字段 | 说明 |
|---|---|---|---|
event_id | string | 是 | 日志事件名称,格式按项目约定传递,例如 000000::XXX_XXX_XXX。 |
trackPlatform | string | 是 | 固定传 log。 |
logLevel | string | 是 | d 表示普通日志或流程统计,e 表示异常日志。 |
logContent | string | 是 | 自定义日志内容。 |
| 自定义参数 | string | 否 | 自定义参数名称和值均由游戏定义。 |
Log 参数值必须全部为字符串。
# 2.3、返回值
DHSteamSDK_Log 返回 0 表示请求已接受,返回 1 表示事件名、JSON 对象或参数值校验失败。返回 0 不代表日志服务已经接收。
Track 和 Log 是后台上报接口,不以业务事件回调表示服务端成功。开启 DHSTEAMSDK_DEBUG_LOG_SAFE 后,可通过 DHSTEAMSDK_EVENT_DIAGNOSTIC 事件查看网络请求结果。