API功能

JS数据监测接口

如需使用JS数据监控接口，需要使用BonreeSDK预先插入到WebView框架中的桥接对象bonreeJsBridge来调用各设置函数。如：

bonreeJsBridge.setUserID('1234');

注意：使用JS行为数据监控功能需要开启WebView功能。

JS接口的参数限制与原生基本一致。JS特有接口参数限制本文档单独标注。

设置用户ID

// 设置会员ID
function setUserID(ID);

• 接口说明

• 示例

  在需要设置会员用户id时添加如下代码：

    <script>
        function myclick() {
            bonreeJsBridge.setUserID('1234');
        }
    </script>
  

设置用户附加信息

function setExtraInfo(extraInfo);

• 接口说明

• 示例

  某html页面在进入某一个页面时设置自定义信息：

    <script>
        function myclick() {
            var json = '{ "js1": "jsvalue1", "js2": "jsvalue1", "js3":"jsvalue3" }';
            bonreeJsBridge.setExtraInfo(json);
        }
    </script>
  

自定义异常

function setCustomException(exceptionType, causedBy, errorDump);

• 接口说明

• 示例

    <script>
        function customException() {
            bonreeJsBridge.setCustomException("Custom exception type", "Caused by customer.", "Custom error dump 0\nCustom error dump 1");
        }
    </script>
  

自定义视图

// 自定义视图开始记录
function setCustomPageStart(pageName, pageAlias);
// 自定义视图结束记录
function setCustomPageEnd(pageName, pageAlias);

• 接口说明

• 示例

  监测关于html界面，其对应页面名称为About.html：

    <script>
        function myclick() {
            bonreeJsBridge.setCustomPageStart("001", "About");
            bonreeJsBridge.setCustomPageEnd("001", "About");
        }
    </script>
  

注意：setCustomPageStart和setCustomPageEnd需成对调用。

自定义事件

function setCustomEvent(eventId, eventName);

• 接口说明

• 示例

  检测某html页面内的某button点击情况：

    <script>
        function myclick() {
            bonreeJsBridge.setCustomEvent("1111", "button click");
        }
    </script>
  

自定义日志

function setCustomLog(logInfo);

• 接口说明

• 示例

  检测某JS函数的执行日志：

    <script>
        function myclick() {
            bonreeJsBridge.setCustomLog("2020-01-01 08:30:00 Print myclick()");
        }
    </script>
  

自定义指标

function setCustomMetric(metricName, metricValue);

• 接口说明

• 示例

  检测JS函数内某测试指标：

    <script>
        function myclick() {
            bonreeJsBridge.setCustomMetric("测试指标01", "1");
        }
    </script>
  

自定义H5性能数据

function setCustomH5performanceData(dataInfo);

• 接口说明

标识相对值的时间指标指该指标与navigation start的相对时间。

• 示例

    function fun() {
        var dataInfo = {
            "pvid":"00000000-0000-0000-0000-000000000000",    
            "url":"http://localhost/index.html",
            "imd":1,
            "ns":1619061461208,
            "ues":-1,
            "uee":-1,
            "rds":-1,
            "rde":-1,
            "fs":3,
            "dls":5,
            "dle":6,
            "cs":7,
            "scs":9,
            "ce":12,
            "reqs":13,
            "rsps":15,
            "rspe":19,
            "dl":20,
            "di":22,
            "dcles":23,
            "dclee":25,
            "dc":26,
            "les":26,
            "lee":35,
            "fp":-1, 
            "fcp":-1,
            "lcp":-1
        };
        bonreeJsBridge.setCustomH5performanceData(JSON.stringify(dataInfo));
     }
  

自定义路由切换数据

function setCustomRouteChangeData(dataInfo);

• 接口说明

• 示例

    function fun() {
        var dataInfo = {
            "tu":"http://localhost/index#/home",
            "fu":"http://localhost/index#/",
            "d":2,
            "sta":0,
            "al":"",
            "pt":"/home",
            "rt":"http://localhost/index/home",
            "pu":"http://localhost/index#/home",
            "fw":"Vue"
        };
        bonreeJsBridge.setCustomRouteChangeData(dataInfo);
    }