Skip to content

analysys/ans-wechat-sdk

Repository files navigation

易观方舟 asd-wechat-sdk NPM version License GitHub release

安装

$ npm install asd-wechat-sdk --save 

微信小程序 SDK 基础说明

快速集成

引入sdk模块并初始化
import AnalysysAgent from "asd-wechat-sdk"

//初始化
AnalysysAgent.init({
  appkey: '',
  uploadURL: ''
})
初始化参数说明
参数 是否必须 类型 默认值 说明
appkey string - 在网站获取的AppKey
uploadURL string - 自定义上传地址
debugMode number 0 0: 关闭调试模式;1 - 开启调试模式,数据不入库;2 - 开启调试模式,数据入库
autoProfile boolean true 设置是否追踪新用户的首次属性
encryptType number 0 设置是否对上传数据加密:0 - 对上传数据不加密(默认);1 - 对上传数据进行AES 128位ECB加密;2 对上传数据进行AES 128位CBC加密
allowTimeCheck boolean false 设置是否开启时间校准
maxDiffTimeInterval number 30 设置最大时间校准分为:30s(默认) ,当设置的时间差值小于他,将不开启校准。否则将会进行时间校准。假如设置成为负值,将默认为 30s。
autoTrack boolean false 设置是否开启全埋点,开启全埋点将会上报所有绑定(支持tab、longtab、longpress)事件,并上报$user_click 事件,设置data-content为采集的 $element_content、data-type为采集的 $element_type、data-name为采集的$element_name、id为采集的$element_id。不设置采集不到。不支持系统方法包括生命周期事件的上报,如果要采集tabbar切换,务必在注册Page的时候注册OnTabItemTap方法,否则采集不到。
autoCompleteURL boolean true 设置是否采集完整URL,true - 采集URL包括参数;false - 采集URL不包括参数
autoPageViewDuration boolean false 是否采集页面离开事件

通过以上步骤您即可验证SDK是否已经集成成功,更多Api使用方法参考:易观方舟 wechat SDK 文档

注意 SDK 可能不完全向前兼容,请查看版本更新说明 Release及版本升级记录。如果有说明不兼容的话,需要升级易观方舟对应的版本。 请根据需要前往 Release 里下载对应的文件

版本升级记录

请参见 Release及版本升级记录

禁止一切基于易观方舟 wechat 开源 SDK 的所有商业活动!


NPM downloads