快应用框架接入说明

最后更新于:2019-10-17 10:43:24

在使用前,请先阅读数据模型的介绍。

1. 快应用集成 SDK

1.1.1. 下载 SDK

从 GitHub 上下载 快应用 SDK,sensorsdata.min.js;

1.1.2. 引入和配置 SDK

第一步:从 GitHub 下载 sensorsdata.min.js 文件,放在目录下
第二步:在项目的 app.ux 中引入目录下的 sensorsdata.min.js ,然后调用 setPara() 方法设置初始化参数,必须在 onCreate 中调用 sensors.init(this) 方法完成初始化。

import sensors from './sensorsdata.min.js';
sensors.setPara({
    name: 'sensors',
    server_url: '数据接收地址'
});

//必须传入this,不然在Page中无法引用sensors
export default {
    onCreate() {
        sensors.init(this);
    }
}

2 预置事件和属性

2.1 预置事件

$AppStart(App 启动)事件

// app.ux
export default {
  onCreate () {
    sensors.init(this);
    sensors.appLaunch();
  }
}

$AppViewScreen(App 浏览页面)事件

// src下的页面
export default {
  onShow() {
      this.$app.sensors.pageShow();
  }
}

2.2 $AppStart(App 启动)事件的预置属性:

字段名称 类型 说明 版本
$scene 字符串 启动场景(source.type) 0.1.0
$source_package_name 字符串 来源包名(source.packageName) 0.1.0

2.3 $AppViewScreen(App 浏览页面)事件的预置属性:

字段名称 类型 说明 版本
$scene 字符串 启动场景(source.type) 0.1.0
$source_package_name 字符串 来源包名(source.packageName) 0.1.0
$path 字符串 页面路径(router.getState().path) 0.1.0
$title 字符串 页面标题(router.getState().name) 0.1.0

3. 标识用户

在进行任何埋点之前,都应当先确定如何标识用户。distinct_id 是神策用来标识用户的一段唯一的字符串。

在快应用中,会有下面 2 种 id

  1. 默认情况下,我们会生成一个随机数 uuid ,保存在本地缓存中,我们暂时称这个为 uuid
  2. 数据库中保存的,用户真实 id 。我们暂时称为 "你们服务端分配给用户具体的登录 ID"

如果不做任何操作,快应用会使用 uuid 作为 distinct_id ,注意: uuid 在换了设备,或者删除快应用后,会重新生成。

3.1 修改匿名 ID

默认情况下,是把 uuid 作为 distinct_id 的。如果想使用其他匿名 id(比如你们自己生成的 uuid),可以用 identify(id,true) 方法来改变当前的distinct_id

------app.ux
import sensors from './sensorsdata.min.js';
sensors.setPara(...);
sensors.identify('匿名ID', true);

3.2 用户关联

1.可以通过调用 login("userID") 方法来标识真实用户;
2.通过 login("userID") 来把 SDK 自动生成的 uuid 与现在传入的 userID 关联。且以后会一直使用这个 userID

------app.ux
import sensors from './sensorsdata.min.js';
sensors.setPara(...);
sensors.login("userID");

4. Page 中追踪自定义事件

track(eventName,[properties])

采集自定义事件。

  • eventName:string,必填,事件名称;

  • properties:object,选填,为该事件设置的事件属性;

第一次接入神策分析时,建议先追踪 3~5 个关键的事件,只需要几行代码,便能体验神策分析的分析功能。例如:

电商产品,可以追踪用户注册、浏览商品和下订单等事件。

------index.ux
// 追踪浏览商品事件。  
sensors.track('ViewProduct', {
    ProductId: '123456',
    ProductCatalog: "Laptop Computer",
    ProductName: "MacBook Pro",
    ProductPrice: 12345
});

5 设置用户属性

5.1 setProfile(properties)

直接设置用户的属性,如果存在则覆盖。

  • properties:object,必选。
sensors.setProfile({
    email:'xxx@xx',
    favoriteFruits: ['苹果', '油桃'],
    subscribers: 7277
});

5.2 setOnceProfile(properties)

如果不存在则设置,存在就不设置。

  • properties:object,必选。
sensors.setOnceProfile({
    email:'xxx@xx',
    favoriteFruits: ['苹果', '油桃'],
    subscribers: 7277
});