tt.reportScene
收藏我的收藏
收藏基础库 2.88.0 开始支持本方法，这是一个异步方法。
语法
tt.reportScene(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| sceneId | number | 是 | 场景ID，登录抖音开放平台，进入「数据」-「性能分析」-「启动监控」-「启动场景配置」模块，添加游戏的自定义启动场景。 游戏每次启动只可以上报一次 | 2.88.0 | |
| costTime | number | 0 | 是 | 场景耗时，单位ms | 2.88.0 |
| dimension | object | {} | 否 | 自定义维度数据。只支持能够通过 JSON.stringify 序列化的对象，且序列化后长度不超过 1024 个字符 | 2.88.0 |
| metric | object | {} | 否 | 自定义指标数据。只支持能够通过 JSON.stringify 序列化的对象，且序列化后长度不超过 1024 个字符 | 2.88.0 |
| success | function | 否 | 接口调用成功的回调函数 | 2.88.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 2.88.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 2.88.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| data | object | 开发者上报的原始数据 | 2.88.0 |
| errMsg | string | "reportScene:ok" | 2.88.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "reportScene:fail" + 详细错误信息 | 2.88.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 20001 | params.${key} should be ${expect_type}, but got ${actual_value} | 参数数据类型校验，请根据「参数说明」检查对应字段传参情况 | 2.88.0 |
| 20001 | report sceneId:${scene_id} repeatedly | 同一个场景 ID 重复上报，游戏每次启动只可以上报 一次 | 2.88.0 |
| 20001 | params.dimension.${key} needs to be a string type and a non-empty string | dimension 中每个字段需要为非空字符串 | 2.88.0 |
| 20001 | params.metric.${key} needs to be a numeric value of type string | metric 中每个字段需要为非空字符串且可以 parse 为非 NaN 数字 | 2.88.0 |
| 20001 | params.${key} cannot exceed 1024 characters | dimension / metric 字段 stringify 后字符串长度不可超过 1024 | 2.88.0 |
| 20001 | failed to serialize params.${} by JSON.stringify | dimension / metric 对象 stringify 失败 | 2.88.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.reportScene({ sceneId: 1000, 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) } })
