Web转化行为数据接入
本节将为您介绍如何接入您的Web转化行为数据,Web转化行为数据接入分为和Marketing API(推荐使用)两种方式。如果您想使用JS接入数据,可参考(https://developers.e.qq.com/docs/user_actions/web/js)。
1. API方案介绍
通过Marketing API接入Web行为数据,需要注意:
- 对于H5商品而言,在腾讯社交广告推广时,每次点击都会生成一个click_id,在跳转到落地页时,会将 click_id 作为参数传入对应的 URL 中。
- 当对应落地页的产生转化行为时,可以利用 API 将click_id 和 转化类型(ActionType) 一并上报给腾讯社交广告,经过腾讯社交广告计算后,将最终数据呈现在投放端(qq.com)。
- 目前支持的广告流量包括:手腾网、QQ空间(PC、移动流量)、QQ浏览器、腾讯视频、天天快报、腾讯新闻、QQ天气、附近的人、移动联盟、微信公众号。其中QQ空间(PC)和微信公众号 不支持H5-oCPA功能。
两种数据上报模式:(必读)
模式1:开发者用一套完成鉴权的 account id 和对应的 user_action_set_id 来上报所有账户的数据。
模式2(推荐所有新上报数据的开发者使用):开发者与每一个账户进行鉴权,将行为上报到各个
account id 下的 user_action_set_id 内,完成各自账户的数据上报。推荐所有新上报数据的开发者使用模式2,因为这种方式的上报可以使得效果数据到广告的归因更准确,使用模式1时如果希望归因更准确,开发者后续仍然需要完成与每一个账户的鉴权。
举例:代理商A是开发者,负责五个账户的数据上报工作,模式1是A先完成五个账户中某一个账户a的鉴权,然后将所有行为数据上报到a的数据源(user_action_set_id),系统会自动判断每个行为是五个账户中哪个账户的广告带来的效果,但可能出现将a账户的行为归因给b的情况;模式2是A分别与五个账户进行鉴权,并且分别在各个账户下创建数据源,然后将行为数据区分上报:将账户a带来的行为上报给a账户下的数据源,账户b带来的行为上报给b账户下的数据源,以此类推。结果是a账户带来的行为仅会归因给a账户投放的广告,效果数据更准确。
2. API接入流程
Step 1. 注册成为腾讯社交广告 MarketingAPI (https://developers.e.qq.com/) 开发者
Step 2. 创建转化数据上报应用,等待审核
Step 3. 绑定需要追踪 H5 转化数据的广告主账户
Step 4. 上报网页转化行为数据
2.1 注册成为腾讯社交广告 MarketingAPI 开发者
要调用Marketing API,必须先注册成为开发者并创建应用。此处的应用可以理解为一个面向其他广告主的服务,下文将其统一定义为『转化数据上报应用』。
2.2 绑定需要追踪 H5 转化数据的广告主账户
2.2.1 完成OAuth2.0认证操作(用户行为数据接入的 refresh token 有效期为 2 年)
2.2.2 配额和频次控制
2.3 上报网页转化行为数据
在传入转化行为数据之前,请确保开发者已经:
- 完成了需要上报效果的广告主账户的绑定
- 获取了可用的在有效期内的 token
2.3.1 转化数据类型
要上报转化行为,首先需要填写相应的转化类型(ActionType)对应参数为action_type
如下表所示:
名称 | 类型 | 描述 |
account_id | integer | 广告主id,需为已经和开发者完成鉴权的广告主ID |
user_action_set_id | integer | 原 pixel id,现更名为 user_action_set_id,旧参数名依然兼容。后续用于标识数据归属权,详见
user_action_sets 接口 |
action_type | enum | 预定义的行为类型,全部行为类型见
action_type全集介绍 |
action_param | string | 行为所带的参数,详见
action_param介绍 |
outer_action_id | string | 字段长度最小 1 字节,长度最大 204800 字节。是去重标识,平台会基于user_action_set_id,outer_action_id 和action_type三个字段做去重 ,如果历史上报数据中存在某条数据的这三个字段与当前上报数据完全一样的,则当前数据会被过滤掉 |
actions | struct | 转化行为 |
action_time | integer | 行为发生时,客户端的时间点。 UNIX 时间,单位为秒,如果不填将使用服务端时间填写 最小值 0,最大值 2147483647 |
trace | struct | 跟踪信息 |
click_id | string | 点击 id 落地页URL中的click_id,对于广点通流量为URL中的qz_gdt,对于微信流量为URL中的gdt_vid |
2.3.4 请求示例
需要统计『下单』的转化行为,开发者只需要在下单转化行为发生时,上报action_type=”COMPLETE_ORDER”、click_id和nonce(nonce是一个长度小于32的随机字符串,并要保证唯一性)。回传过程中如有重复上报,开发者希望基于订单id做去重,最终实现“每个订单id仅上报一次”,将每条行为中的订单id实时填入outer_action_id,如订单号为123456,请求示例如下:
curl -k "https://api.e.qq.com/v1.0/user_actions/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>" \
-H 'Content-Type: application/json' \
-d '{
"account_id": "<ACCOUNT_ID>",
"actions": [
{
"user_action_set_id": "<USER_ACTION_SET_ID>",
"url": "<URL>",
"action_time": 1487923255,
"action_type": "COMPLETE_ORDER",
"trace": {
"click_id": "<CLICK_ID>"
},
"action_param": {
"int_example": 123,
"string_example": "123"
},
"outer_action_id":123456
}
]
}'
2.3.5 返回值
正确的返回值为:
{"code":0,"message":"ok"}
代表上报成功。
关于错误的返回码详见 MarketingAPI 返回码。
附录
一、特别说明·不同类型账户请求授权结果:
- 如果请求授权的是代理商帐号,代理商用开户 QQ 登录并同意授权,完成 OAuth 2.0 后应用获得access_token,该应用会获得当前代理商所有子客户的推广帐号的操作权限
- 如果请求授权的是直客帐号,客户用开户 QQ 登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该用户会获得当前客户推广帐号的操作权限
- 如果请求授权的是代理商子客户,用子客户的自理管理员 QQ(由代理商分配)登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该应用会获得当前子客户推广帐号的操作权限。
二、通过接口上报的action_type和action_param,对应投放端的指标如下。
典型用户行为 | DMP标准行为(action_type) | 标准行为名称 | 请求字段 | 行为参数 | 投放端效果栏 | 投放端指标 | 是否支持作为OCPA优化目标 |
落地页下单 | COMPLETE_ORDER | 下单 | type=WEB | 无 | 网页栏 | 下单量 | 支持 |
落地页填单留资 | RESERVATION | 预约 | type=WEB | 无 | 网页栏 | 表单预约量 | 支持 |
用户在落地页上留资后下载APP,在APP内注册登录/跳转到网页注册页面,完成网站用户注册 | REGISTER | 注册 | type=WEB | 无 | 网页栏 | 注册量 | 支持 |
用户在线上或线下实际完成付费购买行为并成交 | PURCHASE | 购买 | type=WEB | 无 | 网页栏 | 付费行为量 | 支持 |
用户通过在一级页面上点击按钮,跳转到广告主指定二级页面并浏览 | VIEW_CONTENT | 关键页面访问 | type=WEB | object=product | 网页栏 | 商品页面浏览量 | 支持 |
用户直接下载APP后第一次打开/在落地页上留资后下载APP后第一次打开 | ACTIVATE_APP | 激活应用 | type=ANDROID/IOS | 无 | APP效果栏 | 激活总量 | 支持 |
用户在页面上发起网页咨询 | CONSULT | 网页咨询 | type=WEB | consult_type=ONLINE_CONSULT | 网页栏 | 网页咨询量 | 支持 |
用户在页面上发起电话咨询 | CONSULT | 电话咨询 | type=WEB | consult_type=MAKE_PHONE_CALL | 网页栏 | 电话直拨量 | 支持 |
用户在页面上留资后,广告主进行电话回拨并成功 | CONSULT | 电话回拨 | type=WEB | consult_type=RESERVE_PHONE_NUMBER | 网页栏 | 电话回拨量 | 暂不支持 |
用户将商品加入购物车 | ADD_TO_CART | 加入购物车 | type=WEB | 无 | 网页栏 | 加入购物车量 | 暂不支持 |
用户进行业务申请(如贷款、信用卡等,金融类广告主常用) | APPLY | 申请 | type=WEB | 无 | 网页栏 | 申请量 | 暂不支持 |
用户访问自有落地页 | VIEW_CONTENT | 关键页面访问 | type=WEB | 无 | 网页栏 | 自有网页关键页面浏览量 | 暂不支持 |
用户在落地页上下单,并且订单商品已发货 | DELIVER | 订单发货 | type=WEB | 无 | 网页栏 | 订单发货量 | 支持 |
用户在落地页上下单,并且订单商品已签收 | SIGN_IN | 签收 | type=WEB | 无 | 网页栏 | 订单签收量 | 暂不支持 |
用户在自有网站落地页上进行导航行为 | NAVIGATE | 导航 | type=WEB | 无 | 网页栏 | 自有网页导航量 | 暂不支持 |
用户在自己的网站网页内领取卡券 | CLAIM_OFFER | 领取卡券 | type=WEB | 无 | 网页栏 | 自有网页领取卡券量 | 暂不支持 |
用户在网页付费花费的总金额 | INITIATE_CHECKOUT | 付费 | type=WEB | 无 | 网页栏 | 付费行为量 | 暂不支持 |
广告主投放的网页上咨询组件确认发生咨询对话量 | CONFIRM_EFFECTIVE_LEADS | 确认有效线索 | type=WEB | LEADS_TYPE=CONSULT | 网页栏 | 有效线索-咨询(暂未支持) | 暂不支持 |
广告主投放的网页上电话组件确认接通量 | CONFIRM_EFFECTIVE_LEADS | 确认有效线索 | type=WEB | LEADS_TYPE=PHONE | 网页栏 | 有效线索-电话(暂未支持) | 暂不支持 |
广告主投放的网页上表单线索回拨后确认为有效线索量 | CONFIRM_EFFECTIVE_LEADS | 确认有效线索 | type=WEB | LEADS_TYPE=RESERVE | 网页栏 | 有效线索-表单(暂未支持) | 暂不支持 |
广告主投放的网页上咨询组件确认发生留资行为量 | CONFIRM_POTENTIAL_CUSTOMER | 确认潜在客户 | type=WEB | LEADS_TYPE=CONSULT | 网页栏 | 潜在客户-咨询(暂未支持) | 暂不支持 |
广告主投放的网页上电话组件接通后确认为潜在客户量 | CONFIRM_POTENTIAL_CUSTOMER | 确认潜在客户 | type=WEB | LEADS_TYPE=PHONE | 网页栏 | 潜在客户-电话(暂未支持) | 暂不支持 |
广告主投放的网页上表单线索回拨后确认为潜在客户量 | CONFIRM_POTENTIAL_CUSTOMER | 确认潜在客户 | type=WEB | LEADS_TYPE=RESERVE | 网页栏 | 潜在客户-表单(暂未支持) | 暂不支持 |
三、转化常用参数列表(action_param)
参数名 | 类型 | 描述 | 是否必填 | 取值范围 | 备注 |
value | int | 订单价值,单位:分 | 否 | —— | 体现转化带来的价值 |
consult_type | string | 咨询类型 | 否 | ^.{0,200}$ | 目前包括三种类型:MAKE_PHONE_CALL(电话咨询)、ONLINE_CONSULT(网页咨询)和RESERVE_PHONE_NUMBER(电话回拨) |
object | string | 行为对象 | 否 | ^.{0,200}$ | 在上报VIEW_CONTENT行为时参数填写为object=product,表示上报的是商品页面浏览行为 |
length_of_stay | int | 停留天数,单位:天 | 否 | —— | 在上报START_APP行为时参数填写为length_of_stay=1,表示上报的是次日留存行为 |
四、金融行业广告主不同业务上报的行为及对应action_type、action_param、投放端的指标如下。
金融业务及用户行为 | DMP标准行为(action_type) | 标准行为名称 | 请求字段 | 行为参数(action_param) | 投放端效果栏 | 投放端指标 |
贷款/理财/综合平台/消费金融/证券/基金业务上报“落地页注册”;
信用卡/保险业务上报“落地页填单” |
RESERVATION | 预约 | type=WEB | 无 | 网页效果栏 | 表单预约量 |
贷款业务上报“落地页咨询” | CONSULT | 网页咨询 | type=WEB | consult_type= ONLINE_CONSULT |
网页效果栏 | 网页咨询量 |
各业务上报“落地页电话直拨” | CONSULT | 电话咨询 | type=WEB | consult_type= MAKE_PHONE_CALL |
网页效果栏 | 电话直拨量 |
各业务上报“落地页电话回拨” | CONSULT | 电话回拨 | type=WEB | consult_type= RESERVE_PHONE_NUMBER |
网页效果栏 | 电话回拨量 |
各业务上报“APP激活” | ACTIVATE_APP | 激活应用 | type=ANDROID/IOS | 无 | APP效果栏 | 激活总量 |
各业务上报“APP次日留存” | START_APP | 次日留存 | type=ANDROID/IOS | length_of_stay=1 | APP效果栏 | 次日留存量 |
各业务上报“APP内注册/登录” | REGISTER | 注册 | type=ANDROID/IOS | 无 | APP效果栏 | 注册量 |
贷款业务上报“贷款申请完成”或者“授信”; 信用卡业务上报“APP内信用卡申请完成”; 综合平台业务上报“APP申请完成行为”(申请理财、贷款、信用卡等); 消费金融业务上报“申请贷款完成/授信”; 证券业务上报“开户申请完成” |
APPLY | 申请 | type=ANDROID/IOS | 无 | APP效果栏 | 申请量 |
贷款业务上报“贷款成功”; 信用卡业务上报“核卡”; 保险业务上报“投保”(线下行为); 理财业务上报“入资”; 综合平台业务上报“APP收益行为”(理财、贷款、办卡成功等); 消费金融业务上报“贷款成功/商品付款”; 证券业务上报“交易成功”; 基金业务上报“支付成功” |
PURCHASE | 购买 | type=ANDROID/IOS | 无 | APP效果栏 | 付费行为量 |