查看源

一、字段组成

包括两部分：

日志字段：指每次调用SDK时都要传入的参数
日志字段中eventtype&eventargs的取值：根据当前触发的具体事件，传入相应的字段和取值传入

二、日志字段

	字段	要求	描述
1	pfid	必须（1-50位，数字，大小写字母，下划线，短横线）	斐波那契分配的平台id，在作品初始化前端sdk时传入，个人版（或个人帐号业务）共用一个pfid，创建一个新企业分配一个新pfid，如果企业已存在则使用原有pfid
2	appid	必须（1-50位，数字，大小写字母，下划线，短横线）	场景载体id，根据具体产品去做定义，例如：在H5作品中指作品id，在营销插件中指活动id/uuid，在名片初始化前端sdk时传入
3	actid	不必须（0-50位，数字，大小写字母，下划线，短横线）	场景活动id，一般指智客的活动id，由前端sdk从作品url中获取
4	cnl	不必须（0-50位，数字，大小写字母，下划线，短横线）	渠道id
5	localtime	毫秒时间戳	服务器时间，由日志采集后端生成
6	ip	ip地址	客户端ip，由日志采集后端获取
7	eventtype	必须（1-50位，数字，大小写字母，下划线，短横线）	事件类型（见本文档第三部分
8	eventargs	必须（JSON字符串）	事件参数（见本文档第三部分
9	viewid	必须（1-36位，数字，大小写字母，下划线，短横线）	用户id，前端sdk调用后端接口获取。如果接口无响应，前端直接使用已存在的，不存在则随机生成
10	ext	不必须（0-36位，数字，大小写字母，下划线，短横线）	斐波那契公众号的openid，前端sdk调用后端接口获取。如果接口无响应，前端直接使用已存在的，不存在则不传
11	mpid	不必须（0-36位，数字，大小写字母，下划线，短横线）	第三方微信公众号/小程序appid，在作品初始化前端sdk时传入
12	openid	不必须（0-36位，数字，大小写字母，下划线，短横线）	第三方微信公众号获取的用户openid，在作品初始化前端sdk时传入
13	sourceid	不必须（0-36位，数字，大小写字母，下划线，短横线）	分享来源者的viewid，由前端sdk从作品url或小程序path中获取
14	stepid	不必须（0-50位，数字，大小写字母，下划线，短横线）	在智客中指活动环节，在兔展渠道分发中指分发任务id，由前端sdk从作品url中获取
15	cnltype	不必须（0-50位，数字，大小写字母，下划线，短横线）	渠道类型
16	intid	必须（1-36位，数字，大小写字母，下划线，短横线）	场景互动id，前端sdk调用后端接口获取。如果接口无响应，则随机生成
17	apptype	必须（1-50位，数字，大小写字母，下划线，短横线）	斐波那契分配的作品类型id，在作品初始化前端sdk时传入，翻页=multipage，长页=longpage，短视频=shortvideo，拼团=pintuan，抽奖=choujiang，名片=card，早报=zaobao，裂变红包=redpacket，邀请有奖=inviteaward，助力砍价=helpbargain，组队抽奖＝zudui_choujiang2，外部作品=xapp，小游戏=yule，产品=productinfo，上传文件=uploadfiles，上传视频=uploadvideo，若无数据传NULL
18	unionid	不必须（0-36位，数字，大小写字母，下划线，短横线）	微信公众号获取的用户unionid，若明文授权则必须，若静默授权取不到则可不传
19	userid	不必须（1-36位，数字，大小写字母，下划线，短横线）	第三方应用用户id。若是第三方应用，则传第三方应用的userid；若是兔展自身应用则传兔展用户id。根据业务场景做具体定义。
20	audid	不必须（1-36位，数字，大小写字母，下划线，短横线）	客户档案用户id
21	saudid	不必须（1-36位，数字，大小写字母，下划线，短横线）	分享来源者的audid
22	custom	不必须（JSON字符串）	额外的自定义信息，腾讯云可能存在{"projectId":"","subProjectId":"","channelId":""} 20200813 插件平台在json里新增字段 playRecordId 表示插件的参与记录
23	steptype	不必须（1-50位，数字，大小写字母，下划线，短横线） 200317新增	用于区分stepid类型；全员营销的任务定义为tasktype；全员营销的公文包定义为briefcasetype；微信银行的内容频道定义为wenbank；
24	pluginid	不必须（1-36位，数字，大小写字母，下划线，短横线）	插件id
25	pluginname	不必须（1-36位，数字，大小写字母，下划线，短横线）	插件类型

渠道的取值

cnl : 588383274896986112,EMPLOYEE,588425562905907200

cnltype：GROUP,CLASS,MARK

底层会将cnl、cnltype拆开，分别是

cnlgroup:588383274896986112

cnlclass(渠道类型)：EMPLOYEE(员工渠道) 或者是 FIXED(自由渠道)

cnlmark(员工渠道分组)：588425562905907200

三、eventtype&eventargs

1、前端上报的事件字段

浏览view

字段	可能的取值	描述
userInfo	{"city":"长沙","nickname":"nico","sex":1,”openid”:”xx”, "country":"中国","province":"湖南","headimgurl":"xx”}	Userinfo事件信息
isWeixin	true/false(boolean)	是否微信浏览器，检查User-Agent是否包含MicroMessenger
useragent	pc /iphone/ipad/android/WP / Windows/Mac/Linux (string)	设备类型，来自User-Agent
uaVer	安卓手机为安卓系统版本，Windows环境为windows的系统版本	系统版本，来自User-Agent
lc	从0开始(int)	层级参数
shareType	微信网页打开时，取值timeline(朋友圈)，groupmessage(微信群)，singlemessage(好友分享)，gzh(公众号)或者为空字符串	打开来源，微信自动在url中添加的from参数
netType	例如：cmnet，3G，3gnet，WIFI，4G	网络类型，来自User-Agent
appSrc	Weixin(微信)，Weibo(微博)，Qzone(QQ空间)，QQ，NewsArticle(今日头条)，namecard(知客名片)，wxeditor(编辑器小程序)	打开的APP，来自User-Agent。任一插件或小程序都可视为一个第三方app，若通过插件去打开作品，且在统计时要做区分插件和微信网页，那么使用这个参数。
appVer		APP版本，来自User-Agent
screen	例如：1080x1920	屏幕分辨率，宽x高
model	samsung, xiaomi, Huawei, vivo, Meitu, oppo, Coolpad, ASUS, ZTE, HTC, Sony, Lenovo, nubia, meizu, iphoneOther, iphone4x, iphone5x, iphone6x, iphone6xp或者安卓的其他机型信息，可能为空	机型信息，来自User-Agent
mdetail	可能与model相同	型号
build		手机的生产流水，只有手机设备访问才会具有，pc端不具备
url		当前页面url
rurl		当前页面referer

view事件对应的eventargs字段demo:

{"userInfo":{"city":"长沙","nickname":"nico","sex":1,"openid":"ofg8HxKUtmMYevetuDznizwq0HK4","privilege":{},"country":"中国","province":"湖南","headimgurl":"http://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLRib6awmy1QtYT4Xl3rNHI6NWDq9BNNaDAic9VaiccdOsR1cEhOzwwpzcboS8dO3T5UHYOQiaf9yXFug/132","appid":"wx8d4dcbcc3d3f1cb9","language":"zh_CN"},"useragent":"android","mdetail":"MI MAX 2","lc":2,"rurl":"","uaVer":"7.1.1","screen":"1080.75x1922.25","isWeixin":true,"url":"https://v2.rabbitpre.com/m2/U3MFvu3?actid=395638050115424256&stepid=395638113432768512&cnltype=TERMINAL%2CEMPLOYEE&cnl=372760745588428800%2C400952489085636608&mkcloudsdk=null&lc=2&sui=16fc628e-fee7-4f6e-92ca-5ad9bcb62aa3&from=groupmessage#from=share","netType":"WIFI","title":"营销快报 | 微信公众号为什么不做信息流？小程序刷屏只需三步","appSrc":"Weixin","appVer":"6.6.7.1321(0x26060739)","build":"NMF26F","model":"xiaomi","shareType":"groupmessage"}

{"userInfo":{"openid":"o7kepwRzAFa829PRruQ5C-i2eeyM","appid":"wx94ec6057d5a4a719"},"useragent":"android","mdetail":"vivo Y55L","lc":1,"rurl":"","uaVer":"6.0.1","screen":"720x1280","isWeixin":true,"url":"http://v7.rabbitpre.com/m2/aUe1ZiAkXr?lc=1&sui=c77a393e-612b-4b86-b78d-48c5cd972ef9&from=groupmessage#from=share","netType":"WIFI","title":"❤ 致所有穿过军装的人！","appSrc":"Weixin","appVer":"6.6.7.1321(0x26060739)","build":"MMB29M","model":"vivo","shareType":"groupmessage"}

翻页switchpage

字段	可能的取值	描述
ctp	1	当前页
tgp	2	目标页
ttp	10	总页数
staytm	1000	停留时间（毫秒），若在小程序中，则取（leavepage－enterpage）的时长

switchpage事件对应的eventargs字段demo:

{"ctp":3,"tgp":4,"staytm":16880,"ttp":6}

退出exit（此部分旧数据中有使用并存储，新接入的数据以弃用）

字段	可能的取值	描述
currentPage	10	关闭时的页数
totalPage	10	作品总页数
staytm	1000	当前页的停留时间（毫秒）

exit事件对应的eventargs字段demo:

{"staytm":3714,"currentPage":2,"totalPage":8}

点击linkclick

字段	可能的取值	描述
btname	started	按钮id/二维码id
remark	开始按钮	按钮名称/二维码名称
type	longclick／Null	长按／单击

linkclick事件普通按钮对应的eventargs字段demo:

{"remark":"抽奖返回按钮1","btname":"appid-draw-return-button","type":"NULL"}

linkclick事件长按按钮对应的eventargs字段demo:

{"remark":"抽奖返回按钮2","btname":"appid-draw-return-button","type":"longclick"}

表单信息formInfo

字段	可能的取值	描述
formInfo	{}	表单JSON对象

formInfo事件对应的eventargs字段demo:

{"formInfo":{"data":{"1532467633296233":{"姓名":"杨云超"},"1532467633296234":{"电话":"13688256575"},"1532467633296235":{"楼盘名称":"上层南苑"}},"version":"1"}}

{"formInfo":{"data":{"1530842787484156":{"手机":"18617588699"},"1530842858954160":{"性别/码数":"女，165"},"1530842787484155":{"姓名":"肇慧敏"},"1530842787484157":{"地址":"邯郸市涉县城西街联通营业厅（供销楼旁边）"}},"version":"1"}}

用户信息userinfo

字段	可能的取值	描述
city	威海	用户所在城市
nickname	阿寨	昵称
sex	1	用户的性别，值为1时是男性，值为2时是女性，值为0时是未知
openid	o7kepwcFRlJyCV4_tnGN0LRaxzLU	用户的标识，对当前公众号唯一
unionid	oFGdtwOgYHCWT59SGEDlT8bIrmB4	同一个微信开放平台帐号下的移动应用、网站应用和公众帐号（包括小程序），用户的 UnionID 是唯一的
country	中国	用户所在国家
province	山东	用户所在省份
headimgurl		用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空
language	zh_CN	用户的语言，简体中文为zh_CN

微信网页授权拉取的用户信息对象

userinfo事件对应的eventargs字段demo:

{"openid":"oiEBCwL93V-BRrRQKPvPCzONvFG0","headimgurl":"https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTKibqX2nPhYJDajHkADuLVxiaNGVEw7RDWbNILcG5Z9SMEWUXfwSNwibqltibjDvWcicXGT4ibiaelkJck6A/132","id":77949,"sex":2,"language":"zh_CN","city":"信阳","unionid":"o9wX6jlRbdgMRDPjcYCLvxyHXcmA","country":"中国","privilege":{},"nickname":"芳芳","province":"河南"}

关闭unload

字段	取值	描述
staytm	具体数值	整个作品的停留时间（毫秒），若在小程序中，取（launch－background）的时长
complete	具体数值（0~1）	作品的阅读完整度：文章的阅读高度/文章高度，如：0.66
roll	布尔值（0/1）	是否在页面发生过滚动事件，是为1，否为0

unload事件对应的eventargs字段demo:

{"staytm":15300}

分享share

字段	取值	描述
staytm	1000	从上一次翻页事件到分享时的时间（毫秒）
useragent	同view	同view
shareType	timeline, friend, qq, txweibo, qzone	分享去向
shareApp	Wechat、Wecom	分享环境（在哪里分享：微信、企业微信）

share事件对应的eventargs字段demo:
{"staytm":24837,"useragent":"iphone","title":"我是第259188位为中南大学湘雅二医院送上60岁生日祝福的人","shareType":"timeline"}

操作状态opState

字段	取值	描述
operation	start	活动参与的发起操作，例如发起拼团/砍价
	participate	用来描述参与活动（非发起者）
	getAward	用来描述获得奖品/中奖、砍价成功、拼团成功
	playGame	用来描述用户开始玩游戏，适用于小游戏作品
	paid	成交，支付成功
ownerOpenId	活动发起者/邀请者的openid	活动发起者/邀请者

视频video（20200328新增）

字段	可取值	描述
action	play / replay	点击重播或页面销毁是上报播放事件，第一次上报paly，之后在页面未销毁情况下都上报replay
playlength	int	取最近一次播放事件中，进度条所走的时间；播放时长，以秒为单位；

小程序SDK事件-获取手机号getPhone

字段

可能取值

描述

type

xcxauth

手写(Null)/自动获取手机号(xcxauth)

xcxauth 小程序授权

title

如果是作品中，title=作品标题；

如果是我的页面，title=“内容小程序名称-个人中心”

phone

138xxxxxxxx

手机号

2.后端上报的事件

目前支持对接的事件

公众号gzh

字段	类型	取值	描述
operation	string	subscribe/unsubscribe	关注公众号/取消关注公众号

已存在有的公众号事件，参考：

body的请求内容：

事件	请求内容
关注公众号	{ "operation": "subscribe", "eventkey": "abcefe" }
取消关注公众号	{ "operation": "unsubscribe" }
公众号留言	{ "operation": "getMessage", "content": "abcefe" }
点击公众号菜单	{ "operation": "getClick", "eventkey": "abcefe", "menuid": "abcefe", "menuname":"菜单名字" }
扫描公众号二维码	{ "operation": "scan", "eventkey": "abcefe" }

参数	说明
operation	操作动作
eventkey	当operation值为“subscribe”时值为参数二维码的key值，qrscene_为前缀，后面为二维码的参数值。当operation值为“getClick”时，值为{公众号菜单的evertkey，或小程序点击菜单的路径当operation值为“scan”时，值为参数二维码的key值
menuid	当operation值为“getClick”时，值为菜单的ID
menuname	当operation值为“getClick”时，值为菜单名
content	当operation值为“getMessage”时值为公众号留言内容

企业微信workwechat

字段	类型	取值	描述
operation	string	addContacts	添加联系人
createTime	bigint	毫秒时间戳	添加时间
externalUserid	string		外部联系人id

workwechat事件body内容：

{"operation":"addContacts", "createTime":3298373722, "externalUserid:"zhangsan"}

3、插件活动事件

抽奖Lottery

字段	类型	取值	描述
operation	文本	抽奖=start，中奖=win，领奖=getAward	活动状态
prizeId	文本	前端生成的uuid	奖品id
prizeName	文本	在用户中奖和领奖的时候上报对应的奖品名称	奖品名称
prizeLevel	文本	所填写的奖品等级	奖品等级
prizeType	文本	目前有的几种类型:奖品、优惠券、可计数型奖品	奖品类型

Lottery事件的body内容:

{"operation":"win", "prizeId":"ujshsfjsjfowh", "prizeName":"大礼包", "prizeLevel":2, "prizeType":"奖品"}

助力Help

字段	类型	取值	描述
operation	文本	被邀请者完成助力事件=success	活动状态
helpType	文本	支持类型：share（分享）、view（浏览）、btnClick（给好友助力按钮）、 formSubmit（表单提交）、apiInvoke（外部任务事件）、addWorkWechat（添加企业微信好友）、 wechatSubscribe（微信服务号关注）	助力类型
saudid	文本	根据分享链接的中的saudid判断邀请者	邀请者
audid	文本	根据分享链接的中的audid判断被邀请者	被邀请者

Help事件的body内容:

{"operation":"success", "helpType":"view", "saudid":87272626262, "audid":3993827272}

领奖Award

字段	类型	取值	描述
operation	文本	领奖=getAward	活动状态
prizeId	文本	前端生成的uuid	奖品id
prizeName	文本	在用户中奖和领奖的时候上报对应的奖品名称	奖品名称
prizeType	文本	目前有的几种类型:奖品、优惠券、可计数型奖品	奖品类型

Award事件的body内容:

{"operation":"getAward", "prizeId":"ujshsfjsjfowh", "prizeName":"大礼包", "prizeType":"奖品"}

签到Signin

字段	类型	取值	描述
operation	文本	被邀请者完成助力事件=success	活动状态
signInTime	文本	签到成功日期	签到日期
audid	文本		签到人

Signin事件的body内容:

{"operation":"success", "signInTime":"2021-02-11", "audid":82777226226}

任务Task

字段	类型	取值	描述
operation	文本	参与任务=start,完成任务=success	活动状态
taskId	文本	该任务插件ID	任务ID
taskTitle	文本	文本用以概括该任务的内容	任务标题
taskType	整数型	0：线上；1:线下	任务场景
preFlag	整数型	完成上一任务才可参与标识 0：否；1:是	是否前置任务
audid	文本		任务参与人

Task事件的body内容:

{"operation":"start", "taskId":"ujshsfjsjfowh", "taskTitle":"点赞送抽奖机会", "taskType":0, "preFlag":0,"audid":872726262}

组队Team

字段	类型	取值	描述
operation	文本	创建队伍=start,加入队伍=join,组队完成=success	活动状态
leaderId	整数型	用户建队时自增ID	队伍ID
saudid	文本	邀请者audid	队长
audid	文本	JSON，被邀请者audid集合	队员

Team事件的body内容:

{"operation":"join", "leaderId":727266, "saudid":8736262525, "audid":3039837372}

投票Vote

字段	类型	取值	描述
operation	文本	投票=vote	活动状态
playerId	整数型	选手ID自增	被投票选手
playerName	文本		选手名称
audid	文本		参与人

Vote事件的body内容:

{"operation":"vote", "playerId":123, "playerName":"张三", "audid":872635522}

答题Answer

字段	类型	取值	描述
operation	文本	参与答题=start,完成答题=success	活动状态
data	文本	JSON，含答题分值，答对题目，正确错误分布	题目总览
audid	文本		参与人

Answer事件的body内容:

{"operation":"start", "data":"{}", "audid":87663562525}

预约Reserve

字段	类型	取值	描述
operation	文本	报名预约=start,定时抽签/抽奖后=publishAward	活动状态
audid	文本		预约人
prizeId	文本	前端生成的uuid	奖品id
prizeName	文本	在用户中奖和领奖的时候上报对应的奖品名称	奖品名称
prizeType	文本	目前有的几种类型:奖品、优惠券、可计数型奖品	奖品类型

Reserve事件的body内容:

{"operation":"publishAward", "prizeId":"ujshsfjsjfowh", "prizeName":"大礼包", "audid":29873662622, "prizeType":"奖品"}