微信小程序转化数据回传API文档
目录
一. 转化数据上报说明及示例
二. 确定行为类型
三. 转化上报常用参数列表(action_param)
四. 数据上报错误提示
FAQ
以下内容建议提供给将您的转化数据回传给腾讯广告的技术侧阅读,优化师及广告投手阅读帮助中心-转化归因使用指南-微信小程序转化归因操作手册 ,了解如何在广告创建时进行归因设置。
回传技术侧可登录 投放管理平台 → 上方工具箱 → 转化归因,可以找到网页转化中的API(自归因上报)接口。
微信小程序的API自归因利用_CALLBACK_(cb)或clickid、wechat_openid、wechat_app_id作为用户标识,从而实现腾讯点击数据和全网转化数据的匹配。因此必须将cb 或 clickid 或 wechat_openid和wechat_app_id,连同转化类型(ActionType) 一并上报给腾讯广告,经过腾讯广告计算后,将最终数据呈现在投放端。
cb:直接从点击转发出去的__CALLBACK__字段中URLDecode获得,每次点击唯一,作为上报地址使用。
clickid:对于推广Web落地页而言,在腾讯广告推广时,每次点击都会生成一个 click_id,在跳转到落地页时,会将 click_id 作为参数传入对应的 URL 中。对于腾讯广告非微信流量为URL中的参数qz_gdt的值,对于微信流量为URL中的参数gdt_vid的值。
转化上报支持上报形式:post形式
post形式上报示例一:填写了点击转发链接,上报cb
使用此方式时,需要满足:
1.您在创建转化时候填写了点击监测,这一步可以和您的广告投放方确认,在 投放管理平台 → 上方工具箱 → 转化归因-Web类-小程序转化时已经使用了监测服务
curl -X POST
http://tracking.e.qq.com/conv?cb=YWRzX......iOWNi&conv_id=10001 //这里请求的url&path 直接从点击转发出去的__CALLBACK__字段中URLDecode获得,左边是示例请求,请勿直接上报
-H 'Content-Type: application/json'
-H 'cache-control: no-cache'
-d '{
"actions":[
{
"outer_action_id":"outer_action_identity",// 选填,若上报可能有重复请填写该id,系统会根据该ID进行去重,详见FAQ
"action_time":1492998081,
"user_id":{//user_id,可采集到的设备标示
"wechat_openid":"",//当为小程序类转化时,此字段与wechat_unionid必传其一
"wechat_unionid":'''',//当为小程序类转化时,此字段与wechat_openid必传其一
"wechat_app_id":"",//用户发生该行为对应的小程序appid,该字段必填,并确保该appid已对该账户进行了授权(请参考帮助中心-转化归因使用指南-微信小程序转化归因操作手册中的appid授权部分)
},
"action_type":"ACTIVATE_APP", // 必填 行为类型
"action_param":{
......
}
}
]
}'
post形式上报示例二:未填写点击转发链接,上报clickid
使用此方式时,需要满足:
1.您在创建转化时候没有使用点击监测,这一步可以和您的广告投放方确认,在 投放管理平台 → 上方工具箱 → 转化归因-Web类-小程序转化时没有使用监测服务
2.在上报前必须在 投放管理平台 → 上方工具箱 → 转化归因-Web类-微信小程序转化,创建wechat_app_id字段中对应的appid转化。这一步可以联系您的广告投放方完成,填写的appid与您上报时的wechat_app_id保持一致。
curl -X POST
http://tracking.e.qq.com/conv
-H 'Content-Type: application/json'
-H 'cache-control: no-cache'
-d '{
"actions":[
{
"outer_action_id":"outer_action_identity",// 选填,若上报可能有重复请填写该id,系统会根据该ID进行去重,详见FAQ
"action_time":1492998081,
"user_id":{//user_id,可采集到的设备标示
"wechat_openid":"",//当为小程序类、公众号和企业微信转化时,此字段与wechat_unionid必传其一
"wechat_unionid":'''',//当为小程序类、公众号和企业微信转化时,此字段与wechat_openid必传其一
"wechat_app_id":"",//用户发生该行为对应的小程序appid,该字段必填,并确保该appid已对该账户进行了授权(请参考帮助中心-转化归因使用指南-微信小程序转化归因操作手册中的appid授权部分)
},
"action_type":"ACTIVATE_APP", // 必填 行为类型
"trace": {
"click_id":"abc" // 必填 click_id
},
"action_param":{
......
}
}
]
}'
当请求API后,收到返回值为{"code":0, "message":""} 表示广告平台成功收到数据
注意:
小程序类的转化数据上报必须填写创建转化时的小程序的APPID (以wx开头)。
上报地址__CALLBACK__是直接从点击转发出去的__CALLBACK__字段中URLDecode获得,上面示例中的url&path是示例请求,请勿直接上报。
二. 确定行为类型
在数据上报接口的必填字段action_type中,填写需要上报的转化行为类型。
常用的优化目标对应行为类型请见下表,完整转化行为请参考 Action_type标准行为类型枚举
优化目标名称 | 标准行为(action_type) | 行为参数(action_param) | 投放端指标 | 备注 |
下单 | COMPLETE_ORDER | 下单量 | 若要上报金额请在param中添加参数“value”:123 | |
表单预约 | RESERVATION | |||
注册 | REGISTER | 注册量 | ||
激活 | ACTIVATE_APP | 激活量 | 对同一个应用30天内重复的设备激活行为去重 | |
次日留存 | START_APP | length_of_stay=1 | 次日留存量 | 对同一个应用30天内重复的设备次留行为去重 |
首次付费 | PURCHASE | 首次付费量 | 若要上报金额请在param中添加参数“value”:123 | |
有效综合线索 | CONFIRM_EFFECTIVE_LEADS | 有效线索量 | ||
授信 | CREDIT | 金融授信量 | 若要上报金额请在param中添加参数“value”:123 | |
关注 | FOLLOW | |||
付费 | PURCHASE | 若要上报金额请在param中添加参数“value”:123 | ||
加企业微信客服 | SCANCODE | 加企业微信客服次数 | ||
关键页面访问 | VIEW_CONTENT | |||
广告变现 | AD_PURCHASE | 若要上报金额请在param中添加参数“value”:123 | ||
公众号内注册 | REGISTER | |||
商品详情页浏览 | PRODUCT_VIEW | |||
7日留存 | START_APP | length_of_stay=7 | ||
跳转按钮点击 | LANDING_PAGE_CLICK | |||
扫码加粉 | SCANCODE_WX | |||
综合线索收集 | CLAIM_OFFER 或 ONLINE_CONSULT 或 MAKE_PHONE_CALL 或 RESERVATION 或 SCANCODE | |||
关键行为 | action_type报“CUSTOM”,custon_action报“UV_CORE_ACTION” | |||
在线咨询 | ONLINE_CONSULT | |||
24小时下单 | COMPLETE_ORDER | 若要上报金额请在param中添加参数“value”:123 | ||
加群 | ADD_GROUP | |||
快应用加桌面 | ADD_DESKTOP | |||
电话拨打 | MAKE_PHONE_CALL | |||
小游戏创角 | CREATE_ROLE | |||
进件 | APPLY | 若要上报金额请在param中添加参数“value”:123 | ||
快速下单 | COMPLETE_ORDER | |||
意向表单 | RESERVATION_CHECK | |||
领券 | CLAIM_OFFER | |||
预付定金 | PRE_PAY | 若要上报金额请在param中添加参数“value”:123 | ||
主动一句话咨询 | CONSULT | consult_type=”INTELLIGENT_TOOL” AND consult_active_type=”1_1″ | ||
三句话咨询 | CONSULT | consult_type=”INTELLIGENT_TOOL” AND consult_active_type=”3_0″ | ||
参数名 | 类型 | 描述 | 是否必填 | 取值范围 | 备注 |
---|---|---|---|---|---|
value | int | 订单价值,单位:分 | 否 | — | 体现转化带来的价值,在上报COMPLETE_ORDER或PURCHASE行为时可选填 |
object | string | 行为对象 | 否 | ^.{0,200}$ | 在上报VIEW_CONTENT行为时参数填写为object=product,表示上报的是商品页面浏览行为 |
consult_type | string | 咨询类型 | 否 | ^.{0,200}$ | MAKE_PHONE_CALL 电话咨询、ONLINE_CONSULT 网页咨询和RESERVE_PHONE_NUMBER 电话回拨 |
错误码 | 中文提示 | 英文提示 |
20001 | 回调url内容错误 | CB_CONTENT_ERROR |
20002 | 没有与转化ID对应的转化规则 | CONV_ID_ILLEGAL |
20003 | 无效数据源ID | ACTION_SET_ID_ABNORMAL |
20004 | 无效账户ID | ACCOUNT_ID_ABNORMAL |
20005 | 编码base64密钥失败 | ENCODE_B64_KEY_ERROR |
20006 | 回调url base64解码失败 | DECRYPT_B64_CB_ERROR |
30000 | Api访问失败 | API_ERROR |
1. 上报行为如何自定义去重?
可以在actions内加入outer_action_id参数进行自定义去重。
参数名 | 类型 | 说明 | 描述 |
---|---|---|---|
outer_action_id | string | 去重标识,字段长度最小1字节,最大长度255字节,且只能为数字,字母,下划线,连接符组成 | 平台会基于user_action_set_id,outer_action_id 和action_type三个字段做去重 ,如果历史上报数据中存在某条数据的这三个字段与当前上报数据完全一样的,则当前数据会被过滤掉 |
claim_type | string | 放入param字段的参数上传,归因方式,只能为数字 | 平台会基于传入的claim_type进行对应方式归因;0-点击归因,1-关注归因,2-曝光归因,3-注册归因,4-激活归因,5-视频播放归因,6-关键页面浏览归因,7-回流归因 |