跳到主要内容

APP转化数据API自归因


请求参数​

名称类型必填描述
user_idobject
用户标识，app 数据上报时必填，web 数据上报时可以不填 user_id，但建议填写，方便后续优化
hash_imeistring
Android 必填 （android10以上获取不到imei可以不填），IOS不填IMEI 设备号保持小写，进行 md5 编码，字段长度为 32 字节
hash_idfastring
iOS必填，Android 不填，IDFA 设备号保持大写，进行 MD5 编码，字段长度为 32 字节
hash_phonestring
电话号码直接 MD5 编码，如 md5(13500000000)，字段长度为 32 字节
sha256_phonestring
SHA256 算法加密后的手机号，加密前为 11 位的纯数字串，加密后为不计大小写的 64 位数字字母串，字段长度为 64 字节
oaidstring
Android 选填，推荐使用，iOS不填，MSA 制定的匿名设备标识符，保留原始值，然后进行 MD5 编码。具体 OAID 介绍请见http://msa-alliance.cn，字段长度为 32 字节
hash_oaidstring
Android 选填，推荐使用，iOS不填，MSA 制定的匿名设备标识符，保留原始值，然后进行 MD5 编码。具体 OAID 介绍请见http://msa-alliance.cn，字段长度为 32 字节
hash_android_idstring
Android 选填，推荐使用，iOS不填，android_id 进行 MD5 编码，字段长度为 32 字节
caidstring
iOS选填，Android不填，全称 CAA Advertising id，中国广告协会互联网广告标。通过采集 IOS 系统 12 个非隐私参数使用固定规则生成的设备指纹，由数字与小写字母组成的 32 位长度的字符串。上报 caid 时 caid_version 为必填项，建议上报最新的 caid 版本，字段长度为 64 字节
caid_versioninteger
iOS选填，Android不填，caid 版本编号。建议上报最新的 caid 版本，最大值 2147483647
ipstring
用户终端的IP地址，支持IPv4和IPv6
user_agentstring
iOS选填，Android选填，用户代理
CALLBACKstringY
直接从点击转发出去的__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类型数组示例
            }
        }
    ]
}'

应答体结构​

名称类型是否一定返回描述
codeintegerY返回码，等于0表示成功，不等于0表示错误，具体见文档附录
messagestringY错误描述，code不等于0时，message为错误描述
message_cnstring中文错误描述，code不等于0时，message_cn为错误情况的中文描述
dataobject资源数据，具体返回内容见各接口定义，只在code等于0时可能返回
errorsobject详细错误信息，只在code不等于0时可能返回

应答示例​

{
  "code": 0,
  "message": "",
  "message_cn": {},
  "trace_id": "ee1fe1f904985216ca4d761c07840d16_0" //DataNexus 赋予的唯一 id 值，供排查问题使用，若咨询反馈中心请提供该字段的值
}


注意

上报地址 __CALLBACK__ 是直接从点击转发出去的__CALLBACK__字段中 URLDecode 获得，上面示例中的 url&path 是示例请求，请勿直接上报


优化目标上报方式说明​

优化目标名称标准行为（action_type）行为参数（action_param）投放端指标备注
下单COMPLETE_ORDER下单量若要上报金额请在param中添加参数“value”：123
表单预约RESERVATION
注册REGISTER注册量
激活ACTIVATE_APP激活量对同一个应用30天内重复的设备激活行为去重
次日留存START_APPlength_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_APPlength_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
主动一句话咨询CONSULTconsult_type=”INTELLIGENT_TOOL” AND consult_active_type=”1_1″
三句话咨询CONSULTconsult_type=”INTELLIGENT_TOOL” AND consult_active_type=”3_0″

转化上报常用参数列表（action_param）​

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

数据上报错误提示​

错误码中文提示英文提示
20001回调 url 内容错误CB_CONTENT_ERROR
20002没有与转化 ID 对应的转化规则CONV_ID_ILLEGAL
20003无效数据源 IDACTION_SET_ID_ABNORMAL
20004无效账户 IDACCOUNT_ID_ABNORMAL
20005编码 base64 密钥失败ENCODE_B64_KEY_ERROR
20006回调 url base64 解码失败DECRYPT_B64_CB_ERROR
30000Api 访问失败API_ERROR



该内容是否有帮助？