API百度互传方案（百度传送）

百度移动DSPAPP转化监控工具-API互传方案

V2.6

简介? 对接流程：

1. 广告主确认对接方式（即在MDSP平台选择API互传方案）2. 广告主方确认用户标识（IMEI,IDFA等）3. 设置回调地址（百度发送点击用户的相关信息给广告主）4. 回调收到数据及时发送收到应答5. 激活数据拼接6. 激活回传

用户点击广告

1.媒体返回点击用户的设备信息到百度服务器

2. 点击回调按照feedback URL格式封装点击回调

3.  广告主服务器收到应用的转化信息

4. 激活回传回传归属为百度渠道的激活，采用激活回传接口

5.  百度将收到的数据再次匹配校验，结果发送至报表

6.  广告投放人员通过报表查看广告投放效果，优化投放配置

百度服务器

广告主自建服务器或委托第三方服务器 广告投放人员

? API互传方案：API互传方案指百度将点击广告的用户信息发送到广

告主的接收地址，广告主可根据自己的激活数据进行比对后将数据回传给百度，百度再进行确认后在系统报表展示。基本原理如下图所示：

对接的关键步骤

用户激活应用

对接步骤一：确认对接方法

? 设置入口：在madv.baidu.com登录账号，点击工具 – 应用库中进行相关设置。

? 详细步骤说明：1. 若要在已创建应用上修改转化监控方

式，点击编辑；若在新建应用上选择转化监控方式，点击新建应用。

2. 将转化方案选择为API互传方案，若您看不到API互传方案，请找业务运营同学开通权限。

3. 点击检测可用会帮您做一些基础的语法校验。

4. 点击使用协议说明您将看到此文档。

对接步骤二：设置回调地址接收点击日志? 广告主回调地址（即广告主feedback  url）百度用get方法请求该回调地址

? iOS推广回调地址范例（红色部分请务必按照规范填写）– http://nuomi.baidu.com:8000/app/?idfa={@md5(idfa)}&mac={@mac}&appid={@appid}&cid={@cid}&crid={@

crid}&traceid={@traceid}&ip={@ip}&devicetype={@devicetype}&osversion={@osversion}&pk={@pk}

? Android推广回调地址范例（红色部分请务必按照规范填写）– http://nuomi.baidu.com:8000/app/?imei={@md5(imei)}&mac={@mac}&appid={@appid}&cid={@cid}&crid={

@crid}&traceid={@traceid}&ip={@ip}&devicetype={@devicetype}&osversion={@osversion}&pk={@pk}

? 字段注意项：? traceid为追踪激活的唯一标示符，请确保该字段必须在回调参数中。? 请注意勿将回调地址和下载地址混淆！回调地址为您接收点击日志回传的地址；下载地址为应用对应的下载

地址。回调地址（即广告主Feedback  URL）中请填入合乎规范的地址，参考以上范例。

? 具体的参数解释和字段操作如：md5签名，见下页

对接步骤二：点击回调参数说明

? 接口字段含义解释字段 介绍 模板示例 取值举例

idfa iOS设备唯一标识符 {@idfa} 560967CC-AC56-4CFF-83D9-E3A37AAD8856

imei Android移动设备标识 {@imei} 358848048725980

mac 设备MAC地址 {@mac} AA:BB:CC:DD:EE:FF

android_id Android设备唯一标识码 {@android_id} 533638ee2eca5612

clktime 点击广告时间 {@clktime} 20151112213410

appid 媒体id {@appid} a1cd7e67

cid 渠道ID，固定值mobads {@cid} mobads

crid 广告创意id {@crid} 1000

traceid 检索id {@traceid} 9d228c214133a2cf35117,42bf4262551300

ip 用户点击的IP地址 {@ip} 172.20.131.98

devicetype 设备类型或机型信息 {@devicetype} 格式：手机品牌-手机型号Android系统: Xiaomi-HM  NOTE  1SiOS系统: apple-iPhone7,1字段值做url-encoding处理

osversion 设备操作系统信息 {@osversion} Android系统: android-5.1iOS系统: ios-9.3

pk 广告主应用包名 {@pk} com.baidu.sj

操作名 介绍 示例

toUpper 转为大写 {@toUpper(mac)}

toLower 转为小写 {@toLower(mac)}

md5 md5加密 {@md5(mac)}

clearColon 去冒号 {@clearColon(mac)}

注意：

广告主在收到数据后需在400ms内响应状态码200。若百度未收到200响应，会重发3次；如还未收到响应则放弃发送。

? 字段支持的操作方式

对接步骤三：激活回传? 激活数据回传接口实例（默认方式）

– http://mobads-logs.baidu.com/dz.zb?type=12&mac=1C:AB:A7:D6:E7:81&idfa=5A58EF1E-EEF2-478D-94EE-709B98407589&traceid=9d228c214133a2cf35117,42bf4262551300&t=20161013160651&act=0&md5=0&crid=1000&appid=a1cd7e67&pk=com.baidu.test

注意项：– 接口字段定义见下页– 理想情况最多含有10个参数；强烈建议把所有参数都填写上；– type=12请务必放到第一个参数，红色部分参数名称请勿写错；– 若同一个用户多次点击广告，您可能会收到多个点击监控，回传时可选时间最近的一个traceid回传；– 回传成功时将收到服务器端状态为200  OK的HTTP应答，应答内容可忽略；– 请尽量实时回传确认后的激活数据；– 激活数据拼接建议广告主匹配7天时间窗的点击数据；– 激活回传实际数据与报表数据存在不一致原因：点击数据为原始点击数据，但部分点击会被百度反作弊过滤；– 激活拼接建议：强烈建议使用以设备号（idfa)为主，以指纹匹配（ip+devicetype+osversion）算法为辅的拼接逻辑；

对接步骤三：激活回传，设置回传参数? 广告主激活回调接口 请求地址：http://mobads-logs.baidu.com/dz.zb?type=12

字段 介绍 格式要求 取值举例 是否必填

type 用于识别日志为广告主回传数据

固定字段，取值为type=12，置于参数首位，紧跟"？"，否则数据会被过滤

12 是

mac 设备WiFi的MAC地址

大写字母，带冒号分隔符 AA:BB:CC:DD:EE:FF 是

idfa iOS设备id 大写字母，带中划线分隔符 111F7987-6E2F-473A-BFED-E4C52CB5A6DC 选填，iOS填写，由md5字段决定

imei Android的设备号 14或者15位16进制数 869630010707101 选填，Android填写，由md5字段决定

traceid 点击监控携带的traceid

对应收到的检索id，必须返回，否则无法拼接 54b8cce7c214133a2cf35117 是

md5id 设备id的md5值 点击回传时uid使用md5加密情况下使用该值 24d9db2aa93bc9aa1ad57916e5300f20（32位加密）

选填，根据字段md5的值确定

t 激活时间 %Y%m$d%H%M%S 20150606123015 是

act 转化类型 表明转化行为，默认为0，若需告知其他转化行为可发送对应值。0：激活；1：次日留存；2：7日留存；3：注册4：内购（游戏or图书）5：成单（电商）6：付费（电商）

0 是

md5 是否使用md5 0：不使用，则idfa/imei必传；1：使用，则md5id必传 0 是

crid 广告创意id 点击监控收到的crid 1000 取决于是否在回调中获取该值

appid 媒体id 点击监控收到的pid a1cd7e67 取决于是否在回调中获取该值

pk 应用包名，用于识别激活的应用包

下载类使用该字段，ios填写bundleID，android填写package  name

com.baidu.sj 是

对接步骤四：对接校验1、"点击校验"进入校验环节（图1），如果feedbackURL格式有错误会提示2、点击模拟（图2），根据调试需求，将可编辑字段修改为需要的值，比如：imei改为已知激活的设备值，点"确定"后客户服务器发送模拟点击，如果接收到http状态码200，则认为发送成功3、激活验证（图3），当客户按照准确的格式回传激活信息，会接收到一个应答信息，如：{"error":0, "msg":"  WaRedM"}，此时将应答码填入"验证码"，验证成功将提示"成功"信息

注：当前暂时不支持对字符操作符的验证，比如取md5

图1

图2

图3

常见问题? 回调地址是否需要设置所有的参数？

可以按需获取，百度建议获取所有参数，在您服务端您可以自由取舍。但请勿获取非百度提供参数。

? 回调地址获取到数据后是否一定要发送200应答？是的，并且需要在400毫秒内响应，百度服务器会超时重发，但重发次数最多3次。

? idfa、imei、MAC为何有时是空值？由于用户对设备权限设置，有些设备可能请求不到对应的设备信息，这时对应字段值可能为空。

? 数据传输是否支持加密？目前仅支持对参数实现md5加密，且仅对设备号相关参数（idfa/imei）进行md5。

? 激活回传后未收到百度返回的200应答怎么办？请仔细检查参数顺序以及参数名称是否符合规范。

? 除了激活回传，其他转化行为回传需要重发其他参数请求吗？是的，若您发送过act=0的激活回传，想发送注册回传，需再次发送完整参数实现act=3的注册回传。

? 目前报表支持其他维度的转化信息吗？目前仅支持激活指标，会尽快支持其他指标。

? API互传方案监控是否100%准确？API互传仅保证能获取到设备信息的点击回调准确，不可避免会产生部分数据遗漏。