Comment on page
微信小程序插件版
微信小程序插件版（Plugin）
微信小程序插件版SDK集成前请先下载 SDK
SDK Releases包下载：
Github地址(推荐)：https://github.com/analysys/ans-wechat-sdk/releases
Gitee地址：https://gitee.com/Analysys/ans-wechat-sdk/releases
Releases中含有更新说明请您阅读，接口使用请参考本文档。
js文件 | 功能描述 | 是否必须 |
AnalysysAgent_WX_SDK.plugin.min.js | 插件版SDK | 二选一 |
AnalysysAgent_WX_SDK.plugin.es6.min.js | 插件版ES6语法SDK | 二选一 |
AnalysysAgent_encryption.min.js | 加密模块 | 非必须 |
AnalysysAgent_encryption.es6.min.js | 加密模块ES6语法配合插件版ES6版本使用 | 非必须 |
注意：请您根据自身业务需求来引用相关的SDK。
如果您是第一次使用易观方舟产品，可以通过阅读本文快速了解此产品
在app.js文件的顶部引入SDK。
通过初始化代码的配置参数配置您的AppKey。
通过初始化代码的配置参数uploadURL设置您上传数据的地址。
登录微信公众平台，将上传地址域名配置到request 合法域名中。
通过手动埋点，设置需要采集的页面或事件。
通过设置Ddebug模式，开/关 log 查看日志。
通过以上6步您即可验证SDK是否已经集成成功。更多接口说明请您查看API文档。
将 AnalysysAgent_WX_SDK.plugin.min.js或AnalysysAgent_WX_SDK.plugin.es6.min.js 文件放到小程序的目录下
在小程序的 app.js 文件中的第一行加入以下代码:
let AnalysysAgent = require("./build/AnalysysAgent_WX_SDK.plugin.min.js")
AnalysysAgent.appkey = "/*设置为实际APPKEY*/" //APPKEY
如需要加密模块
let AnalysysEncryption = require("./build/AnalysysAgent_encryption.min.js")
AnalysysAgent.encrypt = AnalysysEncryption
对于使用 es6 版本的
import AnalysysAgent from './build/AnalysysAgent_WX_SDK.plugin.es6.min.js';
import AnalysysEncryption from './build/AnalysysAgent_encryption.es6.min.js';
AnalysysAgent.encrypt = AnalysysEncryption;
app.js调用以下方法
let App = AnalysysAgent.App
App({
onLaunch:function(){
// 相关操作
}
})
在各个 Page 内通过以下代码获取 AnalysysAgent_WX_SDK 全局函数:
let AnalysysAgent = wx.AnalysysAgent;
let Page = AnalysysAgent.Page
Page({
onShow: function () {
// 相关操作
}
})
在组件Component 内通过以下代码获取 AnalysysAgent_WX_SDK 全局函数:
let AnalysysAgent = wx.AnalysysAgent;
注：组件绑定的 behaviors.js 内的方法，全埋点不支持，不能上报。
注意：
1.将 appkey 的值填入您具体的项目 appkey
2.目录为您所引入微信小程序 SDK 的具体目录
3.请使用SDK所提供的App方法
4.请使用SDK所提供的Page方法
- appkey(必须) 在网站获取的 AppKey
- debugMode 设置调试模式：0 - 关闭调试模式(默认)；1 - 开启调试模式，数据不入库；2 - 开启调试模式，数据入库
- uploadURL(必须) 自定义上传地址
- auto 设置打开/关闭自动采集页面：false - 关闭自动采集；true - 开启自动采集(默认)
- autoProfile 设置是否追踪新用户的首次属性：false - 不追踪新用户的首次属性；true - 追踪新用户的首次属性(默认)
- encryptType 设置是否对上传数据加密：0 - 对上传数据不加密(默认)；1 - 对上传数据进行AES 128位ECB加密；2 对上传数据进行AES 128位CBC加密
- autoShare 设置是否自动采集分享按钮点击事件：false(默认) - 关闭自动采集分享按钮点击事件；true - 开启自动采集分享按钮点击事件
- allowTimeCheck 设置是否开启时间校准：false(默认) - 关闭时间校准；true - 开启时间校准
- maxDiffTimeInterval 设置最大时间校准分为：30s(默认) ，当设置的时间差值小于他，将不开启校准。否则将会进行时间校准。假如设置成为负值，将默认为 30s。
- autoTrack 设置是否开启全埋点,false - 不开启全埋点(默认)；true - 开启全埋点；开启全埋点将会上报 所有绑定（支持tab、longtab、longpress）事件,并上报$user_click事件,设置data-content为采集的
$element_content、data-type为采集的$element_type、data-name为采集的$element_name、id为采集的$element_id。若不设置Data属性会导致无法采集预制属性。不支持系统方法包括生命周期事件的上报，如果要采集tabbar切换，务必在注册Page的时候注册OnTabItemTap方法，否则采集不到。 - autoCompleteURL 设置是否采集完整URL,true - 采集URL包括参数(默认)；false - 采集URL不包括参数;
appkey 在网站获取的 AppKey。
- value 在网站获取的 AppKey。类型:String。取值长度 1 - 255字符。
// 设置key，77a52s552c892bn442v721为样例数据，请根据实际情况替换相应内容
AnalysysAgent.appkey = "77a52s552c892bn442v721"
debugMode 调试模式为接入 JS SDK 后进行数据调试的主要手段。可实时验证 JS SDK 数据监测的正确与否。
- 0 关闭调试模式(默认)。类型：Number。
- 1 开启调试模式，数据不入库。类型：Number。
- 2 开启调试模式，数据入库。类型：Number。
//开启调试模式且数据不入库
AnalysysAgent.debugMode = 1
//开启调试模式且数据入库
AnalysysAgent.debugMode = 2
//关闭调试模式
AnalysysAgent.debugMode = 0
//或删除该段代码
或删除 debugMode 参数。
uploadURL 为自定义上传地址，参数设置后，所有事件信息将上传到该地址。
- value 类型：String。数据上传地址，格式为 scheme://host + :port(不包含/后的内容)。scheme 必须以 http:// 或 https:// 开头，host 只支持域名和 IP，取值长度 1 - 255字符，port 端口号必须携带
//设置自定义上传地址为 scheme://host + :port
AnalysysAgent.uploadURL = "/*设置为实际地址*/"
auto 为设置打开/关闭自动采集页面的参数。可根据自身需要进行更改。
- true 开启自动采集页面打开事件(默认)。类型：Boolean。
- false 关闭自动采集页面打开事件。类型：Boolean。
//关闭自动采集页面打开事件，关闭后可使用微信小程序 SDK的API中的手动发送页面打开数据方法，来发送页面打开状态的数据。
AnalysysAgent.auto = false
//开启自动采集页面打开事件。
AnalysysAgent.auto = true //或删除该行代码。
autoProfile 为设置是否追踪新用户的首次属性。可根据自身需要进行更改。
- true 追踪新用户的首次属性(默认)。类型：Boolean。
- false 不追踪新用户的首次属性。类型：Boolean。
//不追踪新用户的首次属性，新用户首次打开网站不上传新用户的首次属性。
AnalysysAgent.autoProfile = false
//追踪新用户的首次属性，新用户首次打开网站上传新用户的首次属性。
AnalysysAgent.autoProfile = true//或删除该行代码。
encryptType 为设置数据上传时的加密方式,目前只支持 AES 加密，如不设置此参数，数据上传不加密。。可根据自身需要进行更改。
- 0 对上传数据不加密(默认)。类型：Number。
- 1 对上传数据 AES 加密。类型：Number。
//对上传数据不加密。
AnalysysAgent.encryptType = 0//或删除该行代码。
//对上传数据AES加密。
AnalysysAgent.encryptType = 1
autoShare 为设置是否自动采集分享按钮点击事件，只采集分享按钮的点击事件，不区分分享是否成功。可根据自身需要进行更改。
- false 关闭自动采集分享按钮点击事件(默认)。类型：Boolean。
- true 自动采集分享按钮点击事件。类型：Boolean。
//关闭自动采集分享按钮点击事件。
AnalysysAgent.autoShare = false//或删除该行代码。
//自动采集分享按钮点击事件。
AnalysysAgent.autoShare = true
allowTimeCheck 为设置是否开启时间校准，开启时间校准在debug 1或者 2 的情况下会有相关提示。
- false 关闭时间校准(默认)。类型：Boolean。
- true 开启时间校准。类型：Boolean。
//关闭时间校准。
AnalysysAgent.allowTimeCheck = false//或删除该行代码。
//开启时间校准。
AnalysysAgent.allowTimeCheck = true
maxDiffTimeInterval 为设置不校准时间的最大时间差值。当客户端时间和服务端时间相差在此区间内，将不进行时间校准，否则将进行时间校准。
- value：类型 Number 。默认值 30。单位：秒。
//设置最大允许时间
AnalysysAgent.maxDiffTimeInterval = 20
//当服务端和客户端的时间差超过 20s 将进行时间校准
开启全埋点后会自动采集可触控元素(支持：tab类型、longtab类型、longpress类型),并上报
$user_click事件。自动采集时需要设置Data类型属性，若不设置Data属性会导致无法采集预制属性，设置data-content为采集的
$element_content、data-type为采集的$element_type、data-name为采集的$element_name、id为采集的$element_id。不支持系统方法包括生命周期事件的上报，如果要采集tabbar切换，务必在注册Page的时候注册OnTabItemTap方法，否则采集不到。
- false 关闭全埋点采集(默认)。类型：Boolean。
- true 开启全埋点采集。类型：Boolean。
//关闭全埋点
AnalysysAgent.autoTrack = false //或删除该行代码。
//开启全埋点
AnalysysAgent.autoTrack = true
autoCompleteURL
autoCompleteURL 设置是否采集完整URL,true - 采集URL包括参数(默认)；false - 采集URL不包括参数;
- true 开启采集URL包括参数(默认)
- false 开启采集URL不包括参数
//开启采集完整URL
AnalysysAgent.autoCompleteURL = true //或删除该行代码。
//关闭采集完整URL
AnalysysAgent.autoCompleteURL = false
登录微信公众平台，设置>开发设置>服务器域名>request 合法域名，加入您所配置的
https 域名：https://xxx.xxx.xxx
微信小程序只容许https默认端口（443）进行数据访问，请注意方舟上报端口为默认端口。否则数据将无法上报。
页面跟踪，SDK 默认设置跟踪所有页面，支持自定义页面信息。接口如下：
AnalysysAgent.pageView(pageName);
AnalysysAgent.pageView(pageName, properties);
- pageName：页面标识，为字符串，取值长度 1 - 255字符
- properties：页面信息，为K-V键值对，最多包含100条，且
key是以字母开头的字符串，必须由 字母、数字、下划线组成，字母不区分大小写，不支持 乱码、中文、空格等，长度范围1-99字符；value支持类型：String/Number/Boolean/JSON/内部元素为String的Array，若为字符串，长度范围1-255字符。
示例：
// 正在开展某个活动，需要统计活动页面；
AnalysysAgent.pageView("活动页");
......
// 访问手机活动页面，活动页面内容为优惠出售iPhone手机，手机价格为5000元
var properties ={
"commodityName": "iPhone",
"commodityPrice": 8000
}
AnalysysAgent.pageView("商品页", properties);
用户行为追踪，可以设置自定义属性。接口如下：
AnalysysAgent.track(eventName, eventInfo)
- eventName：自定义事件ID标识，以字母开头的字符串，必须由字母、数字、下划线组成，$ 开头为预置事件/属性，不支持乱码、中文、空格等，长度范围1-99字符。
- eventInfo：定义属性，K-V键值对，用于对事件的描述。最多包含100条，且
key是以字母开头的字符串，必须由 字母、数字、下划线组成，字母不区分大小写，不支持 乱码、中文、空格等，长度范围1-99字符；value支持类型：String/Number/Boolean/JSON/内部元素为String的Array，若为字符串，长度范围1-255字符。
示例：
// 添加事件
AnalysysAgent.track("back");
......
// 用户购买手机
var eventInfo = {
"type":"Phone",
"name":"Apple iPhone8",
"money":4000,
"count":1
}
AnalysysAgent.track("buy", eventInfo);
注册页面自动采集自定义属性，建议在页面的生命周期 onShow 中注册（保证每次页面打开都注册生效，自动采集也是在页面的 onShow 中调用的），或者根据需要在自动采集上报之前注册，否则当前页面的自动采集不会携带注册的属性，会携带在下次自动采集上面。
AnalysysAgent.pageProperty(properties)
- properties：页面信息，K-V键值对，最多包含100条，且
key是以字母开头的字符串,必须由 字母、数字、下划线组成，字母不区分大小写，不支持 乱码、中文、空格等，长度范围1-99字符；value支持类型：String/Number/Boolean/JSON/内部元素为String的Array，若为字符串，长度范围1-255字符。
示例：
Page({
onShow:function(){
// 为当前自动采集的页面添加页面标题
var properties ={
$title:'详情页'
}
AnalysysAgent.pageProperty(properties);
}
})
采集分享按钮点击事件，只采集分享按钮的点击事件，不区分分享是否成功。方法返回 对象（toShareProperties）。接口如下：
AnalysysAgent.share(toShareProperties,trackProperties);
- toShareProperties(可选)，分享属性，包括自定义title等，不写将全部用微信默认。
- trackProperties（可选），分享事 件自定义属性。K-V键值对，最多包含100条，且
key是以字母开头的字符串，必须由字母、数字、下划线组成，字母不区分大小写，不支持乱码、中文、空格等，长度范围1-99字符；value支持类型：String/Number/Boolean/JSON/内部元素为String的Array，若为字符串，长度范围1-255字符。
示例：
// 自动采集，设置autoShare为true和分享属性即可
Page({
onShareAppMessage:function(){
let toShareProperties = {
title: '自定义转发标题',
path: '/page/user?id=123'
}
return toShareProperties
}
})
// 手动采集，需要关闭自动，设置autoShare 为 false
Page({
onShareAppMessage:function(){
let toShareProperties = {
title: '自定义转发标题',
path: '/page/user?id=123'
}
let trackProperties = {
custom:'weChat'
}
return AnalysysAgent.share(toShareProperties,trackProperties);
}
})
用户 id 关联接口。将需要绑定的用户ID 和匿名ID进行关联，计算时会认为是一个用户的行为。接口如下：
AnalysysAgent.alias(aliasId);
- aliasId：需要关联的用户ID。 取值长度 1 - 255字符,支持类型：String
示例：
// 登陆账号时调用，只设置当前登陆账号即可和之前行为打通
AnalysysAgent.alias("sanbo");
唯一匿名ID标识设置，接口如下：
AnalysysAgent.identify(distinctId);
- distinctId：自定义设备身份标识，取值长度 1 - 255字符,支持类型：String
示例:
// 设置匿名ID为`fangke009901`,注意此方法需要在初始化之后优先调用
AnalysysAgent.identify("fangke009901");
获取用户通过identify接口设置或自动生成的id，优先级如下： 用户设置的id > 代码自动生成的id
接口如下：
AnalysysAgent.getDistinctId();
示例:
// 获取匿名id
var distinctId = AnalysysAgent.getDistinctId();
用户属性是一个标准的 K-V 结构，K 和 V 均有相应的约束条件，如不符合则丢弃该次操作。
约束条件如下：
属性名称
以字母开头的字符串，必须由字母、数字、下划线组成，字母不区分大小写，$ 开头为预置事件/属性，不支持乱码、中文、空格等，长度范围1-99字符。
属性值
支持部分类型：String/Number/Boolean/内部元素为String的Array；若为字符串，则取值长度 1 - 255字符；若为 Array 或 JSON，则最多包含 100条，且 key 约束条件与属性名称一致，value 取值长度 1 - 255字符
设置用户的固有属性，只在首次设置时有效的属性。 如：应用的激活时间、首次登录时间等。如果被设置的用 户属性已存在，则这条记录会被忽略而不会覆盖已有数据，如果属性不存在则会自动创建。接口如下：
AnalysysAgent.profileSetOnce(propertyName, propertyValue);
AnalysysAgent.profileSetOnce(property);
- propertyName ：属性名称，约束见属性名称
- propertyValue ：属性值，约束见属性值
- property ： 属性列表，约束见属性名称，属性值
示例：
// 设置用户激活时间
AnalysysAgent.profileSetOnce("activationTime", "2018-06-18 18:18:18.188");
// 设置用户性别和出生时间
var setOnceProfile = {
"birth": "2018-06-18 18:18:18.188",
"sex": "male"
}
AnalysysAgent.profileSetOnce(setOnceProfile);
给用户设置单个或多个属性，如果之前不存在，则新建，否则覆盖。接口如下：
//设置单个用户属性
AnalysysAgent.profileSet(propertyName, propertyValue);
//设置多个用户属性
AnalysysAgent.profileSet(property);
- propertyName ：属性名称，约束见属性名称
- propertyValue ：属性值，约束见属性值
- property ： 属性列表，约束见属性名称，属性值
示例：
//设置用户的邮箱地址为[email protected]
AnalysysAgent.profileSet("Email", "[email protected]");
......
// 设置用户的邮箱和微信
var property = {
"Email" : "[email protected]",
"WeChatID" : "weixinhao"
}
AnalysysAgent.profileSet(property);
设置用户属性的相对变化值(相对增加，减少)，只能对数值型属性进行操 作，如果这个 Profile之前不存在，则初始值为0。接口如下：
AnalysysAgent.profileIncrement(propertyName, propertyNumber)
AnalysysAgent.profileIncrement(property);
- propertyName ：属性名称，约束见属性名称
- propertyValue ：属性值，约束见属性值
- property ： 属性列表，约束见属性名称，属性值
示例：
//用户增加一岁
AnalysysAgent.profileIncrement("age",1);
......
//用户玩某个游戏时间增加一年，游戏等级增加2
var incrementProfile = {
"gameAge":1,
"gameRating":2
}
AnalysysAgent.profileIncrement(incrementProfile);
用户列表属性增加元素。接口如下：
//增加单个属性
AnalysysAgent.profileAppend(propertyName, propertyValue);
//增加多个属性
AnalysysAgent.profileAppend(propertyValue);
//增加多个属性
AnalysysAgent.profileAppend(propertyName, propertyValue);
- propertyName：属性名称，约束见属性名称
- propertyValue：属性值，约束见属性值
示例：
// 增加用户爱好 music
AnalysysAgent.profileAppend("hobby", "Music");
// 增加多个用户属性
var map = {
"hobby": "PlayBasketball",
"sports": "Run"
};
AnalysysAgent.profileAppend(mContext, map);
//增加多个用户爱好
var list = ["PlayBasketball", "music"];
AnalysysAgent.profileAppend("hobby", list);
删除已设置的用户属性值。接口如下：
AnalysysAgent.profileUnset(propertyName);
AnalysysAgent.profileDelete();
- propertyName：属性名称，约束见属性名称
示例：
// 删除当前用户单个属性值
AnalysysAgent.profileUnset( "age");
// 删除当前用户所有属性值
AnalysysAgent.profileDelete();
通用属性是每次上传事件信息都会带有的属性，通用属性是一个标准的 K-V 结构，K 和 V 均有相应的约束条件，如不符合则丢弃该次操作。
约束条件如下:
属性名称
以 字母开头的字符串，必须由字母、数字、下划线组成，字母不区分大小写，$ 开头为预置事件/属性，不支持乱码、中文、空格等，长度范围1-99字符。
属性值
支持部分类型：String/Number/boolean/内部元素为String的Array；若为字符串，则取值长度 1 - 255字符；若为 Array 或 JSON,则最多包含 100条，且 key 约束条件与属性名称一致，value 取值长度 1 - 255字符
某一个体，在固定范围内，持续拥有的属性，每次数据上传都会携带。接口如下:
AnalysysAgent.registerSuperProperty(superPropertyName , superPropertyValue );
AnalysysAgent.registerSuperProperties(superProperty);
- superPropertyName：属性名称，约束见属性名称
- superPropertyValue：属性值，约束见属性值
- superProperty：属性列表，约束见属性名称，属性值
示例：
// 在某视频平台，购买一年会员，该年内只需设置一次即可
AnalysysAgent.registerSuperProperty("member","VIP");
......
// 小明在20岁的时候，购买了一年腾讯会员
var property = {
"platform":"TX",
"age":"20",
"member":"VIP",
"user":"xiaoming"
}
AnalysysAgent.registerSuperProperties(property);
根据属性名称，删除已设置过的通用属性。接口如下：
//删除单个通用属性
AnalysysAgent.unRegisterSuperProperty(superPropertyName);
//清除所 有通用属性
AnalysysAgent.clearSuperProperties();
- superPropertyName：属性名称，约束见属性名称
示例：
// 删除已经设置的用户年龄属性
AnalysysAgent.unRegisterSuperProperty("age");
......
// 清除所有已经设置的通用属性
AnalysysAgent.clearSuperProperties();
查询获取通用属性。接口如下：
// 获取单个通用属性
AnalysysAgent.getSuperProperty(superPropertyName);
// 获取所有的通用属性
AnalysysAgent.getSuperProperties();
- superPropertyName：属性名称，约束见属性名称
示例：
// 查看已经设置的"member"的通用属性
AnalysysAgent.getSuperProperty("member");
......
// 查看所有已经设置的通用属性
AnalysysAgent.getSuperProperties();
获取预置属性。接口如下：
AnalysysAgent.getPresetProperties();
示例：获取预置属性
// 获取预置属性
var presetProperties = AnalysysAgent.getPresetProperties();
console.log('预置属性:', presetProperties)
清除本地现有的设置（包括 id 和通用属性）重新开始统计。接口如下：
AnalysysAgent.reset();
示例：清除本地现有的设置，包括id和通用属性
// 删除设置的id和通用属性
AnalysysAgent.reset();
最近更新 3yr ago