接口文档SDK业务专题开发者工具

APP转化数据API自归因文档

 
目录
 
一. 请求参数及示例
二. 优化目标上报方式说明
三. 转化上报常用参数列表(action_param)
四. 数据上报错误提示
五. 设备标识获取方式
FAQ

 

以下内容建议提供给将您的转化数据回传给腾讯广告的技术侧阅读,优化师及广告投手阅读 帮助中心-转化归因使用指南-应用转化归因操作手册 ,在广告创建时进行归因设置。
登录 投放管理平台 → 上方工具箱 → 转化归因,可以找到应用转化中的API(自归因上报)接口。

一. 请求参数及示例

名称 是否必填 类型 描述
user_id hash_imei Android 必填 (android10以上获取不到imei可以不填)
IOS不填
string IMEI设备号保持小写,进行MD5编码字段长度为32字节
hash_idfa IOS必填
Android 不填
string IDFA设备号保持大写,进行MD5编码
字段长度为32字节
hash_phone 选填 string 电话号码直接 MD5 编码,如 md5(13500000000)
字段长度为32节
oaid Android 选填,推荐使用

IOS不填
string 移动安全联盟(简称MSA)制定的匿名设备标识符,保留原始值,不需要MD5编码。具体OAID介绍以及最新覆盖厂商范围请详见
[MSA官网]
hash_oaid Android 选填,推荐使用

IOS不填
string oaid原值进行MD5编码
hash_android_id Android 选填

IOS不填
string 对 android_id 进行 MD5 编码
字段长度为 32 字节
caid IOS选填,

Android不填
string 全称CAA Advertisng id,中国广告协会互联网广告标。通过采集IOS系统12个非隐私参数使用固定规则生成的设备指纹,由数字和小写字母组成的32位长度的字符串。上报caid时caid_version为必填项,建议上报最新的caid版本
字段长度最小为1字节,长度最大为64 字节
caid_version IOS选填,

Android不填
string caid版本编号。建议上报最新的caid版本;版本号为腾讯版本号
中广协版与腾讯版本号对应关系:中广协20201230对应腾讯版本号1003,中广协20211207对应腾讯版本号1004,中广协20220111对应腾讯版本号1005
ip IOS选填,

Android选填
string 用户终端的IP地址,支持IPv4和IPv6
user_agent IOS选填,

Android选填
string 用户代理
CALLBACK / 必填 string 直接从点击转发出去的__CALLBACK__字段中URLDecode获得,每次点击唯一,作为上报地址使用
curl -X POST 
  http://tracking.e.qq.com/conv?cb=YWRzX3NlcnZpY2UsMTU4NDUxMDI3OSwyNjg5MzNhMzc5MTM0YzBjMDQ4ZGZjMGQyNGYzMTk0NWYzMzJiOWNi&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进行去重
            "action_time":1492998081,
            "user_id":{// 必填 user_id,可采集到的设备标示
                "hash_imei":"7a4e6b9571b8911f9a035b3a76228ef7",// 示例,请勿直接上报,android设备上报imei
                "hash_idfa":"abbaa569f8ab7cb1715c8aabe1db1247",// 示例,请勿直接上报,ios设备上报idfa
                "hash_android_id":"",
                "oaid":""
                "hash_oaid":""
                "caid":"a424aafe3c44b7e3618a95c0d55a56de",// 示例,请勿直接上报,ios设备上报caid
                "caid_version":"1004",// 示例,请勿直接上报,ios设备上报caid_version
            },
            "action_type":"ACTIVATE_APP", // 必填 行为类型
            "action_param":{
                "value":123,// 选填,用作付费/下单金额等上报
                "int_example":456,// 选填,int类型参数示例
                "int_array_example":[
                    123,
                    456
                ],// 选填,int类型数组示例
                "string_example":"aaa",// 选填,string类型参数示例
                "string_array_example":[
                    "aaa",
                    "bbb"
                ]// 选填,string类型数组示例
            }
        }
    ]
}'


  当请求API后,收到返回值为{"code":0, "message":""} 表示广告平台成功收到数据
  注意上报地址__CALLBACK__是直接从点击转发出去的__CALLBACK__字段中URLDecode获得,上面示例中的url&path是示例请求,请勿直接上报

 

二. 优化目标上报方式说明
 

优化目标名称 标准行为(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″

 

三. 转化上报常用参数列表(action_param)

参数名 类型 描述 是否必填 取值范围 备注
value int 订单价值,单位:分 体现转化带来的价值,在上报COMPLETE_ORDER或PURCHASE行为时可选填
object string 行为对象 ^.{0,200}$ 在上报VIEW_CONTENT行为时参数填写为object=product,表示上报的是商品页面浏览行为
length_of_stay int 停留时间,单位:天 在上报START_APP作为留存行为时必填。length_of_stay=1,表示上报的是次日留存行为。

 

四. 数据上报错误提示

错误码 中文提示 英文提示
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

 

五. 设备标识获取方式

IMEI

  • 描述:

    1. Android版本 < 6.0,只需要READ_PHONE_STATE静态权限(安装App时即可获取到该权限),即可通过系统API TelephonyManager#getDeviceId API获取准确值;
    2. 6.0 <= Android版本 <= 9.0,READ_PHONE_STATE升级为动态权限,安装App时不会获得该权限,需要在App运行时用户在弹窗确认授权后才可以获取
    3. Android版本 >= 10.0,设备不可变ID的隐私保护得到进一步升级,需要READ_PRIVILEGED_PHONE_STATE权限才可以获取IMEI,而该权限只有系统级别的应用才可以获得,因此一般App无法获取到IMEI。android10以上获取不到imei可以不填。
  • 原始数据获取

    TelephonyManager tm = (TelephonyManager) context.getSystemService(Context.TELEPHONY_SERVICE);
    deviceId = tm.getDeviceId(); 
    // android版本>=10.0 不获取
  • 加密方式
    对IMEI设备号转成小写,再进行md5编码,再小写,32位。md5(imei.toLowerCase()).toLowerCase()

  • 示例

    • 原始值:868049039501257
    • MD5后:8d3ebd3654fb46a2832296669cf1b536

IDFA

  • 描述:
    目前iOS系统主流的广告获取设备标识符方式。用户可开启、关闭,每次切换会改变为新的取值。 10以下的版本关闭时也能取到唯一值, >=10的iOS版本关闭时取到的值为00000000000 ;系统大版本升级(如11 到 12) IDFA也会发生变化
  • 原始数据获取
    idfa = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];
  • 加密方式
    IDFA 设备号保持大写,进行 md5 编码,再小写,32位。md5(idfa.toUpperCase()).toLowerCase()

Android ID

  • 描述:
    1. Android版本 = 8.0,应用签名、用户(即系统上的用户账号)和设备的每个组合都具有唯一的 ANDROID_ID值,即使系统升级也不变。
  • 原始数据获取
    Settings.System.getString(context.getApplicationContext().getContentResolver(),
    Settings.System.ANDROID_ID);
  • 加密方式
    对 android_id 进行 md5 编码,再小写。 md5(androidId).toLowerCase()
  • 示例
    • 原始值:f40c5cf5100f9be3
    • MD5后:1995c8f7cec20632797539b68555752f

OAID

  • 描述:
    移动安全联盟(简称MSA)制定的匿名设备标识符,保留原始值,不需要MD5编码。可用于android系统的补充设备标示,通常android10以上的国内主流设备都可以获取。具体OAID介绍以及最新覆盖厂商范围请详见 [MSA官网]
  • 原始数据获取
    使用MSA官网提供的sdk
  • 加密方式
    无需加密

MSA网站获取oaid具体步骤:

  1. 登录MSA官网

  2. 注册成为网站会员;

  3. 进入移动智能设备标识公共服务平台模块;

  4. 拉至页面最下方,阅读开发者说明,并下载安装SDK;

HASH_OAID

  • 描述:
    移动安全联盟(简称MSA)制定的匿名设备标识符,原始值进行MD5编码。可用于android系统的补充设备标示,通常android10以上的国内主流设备都可以获取。具体OAID介绍以及最新覆盖厂商范围请详见 [MSA官网]
  • 原始数据获取
    使用MSA官网提供的sdk
  • 加密方式
    OAID原值做MD5加密