bilibili小游戏

使用小贴士

bl.reportScene

上报埋点

基础库 3.99.9 开始支持，低版本需做兼容处理

功能描述

用于游戏启动阶段的自定义场景上报。使用前请注意阅读 相关说明。

参数

Object object

属性类型默认值必填说明
sceneIdNumber是场景ID
costTimeNumber0否此场景的耗时，单位 ms
dimensionObject否自定义维度数据，只支持能够通过JSON.stringify序列化的对象，且序列化后长度不超过1024个字符
metricObject否自定义指标数据，只支持能够通过JSON.stringify序列化的对象，且序列化后长度不超过1024个字符
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性类型说明
dataObject开发者上报的原始数据

object.fail 回调函数

参数

Object err

属性类型说明
dataObject开发者上报的原始数据
errMsgString错误信息

错误

错误码错误信息说明
${paramName} should be ${expectType} instead of ${paramType}参数的类型需为指定的数据类型
parameter.${paramName} should greater than or equal to zero参数的值需要大于等于0
parameter.${paramName}.${key} needs to be a string type and a non-empty stringvalue仅支持传入非空字符串
parameter.${paramName}.${key} needs to be a numeric value of type stringvalue仅支持传入纯数值组成的字符串（如：'25'）
failed to serialize parameter.${paramName} by JSON.stringify参数对象序列化失败
parameter.${paramName} cannot exceed 1024 characters参数序列化后，字符串长度不可超过1024个字符

示例代码

bl.reportScene({
  sceneId: 7,
  costTime: 350,
  dimension: {
    d1: '2.1.0', // value仅支持传入String类型。若value表示Boolean，请将值处理为'0'、'1'进行上报；若value为Number，请转换为String进行上报
  },
  metric: {
    m1: '546', // value仅支持传入数值且需要转换为String类型进行上报
  },
  success (res) {
    // 上报接口执行完成后的回调，用于检查上报数据是否符合预期
    console.log(res)
  },
  fail (res) {
    // 上报报错时的回调，用于查看上报错误的原因：如参数类型错误等
    console.log(res)
  }
})

自定义场景上报预留 id

sceneId说明
7游戏可玩，比如进入游戏大厅
10游戏新手教程完成
1007激励视频广告，用户点击看广告
← bl.launchSuccessNext →