集成神策分析 SDK

引入 SDK

  • 从 GitHub 上获取小红书小程序 SDK 源码；
  • 将 xiaohongshu-mp.min.js 文件放入小程序项目中；
  • 在 app.js 文件中通过 import 方式引入 SDK。
import sensors from './build/xiaohongshu-mp.min.js'; 

// 初始化
sa.init({
  server_url: '您的数据接收地址',
  // 是否允许控制台打印查看埋点数据(建议开启查看)
  show_log: true,
  autoTrack: {
    appLaunch: true, // 默认为 true，false 则关闭 $MPLaunch 事件采集
    appShow: true, // 默认为 true，false 则关闭 $MPShow 事件采集
    appHide: true, // 默认为 true，false 则关闭 $MPHide 事件采集
    pageShow: true, // 默认为 true，false 则关闭 $MPViewScreen 事件采集
    pageShare: true, // 默认为 true，false 则关闭 $MPShare 事件采集
    mpClick: true, // 默认为 false，true 则开启 $MPClick 事件采集
    mpFavorite: true, // 默认为 true，false 则关闭 $MPAddFavorites 事件采集
    pageLeave: true // 默认为 false， true 则开启 $MPPageLeave事件采集
  },
  name: 'sd'
});
JS
  • 小红书小程序 SDK 压缩文件 xiaohongshu-mp.min.js 大小约为 36.2 KB
  • 需要在 App 实例化之前调用 init()，否则可能会造成部分预置事件丢失。
  • 在调用 init() 接口之前，采集的数据被缓存在内存中；调用 init() 接口后，会将缓存的数据通过网络发送出去。

SDK 基本配置

配置项目数据接收地址

如下图所示获取数据接收地址：

设置事件公共属性

对于所有事件都需要添加的属性，可在初始化 SDK 前，调用 registerApp() 将属性注册为公共属性：

// 在需要使用 SDK 接口的页面逻辑文件中，需要通过 import 将 SDK 引入，再调用相应接口 
import sensors from './build/xiaohongshu-mp.min.js';
sensors.registerApp({
	userLever: 'VIP3',
	userSex: '男'
});
JS

用户登录

当用户注册成功或者登录成功时，需要调用 login() 方法传入登录 ID：

// 在需要使用 SDK 接口的页面逻辑文件中，需要通过 import 将 SDK 引入，再调用相应接口
import sensors from './build/xiaohongshu-mp.min.js';  
sensors.login("登录 ID");
JS
  • 对于自动登录的用户，可以在 SDK 初始化前，获取登录 ID 并调用 login() 方法。

代码埋点追踪事件

可通过 track() 方法追踪用户行为事件，并为事件添加自定义属性：

// 在需要使用 SDK 接口的页面逻辑文件中，需要通过 import 将 SDK 引入，再调用相应接口
import sensors from './build/xiaohongshu-mp.min.js';

Page({
	onShow: function(){
		sensors.track('pageview',{
			title: '首页'
		});
	}
});
JS

调试查看事件信息

事件的触发日志

SDK 可选配置

设置用户属性

setProfile( properties ): 可以设定用户属性，同一个 key 多次设置时，value 值会进行覆盖替换：

// 在需要使用 SDK 接口的页面逻辑文件中，需要通过 import 将 SDK 引入，再调用相应接口
import sensors from './build/xiaohongshu-mp.min.js';

sensors.setProfile({
	email:'xxx@xx',
	favoriteFruits: ['苹果', '油桃'],
	subscribers: 7277
});
JS