小红书小程序 SDK
|
收藏
- 在使用前,请先阅读 数据模型
- SDK 更新日志,可参考 Release Notes
1. 集成神策分析 SDK
1.1. 引入 SDK
- 从 GitHub 仓库中 /dist/mp-xiaohongshu/ 目录下获取小红书小程序 SDK 源码下;
- 将 index.esm.js 文件放入小程序项目中;
- 在 app.js 文件中通过 import 方式引入 SDK。
import sensors from './dist/mp-xiaohongshu/index.esm.js';
// 初始化
sensors.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 事件采集
mpClick: true, // 默认为 false,true 则开启 $MPClick 事件采集
pageLeave: true // 默认为 false, true 则开启 $MPPageLeave事件采集
},
name: 'sd'
});
JS
- 需要在 App 实例化之前调用 init(),否则可能会造成部分预置事件丢失。
- 在调用 init() 接口之前,采集的数据被缓存在内存中;调用 init() 接口后,会将缓存的数据通过网络发送出去。
2. SDK 基本配置
2.1. 配置项目数据接收地址
如下图所示获取数据接收地址:
2.2. 设置事件公共属性
对于所有事件都需要添加的属性,可在初始化 SDK 前,调用 registerApp() 将属性注册为公共属性:
// 在需要使用 SDK 接口的页面逻辑文件中,需要通过 import 将 SDK 引入,再调用相应接口
import sensors from './dist/mp-xiaohongshu/index.esm.js';
sensors.registerApp({
userLever: 'VIP3',
userSex: '男'
});
JS
2.3. 用户关联
用户关联是为了对用户进行唯一标识,提高用户行为分析的准确性。目前神策提供了简易用户关联和全域用户关联分为用于支撑不同的业务场景。
2.4. 代码埋点追踪事件
SDK 初始化后,可通过 track() 方法追踪用户行为事件,并为事件添加自定义属性:
sensors.track(event_name [,properties]);
JS
配置参数:
参数 | 必填 | 描述 |
---|---|---|
event_name | 是 | 事件名称 |
properties | 否 | 为用户行为事件添加自定义属性,类型:Object。 |
示例:
// 为 pageview 事件添加自定义属性 title 值为首页。
// 在需要使用 SDK 接口的页面逻辑文件中,需要通过 import 将 SDK 引入,再调用相应接口
import sensors from './dist/mp-xiaohongshu/index.esm.js';
Page({
onShow: function(){
sensors.track('pageview',{
title: '首页'
});
}
});
JS
事件名和事件属性的格式规范,请参考数据格式。
3. 调试查看事件信息
3.1. 事件的触发日志
4. SDK 可选配置
4.1. 设置用户属性
setProfile( properties ): 可以设定用户属性,同一个 key 多次设置时,value 值会进行覆盖替换:
// 在需要使用 SDK 接口的页面逻辑文件中,需要通过 import 将 SDK 引入,再调用相应接口
import sensors from './dist/mp-xiaohongshu/index.esm.js';
sensors.setProfile({
email:'xxx@xx',
favoriteFruits: ['苹果', '油桃'],
subscribers: 7277
});
JS
注:本文档内容为神策产品使用和技术细节说明文档,不包含适销类条款;具体企业采购产品和技术服务内容,以商业采购合同为准。