# Taro
1.通过npm安装SDK
npm i sr-sdk-wxapp
在 app.jsx 中通过 import 引入 SDK
import sr from 'sr-sdk-wxapp'
# 2.添加可信域名
登录微信公众平台 (opens new window),进入<开发><开发设置><服务器域名>,将 https://zhls.qq.com
添加为 request 合法域名。
在开发环境中还有SDK版本检查,所以会提示 https://sr-home-1257214331.cos.ap-guangzhou.myqcloud.com 不在以下 request 合法域名列表中
, 可以通过设置不校验域名来处理。
# 3.init 初始化
# init(options: object)
配置接口,用来调整SDK的基础机制。应该在App()
调用之前调用。
首次调用初始化SDK,再次调用覆盖之前传入的配置,可多次调用。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
appid | string | Y | 微信小程序appId |
token | string | Y | 通过接入申请后,有数提供的凭证字符串 |
usePlugin | bool | 是否使用了小程序插件,默认是:false | |
debug | bool | 是否打印日志,默认是:false | |
openSdkShareDepth | bool | 是否打开分享链路记录功能,默认值为false,打开后,将记录用户分享链路A->B->C->D。(老版本参数,建议用autoProxy参数配置) | |
serverUrl | string | 传入自定义的后台上报接口,若传入则token将无意义, 默认是:'https://zhls.qq.com/api/report' | |
trackApp | bool | 是否开启自动跟踪APP的曝光事件(APP相关预置事件,如 APP - onLuanch),默认是:true。(老版本参数,建议用autoProxy参数配置) | |
proxyPage | bool | 是否开启自动代理 Page,默认是:false。SDK 负责上报页面的 browse 、leave、share 等事件可以使用 sr.page 代替 Page(sr.page(options))(老版本参数,建议用autoProxy参数配置) | |
autoStart | bool | 是否开启自动开始上报,默认是:true,open_id 可自动获取,一般在 login 业务之后手动调用 sr.startReport 方法开启上报 | |
autoProxy | bool | object | 是否开启自动代理,从v1.8.6版本开始新增的自动代理配置参数,建议使用该参数 |
# 示例
import sr from 'sr-sdk-wxapp'
sr.init({
/**
* 有数 - ka‘接入测试用’ 分配的 app_id,对应的业务接口人负责
*/
token: 'bi72fccc7184ef4xxx',
/**
* 微信小程序appID,以wx开头
*/
appid: 'wx195745e8e342bxxx',
/**
* 如果使用了小程序插件,需要设置为 true
*/
usePlugin: false,
/**
* 开启打印调试信息, 默认 false
*/
debug: true,
/**
* 建议开启-开启自动代理 Page, 默认 false
* sdk 负责上报页面的 browse 、leave、share 等事件
* 可以使用 sr.page 代替 Page(sr.page(options))
* 元素事件跟踪,需要配合 autoTrack: true
*/
proxyPage: true,
/**
* 建议开启-开启组件自动代理, 默认 false
* sdk 负责上报页面的 browse 、leave、share 等事件
*/
proxyComponent: true,
// 建议开启-是否开启页面分享链路自动跟踪
openSdkShareDepth: true,
// 建议开启-元素事件跟踪,自动上报元素事件,入tap、change、longpress、confirm
autoTrack: true,
//建议开启-自动化获取openId,授权过的小程序可自动化获取openId
openAutoTrackOpenId: true,
//开启自动代理,此功能为有数 SDK 核心功能,建议开启,开启前请完成「小程序授权」操作,详见下文“init 参数说明”部分
autoProxy: {
//开启后代理采集启动应用事件,默认为true
app_launch: true,
//开启后代理采集显示应用事件,默认为true
app_show: true,
//开启后代理采集隐藏应用事件,默认为true
app_exit: true,
//开启后代理采集浏览页面事件,默认为true
browse_page: true,
//开启后代理采集离开页面事件,默认为true
leave_page: true,
//开启后代理采集元素事件,v2.0.0版本之前默认为true,v2.0.0版本之后默认为false
autoTrack: false,
//开启后代理采集下拉刷新页面事件,v2.0.0版本之前默认为true,v2.0.0版本之后默认为false
page_pull_down_refresh: false,
//开启后代理采集上拉触底页面事件,默认为true
page_reach_bottom: true,
//开启后代理采集分享页面事件,默认为true
page_share_app_message: true,
//开启后自动采集openid,默认为true
openAutoTrackOpenId: true,
//开启后自动采集unionId,默认为true
openAutoTrackUnionId: true,
//开启后自动采集分享裂变,默认为true
openSdkShareDepth: true,
}
})