拉新拉活技术对接文档

文档更新记录

版本作者时间备注
v1.0黄驰铭2021.04.21创建
v1.1黄驰铭2021.07.27增加曝光点击上报
v1.2张 勇2021.08.25添加曝光监测 callback_url
v1.3张 勇2021.08.25添加 ad_id creative_id
v1.4张 勇2021.09.02添加 os androidid
v1.5Herb2022.07.13修改事件参数
v1.6Herb2022.08.11增加更多事件类型
v1.7张勇2024.05.31增加caid示例说明
v1.8张勇2024.05.31增加 ip ua timestamp 请求字段

RTA

  • 接口地址: 合作方提供
  • 请求方法: HTTP POST
  • 参数格式: JSON

请求

{
  "devices": [
    {
      "type": "imei",
      "md5": "da61276e33a7f793f88dfb850f95f5bc"
    },
    {
      "type": "oaid",
      "md5": "13e33fe6feed06df7f1773b5e537b699"
    },
    {
      "type": "idfa",
      "md5": "3692bf08849255cfbc5b9dcec320f4a3"
    }
  ]
}

响应

{
  "result": [
    {
      "type": "imei",
      "md5": "da61276e33a7f793f88dfb850f95f5bc",
      "tasks": [
        "自",
        "定",
        "义"
      ]
    },
    {
      "type": "oaid",
      "md5": "13e33fe6feed06df7f1773b5e537b699",
      "tasks": [
        "自",
        "定",
        "义"
      ]
    },
    {
      "type": "idfa",
      "md5": "3692bf08849255cfbc5b9dcec320f4a3",
      "tasks": [
        "自",
        "定",
        "义"
      ]
    }
  ]
}

曝光 / 点击上报

  • 接口地址: 合作方提供
  • 请求方法: HTTP GET

上报参数

参数名必传备注
ad_unit_id是广告位标识, 客户提供
action是imp: 曝光 / click: 点击
callback_url否归因回调地址，点击必传
ad_id否广告id
creative_id否素材id
os否1：android 2：ios 3：未知
ip否ip
ua否ua
timestamp否点击时间，秒
以下是设备号, 某一个字段会不为空
imei否imei 明文
imei_md5否imei md5
oaid否oaid 明文
oaid_md5否oaid md5
idfa否idfa 明文
idfa_md5否idfa md5
caid否URL Encode后的JSON数组:其中caid为中广协ID（即CAID），caid_md5为CAID原值MD5加密后的结果, version为中广协caid版本号，支持两个版本同时下发（即最新版和上一版），仅在新版转化归因支持
androidid否androidid 明文
androidid_md5否androidid md5

caid示例

[{ "caid": "bed47550547dc8d51c98b668eb690140","caid_md5": "27dc3f5a7c02e8cba6e699c3ee07b295","version": "20220501"}, {"caid": "cb187c190ba19b7863c803cb27ab2523", "caid_md5":"34ae823c759e5c0480867247c77462bb", "version": "20210501"}]

url encode 后的值
%5B%7B%20%22caid%22%3A%20%22bed47550547dc8d51c98b668eb690140%22%2C%22caid_md5%22%3A%20%2227dc3f5a7c02e8cba6e699c3ee07b295%22%2C%22version%22%3A%20%2220220501%22%7D%2C%20%7B%22caid%22%3A%20%22cb187c190ba19b7863c803cb27ab2523%22%2C%20%22caid_md5%22%3A%2234ae823c759e5c0480867247c77462bb%22%2C%20%22version%22%3A%20%2220210501%22%7D%5D

上报请求示例

曝光 (我方上报客户方)

https://xxx.com?ad_unit_id=ID1&action=imp&imei_md5=da61276e33a7f793f88dfb850f95f5bc&callback_url=https%3A%2F%2Fapi.mobrtb.com%2Ftracker%3Frequest_id%3Dc3vnbrg096rmsl4mbdlg%26log_event_type%3D24

点击 (我方上报客户方)

https://xxx.com?ad_unit_id=ID1&action=click&imei_md5=da61276e33a7f793f88dfb850f95f5bc&callback_url=https%3A%2F%2Fapi.mobrtb.com%2Ftracker%3Frequest_id%3Dc3vnbrg096rmsl4mbdlg%26log_event_type%3D24

转化 (客户方上报我方)

需要把曝光/点击上报地址里面的 callback_url 取出来, url decode, 在末尾加上 &xy_callback_type=$具体转化值

示例:

转化类型转化值
唤端app_opened
首唤first_app_opened
注册registration
激活activation
下单order
购买purchase
次日留存d1_retention
商品详情浏览product_detail_view
登录login
关键行为key_behavior

付费需要回传金额，可拼接 &amount=$具体数值，单位为分。

response:

参数名类型备注
codeint状态码： 0 正常 非0 不正常
messagestring正常返回 success