# 视频号直播分享归因

# wx.getChannelsShareKey()

获取分享信息。字段为空时说明无分享信息。

此接口在同时满足以下三点要求时,会返回分享信息:

  1. 用户通过视频号直播间分享卡片、直播间商品分享卡片、橱窗分享卡片、橱窗商品分享卡片进入小程序
  2. 该视频号为小程序推广员或者与小程序同超管的视频号
  3. 分享该视频号的用户,为小程序的分享员

注:此接口需要基础库版本 2.22.1 以上

# 回调函数

Object res

属性 类型 说明
sharerOpenId string 分享员openid
promoter Promoter 推广员信息

Object Promoter

属性 类型 说明
finderNickName string 推广员视频号昵称
promoterId string 推广员唯一id
promoterOpenId string 推广员openid

# 示例:

wx.getChannelsShareKey({
  success(res){
    var sharerOpenId = res.sharerOpenId
    var promoterInfo = res.promoter
  },
  fail(res) {
    console.log('getChannelsShareKey fail', res)
  }
})

# 新建分享卡片事件

要接收到新建分享卡片事件,除了要满足wx.getChannelsShareKey()接口描述的条件外,还需要满足:

分享卡片的分享员只绑定了一个小程序

# 请求参数示例

<ToUserName>gh_abcdefg</ToUserName> 
<FromUserName>1asdaf2141noejgeroig_0</FromUserName> 
<CreateTime>12344555555</CreateTime>
<MsgType>event</MsgType> 
<Event>miniprogram_sharer_action</Event>
<type>1</type>
<openid>ogewrgsragasrg</openid>
<promoter>
    <finder_nickname>XXXXXXXXXXXXXX</finder_nickname>
    <promoter_id>a-**************po</promoter_id>
    <promoter_openid>osagsadfasdfas</promoter_openid>
</promoter>

# 回包示例

success

# 请求参数说明

参数 类型 说明
ToUserName string 商家小程序名称
FromUserName string 发送方OpenID
CreateTime number 事件时间,Unix时间戳
MsgType string 消息类型,固定为 event
Event string 事件类型,本接口固定为 miniprogram_sharer_action
type number 分享员操作类型,枚举值:1 - 分享员分享直播间(生成分享卡片) 2 - 分享商品卡 3 - 分享橱窗页
openid string 分享员openid
promoter.finder_nickname string 分享的视频号昵称
promoter.promoter_id string 分享的视频号唯一ID
promoter.promote_openid string 分享的视频号超管openid

# 回包参数说明

只需直接返回字符串success。

# 设置小程序分享模式

用于更改小程序分享模式,小程序默认使用分享员模式,可以更改为使用分享归因模式。

使用分享归因模式的小程序在小程序联盟的直播间分享员功能中对分享员是不可见,微信侧也不会统计并展示该小程序的分享员带货数据

# 接口请求调用说明

http请求方式:POST
https://api.weixin.qq.com/shop/sharer/set_share_mode?access_token=xxxxxxxxx

# 请求参数说明

{
    "share_mode": 2
}

# 回包示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 请求参数说明

属性 类型 说明
sharer_mode number 1-分享员 2-分享归因

# 回包参数说明

属性 类型 说明
errcode number 通用错误码
errmsg string 错误信息

# 通用错误码

枚举值 说明
0 设置成功
1310005 更改过于频繁,两次更改间隔不能短于30天