appsee

来自于:appsee官方立即使用

概述

appSee封装了Appsee数据统计平台的SDK,使用此模块可轻松实现移动App的数据统计功能。

使用本模块需要到 Appsee官网 去申请apikey。 联系模块提供方Appsee官方技术支持可发邮件至tao@appsee.com或加微信taotao243231535

使用此模块之前需先配置config.xml文件的Feature,方法如下

名称:appsee

参数:apiKey

描述:当前app的apikey

配置示例

<feature name="appsee">
    <param name="apiKey" value="172b5e47c4fb469a9495ec94903bae5b" />
</feature>

注意:在 iOS 平台上暂时不支持屏幕录像。屏幕录像功能默认为关闭状态。若要开启屏幕录像功能,请在 config.xml文件内配置 debug 为 false

模块接口

setUserId

设置用户id

setUserId(parmas, callback(ret, err))

params

userId:

  • 类型:字符串
  • 描述:用户ID,用户ID的字节码长度不应该超过256个字节

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status:true  //布尔类型;是否成功
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg:""     //错误描述,字符串
}

示例代码:

var appsee = api.require('appsee');
var params = {userId:'1234'};
appsee.setUserId(params, function(ret, err){
    if (ret.status){
       api.alert("设置成功");
    }
});

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

startPage

监听打开一个页面

startPage({params})

params

pageName:

  • 类型:字符串
  • 描述:当前页面的名称

示例代码:

var appsee = api.require('appsee');
appsee.startPage({pageName:api.frameName});

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

addPageAction

给当前页面添加一个操作

addPageAction(params)

params

actionName:

  • 类型:字符串
  • 描述:操作名称

示例代码:

var appsee = api.require('appsee');
var param5 = {actionName:'click'};
appsee.addPageAction(param5);

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setLocation

设置位置

setLocation(params)

params

latitude:

  • 类型:数字
  • 描述:(可选项)维度
  • 默认值:0

longitude:

  • 类型:数字
  • 描述:(可选项)精度
  • 默认值:0

horizontalAccuracy:

  • 类型:数字
  • 描述:(可选项)水平精度
  • 默认值:0

verticalAccuracy:

  • 类型:数字
  • 描述:(可选项)竖直精度
  • 默认值:0

description:

  • 类型:字符创
  • 描述:(可选项)位置描述

示例代码:

var appsee = api.require('appsee');
var params = {latitude:100, 
                longitude:100, 
                horizontalAccuracy:0, 
                verticalAccuracy:0, 
                description:'apicloud'};
appsee. setLocation(params);

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

addEvent

自定义事件

addEvent(params)

params

eventName:

  • 类型:字符串
  • 描述:事件名称

properties

  • 类型:JSON对象
  • 描述:(可选项)自定义事件的参数

示例代码:

var appsee = api.require('appsee');
var param4 = {
        eventName:'apicloud',
        properties:
            {
                ItemType:'Shoes',
                ItemModel:'Nike',
            }    
};
appsee.addEvent(param4);

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

stopVideo

停止屏幕录制

注意:当app 启动时,appsee会自动开启屏幕录像并在后台上报 appsee服务器。若不需要此功能,可调用本接口关闭。

stopVideo()

示例代码

var appsee = api.require('appsee');
appsee.stopVideo();

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

pauseVideo

暂停屏幕录制

pauseVideo()

示例代码:

var appsee = api.require('appsee');
appsee.pauseVideo();

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

resumeVideo

恢复屏幕录制

resumeVideo()

示例代码:

var appsee = api.require('appsee');
appsee.resumeVideo();

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setOptOutStatus

设置跟踪状态

setOptOutStatus(param)

parma

status:

  • 类型:布尔
  • 描述:(可选项)跟踪状态
  • 默认值:false

示例代码:

var appsee = api.require('appsee');
var param = {status:true};
appsee.setOptOutStatus(param);

补充说明

默认情况下,所有的用户行为操作都会被跟踪,你可以为指定的用户设置跟踪状态。如果设置为true,所有的用户行为都会被忽略,直到你设置为false。

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

getOptOutStatus

获取跟踪状态

getOptOutStatus(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status:true   //跟踪状态
}

示例代码:

var appsee = api.require('appsee');
appsee.getOptOutStatus(function(ret){
    alert(ret.status);
});

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

finishSession

结束一个会话跟踪,同时上报 appsee 服务器。

注意:默认情况下,当一个APP处于前台开始会话跟踪,app处于后台或者崩溃结束会话跟踪。 除非你想覆盖这种行为,一般不会调用此接口。

finishSession(parmas)

params

verifyBackground:

  • 类型:布尔
  • 描述:(可选项)当app处于后台的时候结束会话跟踪,除非你的app是一个Voip应用,否则设置false
  • 默认值:false

shouldUpload:

  • 类型:布尔
  • 描述:(可选项)是否立刻上传会话,否则只有当app进入后台时上传会话
  • 默认值:false

示例代码:

var appsee = api.require('appsee');
var param = {verifyBackground:false, shouldUpload:true};
appsee.finishSession(param);

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

forceNewSession

当前没有运行的回话时,开启一个新的会话。

注意:除非你用 finishSession 接口关闭了一个回话,一般无需调用本接口。

forceNewSession()

示例代码:

var appsee = api.require('appsee');
appsee.forceNewSession();

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

upload

上传当前会话监听到的行为。

注意:一般无需调用本接口,除非你的app从来不会进入后台,或者你就是想上传当前回话。

upload()

示例代码

var appsee = api.require('appsee');
appsee.upload();

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

markViewAsSensitive

标记一个敏感页面,本接口暂仅支持ios平台

注意:本模块只能标记整个页面为敏感页面

markViewAsSensitive(params)

params

fixedOn:

  • 类型:字符创
  • 描述:模块视图添加到指定 frame 的名字、

示例代码

var appsee = api.require('appsee');
var parmas = {fixedOn:'index'};
appsee. markViewAsSensitive(parmas);

可用性

iOS系统 可提供的1.0.0及更高版本

unmarkViewAsSensitive

解除页面的敏感,本接口暂仅支持ios平台

unmarkViewAsSensitive(params)

params

fixedOn:

  • 类型:字符创
  • 描述:(必选项) 模块视图添加到指定 frame 的名字
  • 默认值:无

示例代码

var appsee = api.require('appsee');
var parmas = {fixedOn:'index'};
appsee.unmarkViewAsSensitive(parmas);

可用性

iOS系统 可提供的1.0.0及更高版本

generate3rdPartyID

生成第三方平台的Appsee ID

注意:Appsee可以通过向第三方平台发送Appsee ID或通过向Appsee发送第三方Id来实现与第三方平台的集成。

generate3rdPartyID({params},callback(ret))

params

systemName:

  • 类型:字符串
  • 描述: 第三方平台的名称

isPersistent:

  • 类型:布尔
  • 描述:(可选项) 标识符是否应该在会话中持久化
  • 默认值:true

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    partyID:''     //字符串类型;生成的id
}

示例代码

var appsee = api.require('appsee');
var parmas = {systemName:'Adobe', isPersistent:true};
appsee. generate3rdPartyID(parmas,function(ret){
   alert(JSON.stringify(ret));
});

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

set3rdPartyID

设置第三方平台的Appsee ID

set3rdPartyID(params)

params

systemName:

  • 类型:字符串
  • 描述: 第三方平台的名称

externalID:

  • 类型:字符串
  • 描述:第三方平台的Appsee ID

isPersistent:

  • 类型:布尔
  • 描述:(可选项) 标识符是否应该在会话中持久化
  • 默认值:true

示例代码

var appsee = api.require('appsee');
var parmas = {systemName:'Adobe', externalID:'1234', isPersistent:true};
appsee.set3rdPartyID(parmas);

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

addEventListener

添加跟踪的监听

addEventListener({params},callback(ret))

params

name:

  • 类型:字符串
  • 描述:(可选项)监听的行为
  • 默认:appseeSessionStarted
  • 取值范围:
    • appseeSessionStarting
    • appseeSessionStarted
    • appseeSessionEnding
    • appseeSessionEnded
    • appseeScreenDetected

callback(ret)

ret:

  • 类型:JSON对象
  • 描述:监听事件返回的数据,当 name 为 appseeSessionStarting时只有事件无任何数据返回
  • 内部字段:
{
    sessionId:1,          //字符串类型;sessionid, 仅当name 为 appseeSessionStarted、appseeSessionEnding、appseeSessionEnded 时有值

    isVideoRecorded: true,//布尔类型;是否开始录像, 仅当name 为 appseeSessionStarted 时有值
    pageName:''           //字符串类型;页面名字, 仅当name 为 appseeScreenDetected 时有值
}

示例代码

var appsee = api.require('appsee');
appsee.addEventListener({
    name:'appseeSessionStarted'
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS系统,Android系统 可提供的1.0.0及更高版本

setDebugToNSLog

设置laog输出,本接口暂仅支持ios平台

setDebugToNSLog(param)

parma

log:

  • 类型:布尔
  • 描述:(可选项)是否开启log输出
  • 默认值:false

示例代码:

var appsee = api.require('appsee');
var param = {log:true};
appsee.setDebugToNSLog(param);

可用性

iOS系统 可提供的1.0.0及更高版本