家居行业线索类数据对接规范
一、 背景介绍
为帮助广告主优化有效线索成本,提高后端投产比,鼓励行业广告主通过api的方式接入深度转化数据,优化模型对人群及后端成本的感知能力。
二、 适用对象&场景
需要回传一方深度转化数据到AMS的所有线索收集类家居行业广告主。
重要提示:请依据使用场景选择您对应的数据对接方案
场景1:如果您使用自有小程序、自有落地页等非腾讯官方落地页收集线索,线索数据及深度转化数据都需您自行上报AMS,通过marketingAPI的【行为上报接口】、【线索管理接口】进行上报皆可;表单链路的线索字段action_type为RESERVATION。
场景2:如果您通过加粉链路收集线索,并通过云雀、亦芯第三方工具进行线索跟进和管理,由于AMS已和云雀、亦芯进行对接,您授权后相关线索数据会自动上报AMS,在亦芯、云雀后台标记有效状态后也会自动上报AMS。
场景3:如果您通过加粉链路收集线索,但并非所有线索皆通过AMS合作的第三方工具管理,则需您自行上报其他线索及深度给AMS,通过marketingAPI的【行为上报接口】、【线索管理接口】进行上报皆可。 加粉链路的线索字段action_type为REGISTER,和表单链路有所区分。
场景4:如果您通过企微链路收集线索,通过marketingAPI的【行为上报接口】、【线索管理接口】进行上报皆可
场景5:如果您使用“微信原生、原生小程序(阿丽塔)、蹊径”收集线索,相关线索均自动上报并沉淀线索管理平台;且如果您希望享受腾讯线索通对无效号码(空号、停机或关机)所提供的赔付,您需通过marketingAPI的【线索管理接口】更新线索状态,或在【线索管理平台】手动更新线索状态,赔付门槛及政策参考线索通无效线索赔付政策产品手册。
接入前准备
1)开发者账户注册【已注册开发者可忽略】:
文档:https://developers.e.qq.com/docs/start#oz3cv
视频:https://developers.e.qq.com/docs/guide/learning
注册地址:https://developers.e.qq.com/reg
2)数据上报权限配置【已有权限可忽略】:
https://developers.e.qq.com/docs/start#zisdgb
注:首次创建开发者应用,建议权限全部勾选,便于后续其他业务开发。
如已经创建过开发者应用,可查看已有的应用信息,不需要重新创建应用
3)授权认证:
STEP 1:授权获取authorize:https://developers.e.qq.com/docs/api/authorize/oauth/oauth_authorize
STEP 2:通过 Authorization Code 获取 Access Token:https://developers.e.qq.com/docs/api/authorize/oauth/oauth_token
注:需要操作新投放账户的情况下,必须重新授权,获取新投放账户的access_token。
账户id,access_token和数据源id,三者是一一对应的关系。
不同类型的帐号在同意授权后,应用可操作的推广帐号不同,具体规则如下:
如果请求授权的是 QQ代理商帐号,代理商用 开户 QQ 登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该应用会获得 当前代理商所有子客户的推广帐号 的操作权限;
如果请求授权的是 QQ直客帐号,客户用 开户 QQ 登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该用户会获得 当前客户推广帐号 的操作权限;
如果请求授权的是 QQ商务管家帐号,客户用 开户 QQ 登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该用户会获得 当前商务管家账号下推广帐号 的操作权限;
如果请求授权的是 QQ代理商子客户,用子客户的 自理管理员 QQ(由代理商分配)登录并同意授权,完成 OAuth 2.0 后应用获得 access_token,该应用会获得 当前子客户推广帐号 的操作权限。
如果请求授权的是 微信广告代理商帐号,代理商用 管理员微信 扫码并同意授权,完成 OAuth 2.0 后应用获得 access_token,该应用会获得 当前代理商及所有代理客户的推广帐号 的操作权限;
如果请求授权的是 微信广告主帐号,客户用 微信公众号对应的管理员微信 扫码并同意授权,完成 OAuth 2.0 后应用获得 access_token,该用户会获得 当前客户推广帐号 的操作权限;
如无特殊情况,建议使用优化师的账户进行授权,可获取全部投放账户权限。
三、 使用【行为上报接口】回传数据
适用场景1/2/3/4
【行为数据上报接口】需要应用权限“数据上报(User Actions)”,请确认开发者应用是否有该权限
如没有,可以新增该权限,不需要重新创建。(如无法新增,请联系对应行业运营经理)
1. 创建数据源
注:新建行为数据源时,选择“深度数据合作”、“转化归因”两个选项
建议可选择某一投放账号,在腾讯广告知数上直接新建数据源,(回传account_id即为该数据源的投放账户ID):
已建的行为数据源,可补充选择“深度数据合作”、“转化归因”两个选项
2. 上报一方行为数据
接口字段详情,请参考:https://developers.e.qq.com/docs/api/user_data/user_action/user_actions_add?version=1.1&_preview=1
必传字段建议:
user_id |
action_type* |
custom_action* |
action_param |
action_time*(转化时间) |
timestamp*(时间戳) |
click_id |
必传,建议尽可能回传更多类型的id,提高id匹配率 |
必传,见下文 |
当action_type为custom时必传 |
和action_type结合使用,见下文 |
必传 |
必传 |
腾讯渠道建议必传,其他渠道不传 |
click_id:对于推广Web落地页而言,在腾讯广告推广时,每次点击都会生成一个 click_id,在跳转到落地页时,会将 click_id 作为参数传入对应的 URL 中。对于腾讯广告非微信流量为URL中的参数qz_gdt的值,对于微信流量为URL中的参数gdt_vid的值。
action_type: 建议客户根据不同转化链路类型选择业务含义接近的action_type枚举值进行回传。
链路类型 | 链路细分 | 回传字段 | action_type | action_param | 优化目标名称 | 行为描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
表单线索收集 | 表单预约 | RESERVATION | 表单预约 | 填写h5或小程序的表单 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
通话时长 | PHONE_CONNECTED | CALL_DURATION | 通话三十秒 | 通话秒数 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
有效综合线索 | CONFIRM_EFFECTIVE_LEADS | 有效综合线索 | 沟通后确认有效线索 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
到店 | VISIT_STORE | 到店或上门量房 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
付费 | PURCHASE | 付费 | 下订单或交定金 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
公众号加粉 | 公众号转表单 | 注册 | REGISTER | 注册 | 公众号内留下手机号 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
通话时长 | PHONE_CONNECTED | CALL_DURATION | 通话三十秒 | 通话秒数 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
有效综合线索 | CONFIRM_EFFECTIVE_LEADS | 有效综合线索 | 沟通后确认有效线索 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
到店 | VISIT_STORE | 到店或上门量房 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
付费 | PURCHASE | 下订单或交定金 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
公众号转企微 | 加企业微信客服 | SCAN_CODE | 加企业微信客服 | 扫码添加企业微信好友 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
企微开口 | WECOM_CONSULT | 加企微好友后开口说话 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
企微留资 | RESERVATION | 咨询过程中留下手机号 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
有效综合线索 | CONFIRM_EFFECTIVE_LEADS | 有效综合线索 | 确认线索有效 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
到店 | VISIT_STORE | 到店或上门 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
付费 | PURCHASE | 下订单或交定金 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
企微链路 | 直接添加企业微信 | 加企业微信客服 | SCAN_CODE | 加企业微信客服 | 扫码添加企业微信好友 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
企微开口 | WECOM_CONSULT | 加企微好友后开口说话 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
企微留资 | RESERVATION | 咨询过程中留下手机号 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
确认有效线索 | CONFIRM_EFFECTIVE_LEADS | 有效综合线索 | 确认线索有效 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
到店 | VISIT_STORE | 到店或到家量房 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
付费 | PURCHASE | 付费 | 下订单或交定金 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
客资分类 | 行为子类型 | 行为定义 | action_type | ustom_action | action_param |
无效 | 空号 | 空号号码 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:EMPTY | |
停机 | 停机号码 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:SUSPENDED | ||
关机 | 关机号码 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:OFFLINE | ||
多次未接通 | 三次呼叫均未接通号码 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:TEL_NOT_CONNECTED | ||
恶意辱骂 | 恶意辱骂 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:ABUSIVE | ||
恶意留资 | 恶意填写大量无效表单信息 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:VICIOUS | ||
同行留资 | 广告主同行打探信息 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:CPMPETITOR | ||
否认留资 | 否认本人曾留资,或非本人接电话 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:IDENTITY_MISMATCHED | ||
接通无需求 | 接听电话者表示无家装相关需求 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:NO_INTENTION | ||
无房 | 接听者无自有房屋 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:NO_HOUSE | ||
需求不适配 | 接听电话者表示有家装需求,但所需产品&服务与广告主业务不匹配 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:PRODUCT_MISMATCHED | ||
自建房 | 有装修需求,但房屋为自建或乡墅 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON_RURAL_HOUSE | ||
小面积 | 有装修需求,但面积较小不可派单 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON_SMALL_HOUSE | ||
低预算 | 有装修需求,但预算较低不可派单 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON_LOW_BUDGET | ||
局改 | 有装修需求,但局改不可派单 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON_PARTIAL_RENOVATION | ||
需求周期过长 | 有家装需求,但预期时间较远 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:LONGTERM | ||
异地 | 异地线索 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:REGION_MISMATCHED | ||
重复 | 重复客资 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:DATA_DUPLICATION | ||
其他 | 其他无效原因 | INEFFECTIVE_LEADS | LEADS_INEFFECT_REASON:OTHER | ||
战败 | 有效未见面 | 有效但不愿到店或见面量房 | CUSTOM | LOSE | LOSE:VISIT_STORE |
见面未成单 | 已见面但成交失败 | CUSTOM | LOSE | LOSE:PURCHASE | |
STEP 4: 查看数据回传结果
客户侧查看:通过API接口获取数据源报表,或直接通过DMP管理平台查看数据源报表。对齐上报量是否一致。
DMP平台查看样例(关注总PV量):
腾讯侧查看:需要客户提供数据源id,投放账户id,回传时间段,回传总量;校验客户侧回传字段的正确性和回传量级的一致性。
3. 全渠道数据接入
1)回传全渠道数据和仅回传腾讯数据的回传流程与接口相同,不同场景下可通过channel字段不同值区分。
若希望回传的全渠道数据可进入广告归因,希望数据体现在广告投放报表中,则channel字段不传即可。当channel字段为TENCENT或空,数据将进入腾讯广告归因数据中,可基于全渠道数据进行归因,提升cvr从而优化跑量。
若不希望回传的全渠道数据进入广告归因,仅用于授权的一方数据联合建模等场景,则channel字段可填写OTHERS或其他渠道枚举值。
channel枚举值{TENCENT, NATURAL, BYTEDANCE, KUAISHOU, ALIBABA, BAIDU, OTHERS, UNKNOWN}
2)回传全渠道数据时,非腾讯渠道的数据clickid字段不用回传。
上报数据示例
1.表单链路上报示例
“表单预约”节点,数据上报示例
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",// 选填,若上报可能有重复请填写该id,系统会根据该ID进行去重
"user_id":{
"hash_phone":"<电话号码直接 MD5 编码,字段长度为32字节>"
"sha256_phone":"SHA256 算法加密后的手机号,字段长度为 64 字节"
"hash_imei":"",
"hash_idfa":"",
"hash_android_id":"",
"oaid":""
"wechat_app_id":"",
"wechat_openid":""
}, //必传,任选一种user_id,但建议回传多种的id,提高id匹配率
"action_time": 1606099210,
"action_type": "RESERVATION",
"channel":"",
"trace":{
"click_id":""
}
}
]
}'
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",// 选填,若上报可能有重复请填写该id,系统会根据该ID进行去重
"user_id":{
"hash_phone":"<电话号码直接 MD5 编码,字段长度为32字节>"
"sha256_phone":"SHA256 算法加密后的手机号,字段长度为 64 字节"
"hash_imei":"",
"hash_idfa":"",
"hash_android_id":"",
"oaid":""
"wechat_app_id":"",
"wechat_openid":""
}, //必传,任选一种user_id,但建议回传多种的id,提高id匹配率
"action_time": 1606099210,
"action_type": "RESERVATION",
"channel":"",
"trace":{
"click_id":""
}
}
]
}'
“通话时长”节点,数据上报示例
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",// 选填,若上报可能有重复请填写该id,系统会根据该ID进行去重
"user_id":{
"hash_phone":"<电话号码直接 MD5 编码,字段长度为32字节>"
"sha256_phone":"SHA256 算法加密后的手机号,字段长度为 64 字节"
"hash_imei":"",
"hash_idfa":"",
"hash_android_id":"",
"oaid":""
"wechat_app_id":"",
"wechat_openid":""
}, //必传,任选一种user_id,但建议回传多种的id,提高id匹配率
"action_time": 1606099210,
"action_type": "PHONE_CONNECTED", // 必填 行为类
"action_param":{
"call_duration":56 // 通话时长秒数,正整数 },
"channel":"",
"trace":{
"click_id":""
}
}
]
}'
“有效表单”节点,数据上报示例:
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",
"action_time": 1606099210,
"user_id":{
"hash_phone":"<电话号码直接 MD5 编码,字段长度为32字节>"
"sha256_phone":"SHA256 算法加密后的手机号,字段长度为 64 字节"
"hash_imei":"",
"hash_idfa":"",
"hash_android_id":"",
"oaid":""
"wechat_app_id":"",
"wechat_openid":""
}, //必传,任选一种user_id,但建议回传多种的id,提高id匹配率
"action_type": "CONFIRM_EFFECTIVE_LEADS",
"channel":"",
"trace":{
"click_id":""
}
}
]
}'
“无效表单”节点,数据上报示例:
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",
"action_time": 1606099210,
"user_id":{
"hash_phone":"<电话号码直接 MD5 编码,字段长度为32字节>"
"sha256_phone":"SHA256 算法加密后的手机号,字段长度为 64 字节"
"hash_imei":"",
"hash_idfa":"",
"hash_android_id":"",
"oaid":""
"wechat_app_id":"",
"wechat_openid":""
}, //必传,任选一种user_id,但建议回传多种的id,提高id匹配率
"action_type": "CUSTOM",
"custom_action": "ineffective_leads",
"trace":{
"click_id":""
}
"channel":""
}
]
}'
user_id:用户标识,可以任选以下一种,回传数据时建议上传,用于平台识别更好优化广告效果
hash_imei |
string |
IMEI 设备号保持小写,进行 md5 编码 字段长度为 32 字节 |
md5_sha256_imei |
string |
先采用 MD5 算法加密(加密后统一十六进制小写),然后再采用 SHA256 算法加密后的 IMEI,加密前需要格式转化成 14 位或 15 位数字 + 小写字母串,加密后为 64 位“数字(0-9)+小写字母(a-f)”组成的数字字母串 字段长度为 64 字节 |
hash_idfa |
string |
IDFA 设备号保持大写,进行 MD5 编码 字段长度为 32 字节 |
md5_sha256_idfa |
string |
先采用 MD5 算法加密(加密后统一十六进制小写),然后再采用 SHA256 算法加密后的 IDFA,加密前需要格式转化成 32 位的数字 + 大写字母,加密后为 64 位“数字(0-9)+小写字母(a-f)”组成的数字字母串 字段长度为 64 字节 |
gdt_openid |
string |
GDT Cookie Mapping 分配的 openid,不做处理 字段长度最小 1 字节,长度最大 64 字节 |
hash_phone |
string |
电话号码直接 MD5 编码,如 md5(13500000000) 字段长度为 32 字节 |
sha256_phone |
string |
SHA256 算法加密后的手机号,加密前为 11 位的纯数字串,加密后为不计大小写的 64 位数字字母串 字段长度为 64 字节 |
hash_android_id |
string |
对 android_id 进行 MD5 编码 字段长度为 32 字节 |
hash_oaid |
string |
MSA 制定的匿名设备标识符,保留原始值,然后进行 MD5 编码。具体 OAID 介绍请见[OAID 介绍] 字段长度为 32 字节 |
md5_sha256_oaid |
string |
先采用 MD5 算法加密(加密后统一十六进制小写),然后再采用 SHA256 算法加密后的 OAID,加密前请使用 OAID 原值直接 MD5,不要转换大小写或去连接符,加密后为 64 位“数字(0-9)+小写字母(a-f)”组成的数字字母串 字段长度为 64 字节 |
wechat_openid |
string |
微信 openid 保持原值。微信 openid 是微信用户在公众号/小程序 appid 下的唯一用户标识(appid 不同,则获取到的 openid 就不同),可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 内的 openID。否则会解析失败。 请注意,当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时,此字段和 wechat_unionid 必填其一。 字段长度最小 1 字节,长度最大 64 字节 |
wechat_unionid |
string |
微信 unionid 保持原值。微信 unionid 是微信用户在同一个微信开发者账号下的唯一用户标识(开发者账号不同,则获取到的 unionid 就不同),可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 所属开发者账号内的 unionid。否则会解析失败。 请注意,当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时,此字段和 wechat_openid 必填其一。 字段长度最小 1 字节,长度最大 64 字节 |
wechat_app_id |
string |
微信分配的 APPID。请填写所填的 wechat_openid 对应的 APPID。请确保您已经获得所填 APPID 的授权关联,否则将无法通过鉴权。当您填写 wechat_openid 时,此项必填。当您未填 wechat_openid,此项填写无效。 请注意,当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时,此字段必填。 字段长度最小 2 字节,长度最大 64 字节 |
2.公众号链路上报示例
公众号中留资的“注册”节点数据上报示例:
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",
"action_time": 1606099210,
"user_id": {
"wechat_app_id":"",
"wechat_openid":""
},
"action_type": "REGISTER",
"action_param": {
"object":"...",
"product_name":"..",
"product_id":"12345",
"source":"Biz",
"claim_type":1 //关注归因1,点击归因0
},
"channel":""
}
]
}'
“有效表单”节点,数据上报示例:
curl 'https://api.e.qq.com/v1.3/user_actions/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": "",
"user_action_set_id": 1111111111,
"actions": [
{
"external_action_id": "external_action_identity",
"action_time": 1606099210,
"user_id": {
"wechat_app_id":"",
"wechat_openid":""
},
"action_type": "CONFIRM_EFFECTIVE_LEADS",
"action_param": {
"object":"...",
"product_name":"..",
"product_id":"12345",
"source":"Biz",
"claim_type":1 //关注归因1,点击归因0
},
"channel":""
}
]
}'
四、 使用【线索管理接口】回传数据
【线索管理接口】需要应用权限“广告洞察(Ads Insight)”,请确认开发者应用是否有该权限
如没有,可以新增该权限,不需要重新创建。(如无法新增,请联系对应行业运营经理)
接入流程
场景1/2/3/4:腾讯渠道&全渠道线索回传及状态更新
回传范围:腾讯广告非官方落地页投放获取的线索明细(联系方式:电话、QQ、微信至少一个)、全渠道线索
线索来源:多来源线索获取,部分线索未沉淀线索管理平台
由于线索未沉淀在腾讯线索通内,第三方落地页工具需同时进行浅层上报和深层状态回传(需要保证outleadsid的唯一性)
STEP 1: 导入外部线索
接口字段详情,*标记为必填,具体请参考:https://developers.e.qq.com/docs/api/insights/leads/outer_clues_add?version=1.1&_preview=1
名称 |
类型 |
描述 |
account_id* |
integer |
广告主账号 id,直客账号或子客账号;若线索为其他渠道线索,则任意使用一个账户id填充在此处即可 |
match_type* |
enum |
默认为CONTACT 腾讯广告按leads_tel>leads_wechat>leads_qq与线索管理平台已有线索进行匹配归因,如果匹配上,更新线索管理平台已有的线索信息,如果匹配不上,作为新线索导入 |
leads_info_list* |
struct[] |
导入的线索信息列表 数组最小长度 1,最大长度 50 |
outer_leads_id* |
string |
外部线索 id,作为线索管理平台的线索与客户侧 CRM 系统的线索关联的唯一标识,该id由客户侧生成,保证唯一即可 字段长度最小 1 字节,长度最大 64 字节 |
leads_type* |
enum |
线索类型, 枚举列表: LEADS_TYPE_FORM //表单预约 LEADS_TYPE_ONLINE_CONSULT //在线咨询 LEADS_TYPE_MAKE_PHONE_CALL //普通电话 LEADS_TYPE_PAGE_SCAN_CODE //加企业微信客服 LEADS_TYPE_PROMOTION_FOLLOW //微信关注 当回传线索为非腾讯渠道线索时,默认使用LEADS_TYPE_FORM |
leads_tel |
string |
手机号 leads_tel、leads_qq、leads_wechat 至少填写一个 字段长度最小 1 字节,长度最大 32 字节 |
leads_qq |
integer |
QQ 号 leads_tel、leads_qq、leads_wechat 至少填写一个 大于等于 1,小于 2^63 |
leads_wechat |
string |
微信号 leads_tel、leads_qq、leads_wechat 至少填写一个 字段长度最小 1 字节,长度最大 64 字节 |
leads_name |
string |
姓名 字段长度最小 1 字节,长度最大 128 字节 |
leads_gender |
enum |
性别, 枚举列表: GENDER_TYPE_UNKNOWN //未知 GENDER_TYPE_FEMALE //女 GENDER_TYPE_MALE //男 |
leads_email |
string |
邮箱 字段长度最小 1 字节,长度最大 64 字节 |
leads_area |
string |
所在地 字段长度最小 1 字节,长度最大 128 字节 |
bundle |
string |
其他线索信息,K-V 键值对, 字符串对字符串的 json 串,key 不能重复 字段长度最小 1 字节,长度最大 1024 字节 |
click_id |
string |
点击 id,用于线索归因,也可填写曝光 id(trace_id) 字段长度最小 1 字节,长度最大 64 字节 |
outer_leads_convert_type |
string |
外部线索状态,无效原因有值时必填 枚举列表: LEADS_CONVERT_STATUS_DEPRECATED //无效线索 LEADS_CONVERT_STATUS_POTENTIAL_CUSTOMER //有效线索 LEADS_CONVERT_STATUS_HIGH_INTENTION_CUSTOMER //有效且高意向客户 LEADS_CONVERT_STATUS_VISIT_STORE //已到店或上门 LEADS_CONVERT_STATUS_TRANS_COMPLETED //已经成单 |
outer_leads_ineffect_reason |
string |
外部无效原因,线索状态为无效时填写 枚举列表: LEADS_INEFFECT_REASON_EMPTY/空号 LEADS_INEFFECT_REASON_SUSPENDED/停机 LEADS_INEFFECT_REASON_OFFLINE/关机 LEADS_INEFFECT_REASON_TEL_NOT_CONNECTED/多次未接通 LEADS_INEFFECT_REASON_ABUSIVE/恶意辱骂 LEADS_INEFFECT_REASON_VICIOUS/恶意留资 LEADS_INEFFECT_REASON_COMPETITOR/同行留资 LEADS_INEFFECT_REASON_IDENTITY_MISMATCHED/否认留资 LEADS_INEFFECT_REASON_NO_HOUSE/无房 LEADS_INEFFECT_REASON_RURAL_HOUSE/自建房 LLEADS_INEFFECT_REASON_SMALL_HOUSE/小面积 LEADS_INEFFECT_REASON_LOW_BUDGET/低预算 LEADS_INEFFECT_REASON_PARTIAL_RENOVATION/局改 LEADS_INEFFECT_REASON_DATA_DUPLICATION/重复 LEADS_INEFFECT_REASON_REGION_MISMATCHED/异地 LEADS_INEFFECT_REASON_NO_INTENTION/接通无需求 LEADS_INEFFECT_REASON_PRODUCT_MISMATCHED/需求不匹配 LEADS_INEFFECT_REASON_LONGTERM/需求周期过长 LEADS_INEFFECT_REASON_OTHER/其他 |
outer_leads_comefrom |
string |
此处标记线索渠道 枚举列表: NATURAL //自然来源 TENCENT //腾讯 BYTEDANCE //字节 KUAISHOU //快手 ALIBABA //阿里 BAIDU //百度 OTHERS //其他 UNKNOWN //未知 |
memo |
string |
备注,字段长度最小 1 字节,长度最大 128 字节 |
请求示例
curl 'https://api.e.qq.com/v1.1/outer_clues/add?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": 123456,
"match_type":"CONTACT",
"leads_info_list": [
{
"outer_leads_id": "abc123",
"leads_type": "LEADS_TYPE_FORM",
"leads_user_id": "user",
"leads_user_type": "USER_TYPE_QQ",
"leads_name": "姓名",
"leads_gender": "GENDER_TYPE_UNKNOWN",
"leads_tel": "11111111111",
"leads_qq": 1234,
"leads_wechat": "cvxsfs",
"leads_email": "34354345@qq.com",
"leads_area": "深圳市南山区",
"bundle": "{\"国籍\":\"test\"}",
"click_id": "xvssdrewrrer3",
"outer_leads_convert_type": "",
"outer_leads_ineffect_reason": "",
"memo": "备注",
"campaign_id": 1234567,
"adgroup_id": 1234568,
"wechat_agency_id": "sp23445342"
},
{
"outer_leads_id": "aaa123456",
"leads_type": "LEADS_TYPE_FORM",
"leads_user_id": "12345678",
"leads_user_type": "USER_TYPE_QQ",
"leads_name": "姓名",
"leads_gender": "GENDER_TYPE_UNKNOWN",
"leads_tel": "11111111111",
"leads_qq": 1234,
"leads_email": "34354345@qq.com",
"leads_wechat": "cvxsfs",
"leads_area": "深圳市南山区",
"bundle": "{\"国籍\":\"test\"}",
"click_id": "xvssdrewrrer8",
"outer_leads_convert_type": "",
"outer_leads_ineffect_reason": "",
"memo": "备注 2",
"campaign_id": 12345672,
"adgroup_id": 12345682,
"wechat_agency_id": "sp23445342"
}
]
}'
STEP 2: 回传线索状态
接口字段详情,*标记为必填,请参考:https://developers.e.qq.com/docs/api/insights/leads/outer_clues_update?version=1.1&_preview=1
名称 |
类型 |
描述 |
account_id* |
integer |
广告主账号 id,直客账号或子客账号;若线索为其他渠道线索,则任意使用一个账户id填充在此处即可 |
match_type* |
enum |
默认为OUTERLEADSID, 腾讯广告按outer_leads_id与线索管理平台已有线索进行匹配归因,如果匹配上,更新线索管理平台已有的线索信息,如果匹配不上,作为新线索导入 |
leads_conversion_status_list* |
struct[] |
回传线索信息的列表 数组最小长度 1,最大长度 50 |
outer_leads_id* |
string |
外部线索 id,作为线索管理平台的线索与客户侧 CRM 系统的线索关联的唯一标识,同导入外部线索时回传的id 字段长度最小 1 字节,长度最大 64 字节 |
outer_leads_convert_type* |
string |
外部线索状态,无效原因有值时必填 枚举列表: LEADS_CONVERT_STATUS_DEPRECATED //无效线索 LEADS_CONVERT_STATUS_POTENTIAL_CUSTOMER //有效线索 LEADS_CONVERT_STATUS_HIGH_INTENTION_CUSTOMER //有效且高意向客户 LEADS_CONVERT_STATUS_VISIT_STORE //已到店或上门 LEADS_CONVERT_STATUS_TRANS_COMPLETED //已经成单 |
outer_leads_ineffect_reason |
string |
外部无效原因,线索状态为无效时填写 枚举列表: LEADS_INEFFECT_REASON_EMPTY/空号 LEADS_INEFFECT_REASON_SUSPENDED/停机 LEADS_INEFFECT_REASON_OFFLINE/关机 LEADS_INEFFECT_REASON_TEL_NOT_CONNECTED/多次未接通 LEADS_INEFFECT_REASON_ABUSIVE/恶意辱骂 LEADS_INEFFECT_REASON_VICIOUS/恶意留资 LEADS_INEFFECT_REASON_COMPETITOR/同行留资 LEADS_INEFFECT_REASON_IDENTITY_MISMATCHED/否认留资 LEADS_INEFFECT_REASON_NO_HOUSE/无房 LEADS_INEFFECT_REASON_RURAL_HOUSE/自建房 LLEADS_INEFFECT_REASON_SMALL_HOUSE/小面积 LEADS_INEFFECT_REASON_LOW_BUDGET/低预算 LEADS_INEFFECT_REASON_PARTIAL_RENOVATION/局改 LEADS_INEFFECT_REASON_DATA_DUPLICATION/重复 LEADS_INEFFECT_REASON_REGION_MISMATCHED/异地 LEADS_INEFFECT_REASON_NO_INTENTION/接通无需求 LEADS_INEFFECT_REASON_PRODUCT_MISMATCHED/需求不匹配 LEADS_INEFFECT_REASON_LONGTERM/需求周期过长 LEADS_INEFFECT_REASON_OTHER/其他 |
请求示例
curl 'https://api.e.qq.com/v1.1/outer_clues/update?access_token=×tamp=&nonce=' \
-H 'Content-Type: application/json' \
-d '{
"account_id": 123456,
"match_type":"OUTERLEADSID",
"leads_conversion_status_list": [
{
"outer_leads_id": "123",
"outer_leads_convert_type": "试驾",
"outer_leads_ineffect_reason": ""
},
{
"outer_leads_id": "12356",
"outer_leads_convert_type": "试驾",
"outer_leads_ineffect_reason": ""
}
]
}';
场景5:腾讯官方落地页线索更新
1) 回传范围:仅回传腾讯广告投放获取的线索转化状态
2) 线索来源:仅使用“微信原生、蹊径、附加创意”收集线索,线索均沉淀线索管理平台,无需客户再次回传。
3) 对接流程:
接口字段详情,*标记为必填,请参考:
获取线索
https://developers.e.qq.com/docs/api/insights/leads/lead_clues_get
更新线索
https://developers.e.qq.com/docs/api/insights/leads/lead_clues_update
名称 |
类型 |
描述 |
account_id* |
integer |
广告主账号 id,直账号或子客账号;若线索为其他渠道线索,则任意使用一个账户id填充在此处即可 |
match_type* |
enum |
默认为CONTACT 腾讯广告按leads_tel>leads_wechat>leads_qq与线索管理平台已有线索进行匹配归因,如果匹配上,更新线索管理平台已有的线索信息,如果匹配不上,作为新线索导入 |
leads_info_list* |
struct[] |
导入的线索信息列表 数组最小长度 1,最大长度 50 |
leads_tel |
string |
手机号 leads_tel、leads_qq、leads_wechat 至少填写一个 字段长度最小 1 字节,长度最大 32 字节 |
leads_qq |
integer |
QQ 号 leads_tel、leads_qq、leads_wechat 至少填写一个 大于等于 1,小于 2^63 |
leads_wechat |
string |
微信号 leads_tel、leads_qq、leads_wechat 至少填写一个 字段长度最小 1 字节,长度最大 64 字节 |
outer_leads_convert_type |
string |
外部线索状态,无效原因有值时必填 枚举列表: LEADS_CONVERT_STATUS_DEPRECATED //无效线索 LEADS_CONVERT_STATUS_POTENTIAL_CUSTOMER //有效线索 LEADS_CONVERT_STATUS_HIGH_INTENTION_CUSTOMER //有效且高意向客户 LEADS_CONVERT_STATUS_VISIT_STORE //已到店或上门 LEADS_CONVERT_STATUS_TRANS_COMPLETED //已经成单 |
outer_leads_ineffect_reason |
string |
外部无效原因,线索状态为无效时填写 枚举列表: LEADS_INEFFECT_REASON_EMPTY/空号 LEADS_INEFFECT_REASON_SUSPENDED/停机 LEADS_INEFFECT_REASON_OFFLINE/关机 LEADS_INEFFECT_REASON_TEL_NOT_CONNECTED/多次未接通 LEADS_INEFFECT_REASON_ABUSIVE/恶意辱骂 LEADS_INEFFECT_REASON_VICIOUS/恶意留资 LEADS_INEFFECT_REASON_COMPETITOR/同行留资 LEADS_INEFFECT_REASON_IDENTITY_MISMATCHED/否认留资 LEADS_INEFFECT_REASON_NO_HOUSE/无房 LEADS_INEFFECT_REASON_RURAL_HOUSE/自建房 LLEADS_INEFFECT_REASON_SMALL_HOUSE/小面积 LEADS_INEFFECT_REASON_LOW_BUDGET/低预算 LEADS_INEFFECT_REASON_PARTIAL_RENOVATION/局改 LEADS_INEFFECT_REASON_DATA_DUPLICATION/重复 LEADS_INEFFECT_REASON_REGION_MISMATCHED/异地 LEADS_INEFFECT_REASON_NO_INTENTION/接通无需求 LEADS_INEFFECT_REASON_PRODUCT_MISMATCHED/需求不匹配 LEADS_INEFFECT_REASON_LONGTERM/需求周期过长 LEADS_INEFFECT_REASON_OTHER/其他 |