1.2.2 • Published 2 years ago

sdk-miniapp-vv v1.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

接入准备

接入指引

  • 方式一:yarn 引入 yarn add sdk-miniapp-vv
  • 方式二:git 拉代码,执行yarn yarn build 打包到 dist 目录下 , 将 index.js 拷贝到自己项目中使用

公共属性

公共属性是各个行为数据规范的相同部分,包含行为时间、行为页面、行为人、行为产生的来源渠道,行为产生的来源页面组件等维度。

数据规范 | 名称 | 类型 | 必填 | 描述 | | --------- | ------ | ---- | -------------------------------------------------------------------- | | app_id | String | Y | 小程序唯一标识 示例值:wx9d4f5f22pa099f82 | | page_title | String | | 行为发生的小程序页面标题 例商品详情、商城首页 | | open_id | String | Y | 微信用户在小程序下的唯一标识符 示例值:ogN6X0T-ilsH-XmIdzXtuR1f1r3Q | | union_id | String | Y | 微信用户在开放平台账号下的唯一标识符 示例值:o6_bmlsdaXds8d6_sgVt7hM3OPfL |

获取 union_id:https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/union-id.html

使用 setUser : 可以补充用户的(open_id、app_id、union_id)

请求示例

let app = getApp();
app.$app.sr.setUser({
  app_id: 'wx9d4f5f22pa099f82',
  open_id: 'ogN6X0T-ilsH-XmIdzXtuR1f1r3Q',
  union_id: 'o6_bmlsdaXds8d6_sgVt7hM3OPfL',
});

初始化

import TezignWxTrack from 'sdk-miniapp-vv';

let sr = new TezignWxTrack();

sr.init({
  app_id: 'wx41eb9a217b06f248', // 微信小程序app_id,以wx开头
  token: 'bi72f*******', // token是唯一必须配置的参数,对应租户id
});

事件类型

用户登录

在用户登录完成回调触发时上报

数据规范

新增属性:无

公共属性 | 名称 | 类型 | 必填 | 描述 | | --------- | ------ | ---- | -------------------------------------------------------------------- | | app_id | String | Y | 小程序唯一标识 示例值:wx9d4f5f22pa099f82 | | page_title | String | | 行为发生的小程序页面标题 例商品详情、商城首页 | | open_id | String | Y | 微信用户在小程序下的唯一标识符 示例值:ogN6X0T-ilsH-XmIdzXtuR1f1r3Q | | union_id | String | Y | 微信用户在开放平台账号下的唯一标识符 示例值:o6_bmlsdaXds8d6_sgVt7hM3OPfL |

请求示例

let app = getApp();
app.$app.sr.track('Content_wxApp_Login', {
  page_route: 'pages/tabBar/index/index',
  page_title: '首页',
  open_id: 'ogN6X0T-ilsH-XmIdzXtuR1f1r3Q',
  union_id: 'o6_bmlsdaXds8d6_sgVt7hM3OPfL',
  // more...
});

用户注册

在用户注册完成回调触发时上报。

新增属性:无

公共属性

数据规范

名称类型必填描述
app_idStringY小程序唯一标识 示例值:wx9d4f5f22pa099f82
page_titleString行为发生的小程序页面标题 例商品详情、商城首页
open_idStringY微信用户在小程序下的唯一标识符 示例值:ogN6X0T-ilsH-XmIdzXtuR1f1r3Q
union_idStringY微信用户在开放平台账号下的唯一标识符 示例值:o6_bmlsdaXds8d6_sgVt7hM3OPfL

请求示例

let app = getApp();
app.$app.sr.track('Content_wxApp_Register', {
  page_route: 'pages/tabBar/index/index',
  page_title: '首页',
  open_id: 'ogN6X0T-ilsH-XmIdzXtuR1f1r3Q',
  union_id: 'o6_bmlsdaXds8d6_sgVt7hM3OPfL',
  // more...
});

页面分享

在小程序页面生命周期回调 Page.onShareAppMessage 触发时上报

数据规范

新增属性:

名称类型必填描述
from_typeenumY转发事件来源。button:页面内转发按钮;menu:右上角转发菜单
share_titleStringY转发标题
share_pathString转发页面路径,不填默认是当前页面
share_image_urlString转发图片路径
share_toString发送目标,friends:好友;timeline:朋友圈

公共属性

名称类型必填描述
app_idStringY小程序唯一标识 示例值:wx9d4f5f22pa099f82
page_titleString行为发生的小程序页面标题 例商品详情、商城首页
open_idStringY微信用户在小程序下的唯一标识符 示例值:ogN6X0T-ilsH-XmIdzXtuR1f1r3Q
union_idStringY微信用户在开放平台账号下的唯一标识符 示例值:o6_bmlsdaXds8d6_sgVt7hM3OPfL

请求示例

let app = getApp();
app.$app.sr.track('Content_wxApp_Share', {
  from_type: 'button',
  share_title: '女士2019新款连帽中长款羽绒服冬季厚款保暖外套',
  share_path: 'pages/product?sku_id=AOdjf7u',
  share_image_url: 'https://pages/product?sku_id=AOdjf7u.jpg',
  share_to: 'friends',
  // more...
});

商品下单

在小程序 JSAPI 下单 获取到预支付交易会话标识(prepay_id)后,

调用 wx.requestPayment 前触发

数据规范 新增属性:

名称类型必填描述
mchidStringY直连商户的商户号,由微信支付生成并下发。示例值:1230000109
order_idStringY商户侧订单号,在商户系统内订单的唯一标识符
sub_ordersarrayY订单的金额等信息,注意为[]结构

sub_orders | 名称 | 类型 | 必填 | 描述 | | ------------ | ------ | ---- | ----------------------------------------------------- | | sub_order_id | array | Y | 同 order_id | | order_amt | array | Y | 填写订单金额,单位默认为元 | | pay_amt | array | Y | 订单应付金额,单位默认为元 |

请求示例

let app = getApp();
app.$app.sr.track('Content_wxApp_Order', {
  mchid: '1230000109', //商户号
  order_id: 'xxxxx', // 商户订单号,商户侧订单号,在商户系统内订单的唯一标识符
  sub_orders: [
    {
      sub_order_id: 'xxxxx',
      order_amt: 30.3,
      pay_amt: 30.3,
    },
  ],
});

支付

后端收到支付成功通知后触发 通过接口上报

上报接口:

数据规范

名称类型必填描述
app_idStringY直连商户申请的公众号或移动应用 app_id。 示例值:wxd678efh567hg6787
mchidStringY商户的商户号,由微信支付生成并下发。示例值:1230000109
order_idStringY主订单 id
order_linearrayY订单列表

order_line

名称类型必填描述
sub_order_idStringY商户系统内部订单号 示例值:1217752501201407033233368018
transaction_idString微信支付系统生成的订单号。 示例值:1217752501201407033233368018
pay_statusStringY交易状态,枚举值:SUCCESS:支付成功 REFUND:转入退款 NOTPAY:未支付 CLOSED:已关闭 PAYERROR:支付失败
open_idStringY下单人 open_id 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
goods_num_totalnumberY订单商品总数量
order_amtStringY订单金额
pay_amtStringY订单应付金额
currencyStringYCNY:人民币,境内商户号仅支持人民币 示例值:CNY
payer_currencyStringY用户支付币种 示例值:CNY
sku_idStringYsku 编号
sku_nameStringYsku 名称
spu_idStringsku 所属 spu 编号
spu_nameStringspu 名称
goods_amountnumberY单件商品原价,单位默认为元
payment_amountStringY多件商品实付金额(分摊了优惠的金额),单位默认为元,注:有数 GMV 计算使用该字段
goods_numnumberY商品数量

请求体示例

如不是合并订单,则子订单号和主订单一致

{
  appid: 'wx41eb9a217b06f248', // 微信小程序appID,以wx开头
  mchid:'1230000109', // 微信支付生成的商户的商户号,由微信支付生成并下发。示例值:1230000109
  order_id: '344522220000',// 主订单id
  order_line:[
    {
      /**订单信息**/
      "sub_order_id": "34452222", // 商户系统内部订单号
      "transaction_id": "1217752501201407033233368018" // 微信支付订单号
      "pay_status": "SUCCESS", // 交易状态 枚举值
      "open_id": "ogN6X0T-ilsH-XmIdzXtuR1f1r3Q", // 下单人 open_id
      "goods_num_total": 3, // 订单商品总数量
      "order_amount": 560.00, // 订单金额
      "pay_amount": 560.00, // 订单应付金额
      "currency": "CNY", // CNY:人民币,境内商户号仅支持人民币
      "payer_currency":"CNY", // 用户支付币种

      /**商品信息**/
      "sku_id": "cS1cWjrkFbFUA", // sku 编号
      "sku_name": "鞋子蓝色", // sku 名称
      "spu_id":"F-306233", // sku 所属 spu 编号
      "spu_name": "鞋子", // spu 名称
      "goods_amount": 60.00, // 不包含件数及不包含均摊优惠的商品金额
      "payment_amount": 110.00, // 包含件数及包含优惠均摊后的金额
      "goods_num": 2, // 商品数量
    }
  ]
}
1.2.0

2 years ago

1.1.1

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.1.0

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago