跳到主要内容

小游戏转化数据API自归因


前置条件

上传微信行为数据时，首先必须获取 openID 所对应的 APP ID 授权。如果未经授权或 APPID 和 openID 不是对应关系，将导致归因失败。 授权操作详见微信数据接入。


微信转化数据上报说明及示例​

微信小游戏的API自归因利用__CALLBACK__(cb) / clickid 和微信 openid 作为用户标识，从而实现腾讯点击数据和全网转化数据的匹配。因此必须将 cb / clickid、小游戏 appid、微信 openid 连同转化类型（ActionType） 一并上报给腾讯广告，经过腾讯广告计算后，将最终数据呈现在投放端。微信小游戏统一采用注册归因口径。


名词解释​

cb：直接从点击转发出去的__CALLBACK__字段中 URLDecode 获得，每次点击唯一，作为上报地址使用。 clickid：在腾讯广告推广时，每次点击都会生成一个 click_id，用于唯一标识一次用户点击。在微信小游戏场景中，可以从⼩游戏数据监控参数的gdt_vid字段中获取(即微信广告traceid)，详见微信⼩游戏⼴告数据监控指引 openid：对于微信小游戏的用户，每个用户都会在每个小游戏生成一个 openid，将 openid 与小程序 appid 作为转化数据的标识。 注册归因：指注册后的行为（如创角、付费等）会归因到前置的注册；建议配合注册口径报表使用。

请求体示例​

若您在创建转化时填写了点击监测链接，则应采用如下上报协议​

curl -X POST 
https://api.e.qq.com/v3.0/user_actions/add?cb=YWRzX3NlcnZpY2UsMTU4NDUxMDI3OSwyNjg5MzNhMzc5MTM0YzBjMDQ4ZGZjMGQyNGYzMTk0NWYzMzJiOWNi&link_id=10001 //这里请求的url&path 直接从点击转发出去的__CALLBACK__字段中URLDecode获得，左边是示例请求，请勿直接上报
-H 'Content-Type: application/json' 
-H 'access_token: <ACCESS_TOKEN>'  // 新增字段
-H 'timestamp: <TIMESTAMP>'  // 新增字段
-H 'nonce: <NONCE>'  // 新增字段
-H 'cache-control: no-cache' 
-d '{
   "actions":[
        {
        "outer_action_id": "outer_action_identity", // 选填，若上报可能有重复请填写该id，系统会根据该ID进行去重，详见FAQ
        "action_time": 1492998081,
        "user_id": { // user_id，可采集到的设备标识
        "hash_imei": "f9efca36a3c30e1cf28170d86ecbf5e9",
        "hash_idfa": "f9efca36a3c30e1cf28170d86ecbf5e9",
        "hash_android_id": "",
        "wechat_app_id":"", //微信小游戏上报必填 且必须通过授权
        "wechat_openid":"", //微信小游戏上报必填
        "oaid":""
        },
        "action_type": "ACTIVATE_APP", // 必填 行为类型
        "action_param": {
        "value": 123,
        "int_example": 123,
        "int_array_example": [
         123,
         234
        ],
        "string_example": "123",
        "string_array_example": [
        "123",
        "234",
        "abc"
        ]
       }
    }
   ]
}'

若您在创建转化时没有填写点击监测链接，则应采用如下上报协议​

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，可采集到的设备标识
        "hash_imei": "f9efca36a3c30e1cf28170d86ecbf5e9",
        "hash_idfa": "f9efca36a3c30e1cf28170d86ecbf5e9",
        "hash_android_id": "",
        "wechat_app_id":"", //微信小游戏上报必填 且必须通过授权
        "wechat_openid":"", //微信小游戏上报必填
        "oaid":""
        },
        "action_type": "ACTIVATE_APP", // 必填 行为类型
        "trace": {
        "click_id":"abc" // 必填 click_id
        },
        "action_param": {
        "value": 123,
        "int_example": 123,
        "int_array_example": [
         123,
         234
        ],
        "string_example": "123",
        "string_array_example": [
        "123",
        "234",
        "abc"
         ]
       }
    }
   ]
}'

应答示例​

{
  "code": 0,
  "message": "",
  "message_cn": {},
  "trace_id": "ee1fe1f904985216ca4d761c07840d16_0"
}


可以从投放端报表中，进一步观察和监控数据上报表现和投放效果。


注意

微信小游戏的转化数据上报必须填写创建转化时填写的小游戏APPID (以wx开头)和产生转化行为的用户openid。 上报地址__CALLBACK__是直接从点击转发出去的__CALLBACK__字段中 URLDecode 获得，上面示例中的 url&path 是示例请求，请勿直接上报。


post 形式上报示例二：未填写点击转发链接，上报 clickid​

使用此方式时，需要满足：

  1. 您在创建转化时候没有填写点击监测，这一步可以和您的广告投放方确认，在 腾讯广告 – 投放管理平台 → 上方工具箱 → 转化归因-Web类-网页转化时没有使用了监测服务
  2. 如果您在url字段填写投放落地页链接域名，在上报前必须在 投放管理平台→ 上方工具箱 → 转化归因-Web类-网页转化，创建url字段里对应的url域名的转化。这一步可以联系您的广告投放方完成，填写的网页链接与您上报时的url保持一致。
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，可采集到的设备标示
                "hash_imei":"7a4e6b9571b8911f9a035b3a76228ef7",// 示例，请勿直接上报，android设备上报imei
                "hash_idfa":"abbaa569f8ab7cb1715c8aabe1db1247",// 示例，请勿直接上报，ios设备上报idfa
                "hash_android_id":"",
                "oaid":""
                "hash_oaid":""
                "ip":“”
                “user_agent":""
            },
            "action_type":"ACTIVATE_APP", // 必填 行为类型
            "url": "www.my.com",  // 网页域名, 必填
            "trace": {
            "click_id":"abc" // 必填 click_id
            },
            "action_param":{
            ......
            }
        }
    ]
}'

get 形式上报示例​

使用此方式时，需要满足： 您在创建转化时候没有填写点击监测，这一步可以和您的广告投放方确认，在 腾讯广告 – 投放管理平台 → 上方工具箱 → 转化归因-Web类-网页转化时没有使用了监测服务。

curl 'http://tracking.e.qq.com/conv/web?clickid=5p76exycaaapu6n3tpqq&action_time
=1606877439&action_type=DELIVER&link=www.xxx.com'
// clickid
// action_time: 用户转化行为发生时间（秒）
// action_type: 转化行为类型
// link：URLencode之后的域名，请保持与创建转化时填写的网页链接对应

应答示例​

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

注意

小程序类的转化数据上报必须填写创建转化时的小程序的 APPID (以 wx 开头)。 上报地址__CALLBACK__是直接从点击转发出去的__CALLBACK__字段中 URLDecode 获得，上面示例中的 url&path 是示例请求，请勿直接上报。




QQ小游戏转化数据上报说明及示例​

QQ小游戏的API自归因仍然采用旧链路的数据源上报方式。QQ小游戏统一采用点击归因口径。上报示例如下：

curl -X POST \
‘https://api.e.qq.com/v1.1/user_actions/add?access_token=<your_access_token>&timestamp=<timestamp>&nonce=<nonce>‘ \  //MKT api 请求通用参数 请参考https://developers.e.qq.com/docs/start/request#a5
-H ‘Content-Type: application/json’ \
-d ‘{
“account_id”: “<your_account_id>“, //必填 上报数据源对应账号
“user_action_set_id”: <your_user_action_set_id>, //必填 上报数据源
“actions”: [
{
“action_time”: <action_timestamp>, //转化行为发生的时间戳
“action_type”: “RESERVATION”, // 必填 行为类型
“trace”: {
“click_id”: “<CLICK_ID>“
}
}
]
}’


确定行为类型​

在数据上报接口的必填字段 action_type 中，填写需要上报的转化行为类型。 常用的优化目标对应行为类型请见下表，完整转化行为请参考 action_type 标准行为类型枚举。

优化目标名称标准行为（action_type）数据指标备注
付费PURCHASE小游戏付费次数 小游戏付费金额（元）用户在小游戏中发生购买道具等付费行为
次留START_APP小游戏次留人数用户首次进入小游戏后，次日再次进入小游戏
关键页面访问/停留大于30s人数注册用户停留大于30s，数据由小游戏平台上报，无需广告主回传
小游戏创角CREATE_ROLE小游戏创角人数广告主自定义的小游戏内角色创建行为

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

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

数据上报错误提示​

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



该内容是否有帮助？