sensorsAnalyticsAPICloudSDK

来自于:神策数据立即使用

概述

sensorsAnalyticsAPICloudSDK 封装了神策数据 Android & iOS SDK,集成了初始化 SDK、设置登录Id、埋点、强制同步数据等接口。

sharedInstance

初始化SDK

sharedInstance({params})

params

serverURL:

  • 类型:字符串
  • 描述:(必填项)收集事件的URL

configureURL:

  • 类型:字符串
  • 描述:(必填项)配置信息的URL

debugMode:

  • 类型:字符串
  • 描述:debug模式
  • debugMode 有三种形式
    • debugOff - 关闭debug模式
    • debugOnly - 打开debug模式,但该模式下发送的数据仅用于校验,不进行数据导入
    • debugAndTrack - 打开debug模式,并将数据导入到SensorsAnalytics中
注意:正式发布app时请将 debugMode 指定成 debugOff 模式!

示例代码

var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
saAPICloud.sharedInstance({
    serverURL: "your server url", 
    configureURL: "your configure url", 
    debugMode: "your debug mode"

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

login

设置当前用户的 loginId

login({params})

params

loginId:

  • 类型:字符串
  • 描述:(必填项)用户的登录id,不能为空,且长度不能大于255

示例代码

var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
saAPICloud.login({
    loginId: "yourloginId"
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

track

track事件

track({params})

params

event:

  • 类型:字符串
  • 描述:(必填项)事件名称,名称需要满足一般变量的命名规则,即不能以数字开头,且只包含:大小写字母、数字、下划线和$

properties:

  • 类型:json格式
  • 描述:(选填项)事件属性,属性名需要满足一般变量的命名规则,规则同事件名称

示例代码

var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
saAPICloud.track({
    event:'youreventname',
    properties:{
       ProductID:123456,
       ProductCatalog:'LaptopComputer',
       IsAddedToFav: false
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

flush

强制同步数据

flush()

示例代码

var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
saAPICloud.flush();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本