# 上报角色信息
# 接口说明
当有用户登录游戏服成功、创角成功、角色升级(如游戏无角色等级概念,可为关卡等级)、充值成功(并非所有充值渠道都具有客户端回调,充值且发货成功应以游戏服务端下发通知为准)时,均需调用此接口进行数据上报。
sdkInstance.uploadRoleInfo(params, callback?);
注意事项
通过本接口所上报的角色信息,涉及SDK心跳机制、第三方SDK数据上报等内容,请务必保证上报数据的真实性、有效性!
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
params | object | 是 | -- | -- |
params.type | string | 是 | -- | 上报类型
|
params.areaId | string / number | 是 | -- | 游戏大区ID,若游戏无大区概念,可填 1 ,表示初始大区编号 |
params.areaName | string | 是 | -- | 游戏大区名称,若游戏无大区概念,可填 1区 ,表示初始大区名称 |
params.roleId | string / number | 是 | - | 角色ID,若游戏无角色概念,可填 accountId 账号ID |
params.roleName | string | 是 | -- | 角色名称,若游戏无角色概念,可填 accountId 账号ID |
params.roleLevel | number | 是 | -- | 角色等级,若游戏无角色或等级概念,可填关卡等级或填 1 |
params.roleVipLevel | number | 否 | -- | 角色VIP等级 |
params.itemId | string | 是 | -- | 商品ID,仅在 type 为 PAY_SUCCESS 时必填! |
params.itemName | string | 是 | -- | 商品名称,仅在 type 为 PAY_SUCCESS 时必填! |
params.orderId | string | 是 | -- | 订单唯一编号,仅在 type 为 PAY_SUCCESS 时必填! |
params.orderPrice | number | 是 | -- | 商品总价,即实际支付价格,单位为分!仅在 type 为 PAY_SUCCESS 时必填! |
params.currency | string | 否 | CNY | 货币类型,仅在
|
params.payType | string | 否 | weixinpay | 支付方式,仅在
|
callback | function | 否 | -- | 数据上报完成时的回调函数 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdkInstance.uploadRoleInfo({
type: "LOGIN_GAME", // 登录游戏服时传LOGIN_GAME,创角时传CREATE_ROLE,升级时传LEVEL_UP,充值成功时传PAY_SUCCESS
areaId: 1001, // 游戏大区ID,若游戏无大区概念,可不填,默认值为 1,表示初始大区编号
areaName: "1区", // 游戏大区名称
roleId: "123456", // 角色ID,若游戏无角色概念,可填 accountId 账号ID
roleName: "小朋友", // 角色名称,若游戏无角色概念,可填 accountId 账号ID
roleLevel: 1, // 角色等级,若游戏无角色及等级概念,可填关卡等级或不填,默认值为 1
roleVipLevel: 1, // 角色VIP等级
// 以下参数仅在 type 为 PAY_SUCCESS 时所需,以上为通用参数
itemId: "com.dh.test", // 商品ID
itemName: "60钻石", // 商品名称
orderId: "xxxxxxxxxx", // 订单唯一编号
orderPrice: 600, // 商品总价,即实际支付价格,单位为分!!!
currency: "CNY", // 货币类型
payType: "weixinpay" // 支付方式
}, function(params) {
console.log(params);
});