微信小程序通用框架版

在集成微信小程序通用框架SDK之前，请先下载SDK

SDK发行包下载:

Github地址（推荐）: Gitee地址: 版本包含更新说明，请阅读该说明，请参阅此文档以进行接口使用.

由于框架的特殊性，小应用程序的全局方法App不允许重写. 因此，启动界面需要由开发人员手动调用. 如果开发人员在调用开始之前调用pageView或track，则这两种方法将生成一个sessionId，并且该调用将生成一个新的sessionId. 将导致sessionId被削减. 开发人员应避免这类事情，以免统计不准确. 另外，必须对启动进行调整，否则将不会收集诸如UTM之类的参数.

此外，框架模块不包括自动收集功能，开发人员需要手动调用pageView（）进行收集.

请根据您的业务需求参考相关的SDK.

如果您是第一次使用Analysys Ark产品，则可以通过阅读本文来快速了解该产品

在app.js文件顶部介绍SDK.

通过初始化代码的配置参数配置Aey.

通过uploadURL配置参数uploadURL设置上传数据的地址.

登录微信公众平台，将上传地址域名配置为请求合法域名.

通过手动掩埋点设置要收集的页面或事件.

通过设置Ddebug模式，打开/关闭日志以查看日志.

您可以通过上述6个步骤来验证SDK是否已成功集成. 有关更多接口说明，请查看API文档.

使用NPM集成SDK，请参考代码:

npm install ans-wechat-sdk --save
​
// 非es6 
var AnalysysAgent = require("ans-wechat-sdk");
// 小程序提供了加密模块 根据自己需要引入
var AnalysysEncryption = require('ans-wechat-sdk/sdk/AnalysysAgent_encryption.min.js');
// sdk 与 加密模块关联
AnalysysAgent.encrypt = AnalysysEncryption;
​
// es6 
import AnalysysAgent from "ans-wechat-sdk"
import AnalysysEncryption  from 'ans-wechat-sdk/sdk/AnalysysAgent_encryption.min.js';
AnalysysAgent.encrypt = AnalysysEncryption;
​
AnalysysAgent.aey = "/*设置为实际AEY*/" //AEY
App({
    onShow : function( options ){
        //设置微信小程序启动事件,并传输UTM等参数
        AnalysysAgent.appStart(options)
    }
});

使用源文件进行集成，并将AnalysysAgent_WX_SDK.cunstom.min.js或AnalysysAgent_WX_SDK.cunstom.es6.min.js文件放置在applet目录中

将以下代码添加到小程序的app.js文件的第一行:

let AnalysysAgent = require("./build/AnalysysAgent_WX_SDK.cunstom.min.js")
AnalysysAgent.aey = "/*设置为实际AEY*/" //AEY
App({
    onShow : function( options ){
        //设置微信小程序启动事件,并传输UTM等参数
        AnalysysAgent.appStart(options)
    }
});

如果您需要加密模块

let AnalysysEncryption = require("./build/AnalysysAgent_encryption.min.js")
AnalysysAgent.encrypt = AnalysysEncryption

对于使用es6版本的用户

import AnalysysAgent from  './build/build/AnalysysAgent_WX_SDK.custom.es6.min.js';
import AnalysysEncryption from  './build/AnalysysAgent_encryption.es6.min.js';
AnalysysAgent.encrypt = AnalysysEncryption;
​
//es6版本不是每个框架都能用，不能使用es6的请如下 使用
import AnalysysAgent  from "./build/AnalysysAgent_WX_SDK.custom.min.js"
AnalysysAgent.aey = "/*设置为实际AEY*/" //AEY

通过每个页面中的以下代码获取AnalysysAgent_WX_SDK全局函数:

let AnalysysAgent = wx.AnalysysAgent;
Page({
    onShow : function( options ){
        //设置微信小程序启动事件
        AnalysysAgent.pageView('首页')
    }
})

注意:

1. 将aey的值填写到您的特定项目aey中

2. 该目录是您引入的微信小程序SDK的特定目录

在网站上获得的aey Aey.

// 设置key，77a52s552c892bn442v721为样例数据，请根据实际情况替换相应内容
AnalysysAgent.aey = "77a52s552c892bn442v721"

debugMode调试模式是访问JS SDK后进行数据调试的主要方法. 可以实时验证JS SDK数据监控的正确性.

//开启调试模式且数据不入库
AnalysysAgent.debugMode = 1
//开启调试模式且数据入库
AnalysysAgent.debugMode = 2
//关闭调试模式
AnalysysAgent.debugMode = 0
//或删除该段代码

或删除debugMode参数.

uploadURL是自定义上传地址. 设置完参数后，所有事件信息都将上传到该地址.

//设置自定义上传地址为 scheme://host + :port
AnalysysAgent.uploadURL = "/*设置为实际地址*/"

autoProfile用于设置是否跟踪新用户的第一个配置文件. 可以根据自己的需要进行更改.

//不追踪新用户的首次属性，新用户首次打开网站不上传新用户的首次属性。
AnalysysAgent.autoProfile = false
//追踪新用户的首次属性，新用户首次打开网站上传新用户的首次属性。
AnalysysAgent.autoProfile = true//或删除该行代码。

encryptType用于设置上传数据时的加密方法. 当前，仅支持AES加密. 如果未设置此参数，则不会加密数据上传. . 可以根据自己的需要进行更改.

//对上传数据不加密。
AnalysysAgent.encryptType = 0//或删除该行代码。
//对上传数据AES加密。
AnalysysAgent.encryptType = 1

allowTimeCheck用于设置是否启用时间校准. 对于调试1或2，启用时间校准将具有相关提示.

//关闭时间校准。
AnalysysAgent.allowTimeCheck = false//或删除该行代码。
//开启时间校准。
AnalysysAgent.allowTimeCheck = true

maxDiffTimeInterval用于设置未校准时间的最大时差. 如果客户端时间和服务器时间之间的差在此时间间隔内，则不会执行时间校准，否则将执行时间校准.

//设置最大允许时间
AnalysysAgent.maxDiffTimeInterval = 20 
//当服务端和客户端的时间差超过 20s 将进行时间校准 

登录微信公众平台，设置>开发设置>服务器域名>请求合法域名，添加配置的https域名:

微信小程序仅允许https默认端口（443）进行数据访问. 请注意微信通用版本，方舟报告端口是默认端口. 否则，将不会报告数据.

启动事件appStart（选项），框架版本的SDK启动事件需要手动调用，并且只能调用一次.

AnalysysAgent.appStart(options);

示例:

//框架taro:
​
    componentDidShow () {
        const params = this.$router.params
        AnalysysAgent.appStart(params);
    }
​
//框架mpvue:
​
    onLaunch (options) {
        AnalysysAgent.appStart(options);
    },

页面跟踪，SDK默认设置跟踪所有页面，支持自定义页面信息. 界面如下:

AnalysysAgent.pageView(pageName);
AnalysysAgent.pageView(pageName, properties);

示例:

// 正在开展某个活动，需要统计活动页面；
AnalysysAgent.pageView("活动页");
​
......
​
// 访问手机活动页面，活动页面内容为优惠出售iPhone手机，手机价格为5000元
var properties ={
    "commodityName": "iPhone",
    "commodityPrice": 8000
}
​
AnalysysAgent.pageView("商品页", properties);

用户行为跟踪，可以设置自定义属性. 界面如下:

AnalysysAgent.track(eventName, eventInfo)

示例:

// 添加事件
AnalysysAgent.track("back");
​
......
​
// 用户购买手机
var eventInfo = {
    "type":"Phone",
    "name":"Apple iPhone8",
    "money":4000,
    "count":1
}
AnalysysAgent.track("buy", eventInfo);

已注册应用程序中所有页面的通用属性. 设置后，小程序启动后，直到小程序关闭，所有页面都将具有此属性. 界面如下:

AnalysysAgent.appProperty(properties)

示例:

// 设置被分享页面所属分享群ID
var properties ={
    openGId:'123456789'
}
​
AnalysysAgent.appProperty(properties);

收集共享按钮单击事件，仅收集共享按钮单击事件，不区分共享是否成功. 该方法返回对象（toShareProperties）. 界面如下:

AnalysysAgent.share(toShareProperties,trackProperties);

本文来自电脑杂谈，转载请注明本文网址：
http://www.pc-fly.com/a/sanxing/article-207489-1.html