API接入文档.v3
<h3>概述</h3>
<p>本文档作为AI变现助手的技术接入文档，主要包含如下两个接口</p>
<ol>
<li>广告网络列表请求接口</li>
<li>广告上报接口</li>
</ol>
<h3>名词解释</h3>
<ol>
<li>媒体
泛指AI变现助手的接入方</li>
<li>广告网络
泛指客户对接的各个广告来源，包含各ADX平台，DSP平台等</li>
</ol>
<h3>广告网络列表请求</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>客户通过调用此接口，获取各个广告网络的优先级顺序</li>
</ul>
<p><strong>请求URL：</strong></p>
<ul>
<li><code>http://api.qdjubian.com/api/v3/ai/sort</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>POST</li>
<li>Content-type: application/json</li>
</ul>
<p><strong>参数：</strong></p>
<ul>
<li>请求</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">app_key</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>平台中配置应用后分配的app_key</td>
</tr>
<tr>
<td style="text-align: left;">source</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>来源，1,api，2，安卓sdk，3，ios SDK（ios必选）</td>
</tr>
<tr>
<td style="text-align: left;">ad_position</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">AdPosition</td>
<td>广告位信息</td>
</tr>
<tr>
<td style="text-align: left;">device</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">Device</td>
<td>设备信息</td>
</tr>
<tr>
<td style="text-align: left;">app</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">App</td>
<td>应用信息</td>
</tr>
</tbody>
</table>
<ul>
<li>AdPosition</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">ad_position_id</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>广告位唯一标识，全局唯一</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">int（详见imp_asset_type_enum）</td>
<td>曝光素材类型，例如：0（图片）、1（图文）等</td>
</tr>
<tr>
<td style="text-align: left;">ad_position_type</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">int</td>
<td>广告位类型，0，其他，1，开屏，2，插屏，3，banner，4，信息流，5，激励视频</td>
</tr>
<tr>
<td style="text-align: left;">ad_sources</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">array of AdSource</td>
<td>第三方广告位信息(adSource顺序为原序)</td>
</tr>
</tbody>
</table>
<ul>
<li>AdSource</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">ad_platform</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">int（详见 platform_enum）</td>
<td>广告网络标识，例如：0（广点通）、1（穿山甲）等</td>
</tr>
<tr>
<td style="text-align: left;">pid</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>广告网络上的广告位id（或称为代码位id，如穿山甲，百度），一条请求内不能重复</td>
</tr>
</tbody>
</table>
<ul>
<li>Device
imei,imei_md5,oaid,android_id,android_md5,idfa 必须传一个</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">imei</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>imei</td>
</tr>
<tr>
<td style="text-align: left;">imei_md5</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>imei的md5值</td>
</tr>
<tr>
<td style="text-align: left;">oaid</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>oaid</td>
</tr>
<tr>
<td style="text-align: left;">android_id</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>android_id</td>
</tr>
<tr>
<td style="text-align: left;">android_id_md5</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>android_id_md5</td>
</tr>
<tr>
<td style="text-align: left;">idfa</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>操作系统版本</td>
</tr>
<tr>
<td style="text-align: left;">os</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int (详见os_enum)</td>
<td>操作系统</td>
</tr>
<tr>
<td style="text-align: left;">osv</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>操作系统版本</td>
</tr>
<tr>
<td style="text-align: left;">ip</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>客户端ip</td>
</tr>
<tr>
<td style="text-align: left;">make</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备品牌</td>
</tr>
<tr>
<td style="text-align: left;">model</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备机型</td>
</tr>
<tr>
<td style="text-align: left;">mac</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备mac地址</td>
</tr>
<tr>
<td style="text-align: left;">ua</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>user-agent信息</td>
</tr>
<tr>
<td style="text-align: left;">network</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int（详见network_enum）</td>
<td>设备网络类型</td>
</tr>
<tr>
<td style="text-align: left;">carrier</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int（详见carrier_enum）</td>
<td>运营商</td>
</tr>
<tr>
<td style="text-align: left;">dpi</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备每英寸像素</td>
</tr>
<tr>
<td style="text-align: left;">h</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备屏幕高</td>
</tr>
<tr>
<td style="text-align: left;">w</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备屏幕宽</td>
</tr>
</tbody>
</table>
<ul>
<li>App</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">bundle</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>app包名</td>
</tr>
<tr>
<td style="text-align: left;">version</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>app版本</td>
</tr>
</tbody>
</table>
<ul>
<li>imp_asset_type_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">图片</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td style="text-align: left;">图文</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td style="text-align: left;">文字</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td style="text-align: left;">视频</td>
</tr>
<tr>
<td style="text-align: left;">4</td>
<td style="text-align: left;">未知</td>
</tr>
</tbody>
</table>
<ul>
<li>imp_type_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">其他</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td style="text-align: left;">开屏</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td style="text-align: left;">插屏</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td style="text-align: left;">banner</td>
</tr>
<tr>
<td style="text-align: left;">4</td>
<td style="text-align: left;">信息流</td>
</tr>
<tr>
<td style="text-align: left;">5</td>
<td style="text-align: left;">激励视频</td>
</tr>
</tbody>
</table>
<ul>
<li>network_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">未知</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td style="text-align: left;">以太网</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td style="text-align: left;">wifi</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td style="text-align: left;">蜂窝网络</td>
</tr>
<tr>
<td style="text-align: left;">4</td>
<td style="text-align: left;">2G</td>
</tr>
<tr>
<td style="text-align: left;">5</td>
<td style="text-align: left;">3G</td>
</tr>
<tr>
<td style="text-align: left;">6</td>
<td style="text-align: left;">4G</td>
</tr>
<tr>
<td style="text-align: left;">7</td>
<td style="text-align: left;">5G</td>
</tr>
</tbody>
</table>
<ul>
<li>device_type_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">1</td>
<td style="text-align: left;">imei</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td style="text-align: left;">imei_md5</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td style="text-align: left;">oaid</td>
</tr>
<tr>
<td style="text-align: left;">4</td>
<td style="text-align: left;">android_id</td>
</tr>
<tr>
<td style="text-align: left;">5</td>
<td style="text-align: left;">android_id_md5</td>
</tr>
<tr>
<td style="text-align: left;">6</td>
<td style="text-align: left;">idfa</td>
</tr>
</tbody>
</table>
<ul>
<li>platform_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">腾讯优量汇</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td style="text-align: left;">头条穿山甲</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td style="text-align: left;">百度联盟</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td style="text-align: left;">快手联盟</td>
</tr>
<tr>
<td style="text-align: left;">4</td>
<td style="text-align: left;">华为联盟</td>
</tr>
<tr>
<td style="text-align: left;">5</td>
<td style="text-align: left;">Inmobi</td>
</tr>
<tr>
<td style="text-align: left;">6</td>
<td style="text-align: left;">Admob</td>
</tr>
<tr>
<td style="text-align: left;">7</td>
<td style="text-align: left;">Facebook</td>
</tr>
<tr>
<td style="text-align: left;">8</td>
<td style="text-align: left;">AppLovin</td>
</tr>
<tr>
<td style="text-align: left;">9</td>
<td style="text-align: left;">Unity Ads</td>
</tr>
<tr>
<td style="text-align: left;">10</td>
<td style="text-align: left;">IronSource</td>
</tr>
<tr>
<td style="text-align: left;">11</td>
<td style="text-align: left;">Chartboost</td>
</tr>
<tr>
<td style="text-align: left;">12</td>
<td style="text-align: left;">Sigmob</td>
</tr>
</tbody>
</table>
<p><strong>返回参数说明</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td>状态码，成功为0，其余错误码见目录</td>
</tr>
<tr>
<td style="text-align: left;">request_id</td>
<td style="text-align: left;">string</td>
<td>唯一请求id</td>
</tr>
<tr>
<td style="text-align: left;">app_id</td>
<td style="text-align: left;">int</td>
<td>平台应用ID</td>
</tr>
<tr>
<td style="text-align: left;">ad_position_id</td>
<td style="text-align: left;">int</td>
<td>平台广告位ID</td>
</tr>
<tr>
<td style="text-align: left;">experiment_id</td>
<td style="text-align: left;">int</td>
<td>平台实验ID</td>
</tr>
<tr>
<td style="text-align: left;">crowdPackage_id</td>
<td style="text-align: left;">int</td>
<td>平台人群包ID</td>
</tr>
<tr>
<td style="text-align: left;">record_params</td>
<td style="text-align: left;">string</td>
<td>上报需要参数</td>
</tr>
<tr>
<td style="text-align: left;">ad_sources</td>
<td style="text-align: left;">array of RespAdSource</td>
<td>第三方广告源数据</td>
</tr>
</tbody>
</table>
<ul>
<li>RespAdSource</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">ad_source_id</td>
<td style="text-align: left;">int</td>
<td>平台配置广告源唯一标示</td>
</tr>
<tr>
<td style="text-align: left;">ad_platform</td>
<td style="text-align: left;">int（详见 platform_enum）</td>
<td>广告网络标识，例如：0（广点通）、1（穿山甲）等</td>
</tr>
<tr>
<td style="text-align: left;">pid</td>
<td style="text-align: left;">string</td>
<td>广告网络上的广告位id（或称为代码位id，如穿山甲，百度），一条请求内不能重复</td>
</tr>
<tr>
<td style="text-align: left;">extra_params</td>
<td style="text-align: left;">ExtraParams</td>
<td>平台第三方增值数据</td>
</tr>
</tbody>
</table>
<ul>
<li>ExtraParams</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">adActiveSign</td>
<td style="text-align: left;">string</td>
<td>广告活动签名</td>
</tr>
<tr>
<td style="text-align: left;">adDirection</td>
<td style="text-align: left;">string</td>
<td>广告方向</td>
</tr>
<tr>
<td style="text-align: left;">adLayout</td>
<td style="text-align: left;">string</td>
<td>广告布局</td>
</tr>
<tr>
<td style="text-align: left;">adSourceSize</td>
<td style="text-align: left;">string</td>
<td>广告源尺寸</td>
</tr>
<tr>
<td style="text-align: left;">adType</td>
<td style="text-align: left;">string</td>
<td>广告位类型</td>
</tr>
<tr>
<td style="text-align: left;">appSign</td>
<td style="text-align: left;">string</td>
<td>应用签名</td>
</tr>
<tr>
<td style="text-align: left;">autoPlay</td>
<td style="text-align: left;">string</td>
<td>自动播放视频</td>
</tr>
<tr>
<td style="text-align: left;">duration</td>
<td style="text-align: left;">string</td>
<td>可选时长(5-60秒)</td>
</tr>
<tr>
<td style="text-align: left;">fullScreen</td>
<td style="text-align: left;">string</td>
<td>是否全屏视频</td>
</tr>
<tr>
<td style="text-align: left;">height</td>
<td style="text-align: left;">string</td>
<td>高度</td>
</tr>
<tr>
<td style="text-align: left;">limitDirection</td>
<td style="text-align: left;">string</td>
<td>广告方向是否限制</td>
</tr>
<tr>
<td style="text-align: left;">materialSize</td>
<td style="text-align: left;">string</td>
<td>素材尺寸</td>
</tr>
<tr>
<td style="text-align: left;">nativeType</td>
<td style="text-align: left;">string</td>
<td>原生类型</td>
</tr>
<tr>
<td style="text-align: left;">openType</td>
<td style="text-align: left;">string</td>
<td>开屏方式</td>
</tr>
<tr>
<td style="text-align: left;">positionNumber</td>
<td style="text-align: left;">string</td>
<td>版位编号</td>
</tr>
<tr>
<td style="text-align: left;">proportion</td>
<td style="text-align: left;">string</td>
<td>代码位尺寸比例</td>
</tr>
<tr>
<td style="text-align: left;">screenDirection</td>
<td style="text-align: left;">string</td>
<td>屏幕方向</td>
</tr>
<tr>
<td style="text-align: left;">templateRendering</td>
<td style="text-align: left;">string</td>
<td>使用模板渲染</td>
</tr>
<tr>
<td style="text-align: left;">version</td>
<td style="text-align: left;">string</td>
<td>接入版本</td>
</tr>
<tr>
<td style="text-align: left;">videoDuration</td>
<td style="text-align: left;">string</td>
<td>视频最大时长 </td>
</tr>
<tr>
<td style="text-align: left;">videoMute</td>
<td style="text-align: left;">string</td>
<td>视频静音</td>
</tr>
</tbody>
</table>
<ul>
<li>carrier_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td>未知</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td>中国移动</td>
</tr>
<tr>
<td style="text-align: left;">2</td>
<td>中国联通</td>
</tr>
<tr>
<td style="text-align: left;">3</td>
<td>中国电信</td>
</tr>
</tbody>
</table>
<p><strong>请求示例</strong></p>
<pre><code class="language-json"> {
"source":"1",
"app_key":"15c56bc2ab7778289feaec0ec8aaab46",
"ad_position":{
"ad_position_id":"102400",
"type":2,
"ad_position_type":5,
"ad_sources":[
{
"ad_platform":0,
"pid":"7080192470473192"
},
{
"ad_platform":2,
"pid":"945588489"
}
],
"type":3
},
"app":{
"bundle":"FusionAiDemo",
"version":"1.0"
},
"device":{
"android_id":"13fe594d63e22b0e",
"carrier":0,
"dpi":1,
"h":2120,
"imei":"3fe4d94870230f2a",
"make":"Xiaomi",
"model":"Mi 10",
"network":0,
"oaid":"3fe4d94870230f2a",
"os":1,
"osv":"10",
"w":1080
}
}</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
"status": 0,
"request_id": "c651ecee-9629-4426-8b71-58984b4de7d3",
"app_id": 10566,
"ad_position_id": 102400,
"experiment_id": 209922,
"crowd_package_id": 30814,
"record_params": "{}",
"ad_sources": [
{
"ad_source_id": 1,
"ad_platform": 1,
"pid": "5117441",
"extra_params": {
"templateRendering": false
}
}
]
}
</code></pre>
<hr />
<h3>广告上报接口</h3>
<p><strong>简要描述：</strong></p>
<ul>
<li>客户通过此接口上报广告网络返回的广告内容和曝光、点击信息。</li>
</ul>
<p><strong>请求URL：</strong></p>
<ul>
<li><code>http://api.qdjubian.com/api/v3/ai/record</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>POST</li>
<li>Content-type: application/json</li>
</ul>
<p><strong> 请求参数：</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">request_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>唯一请求id</td>
</tr>
<tr>
<td style="text-align: left;">jubian_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>由AI变现助手分配的唯一id</td>
</tr>
<tr>
<td style="text-align: left;">app_key</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>平台中配置应用后分配的app_key</td>
</tr>
<tr>
<td style="text-align: left;">app_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>平台中配置应用后分配的应用id</td>
</tr>
<tr>
<td style="text-align: left;">ad_position_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>平台中配置应用后分配的广告位ID</td>
</tr>
<tr>
<td style="text-align: left;">experiment_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>数据所走实验的id</td>
</tr>
<tr>
<td style="text-align: left;">crowd_package_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>数据中的人群包Id</td>
</tr>
<tr>
<td style="text-align: left;">record_params</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>sort排序返回上报所需</td>
</tr>
<tr>
<td style="text-align: left;">source</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>来源，1,api，2，安卓sdk，3，ios SDK（ios必选）</td>
</tr>
<tr>
<td style="text-align: left;">ad_position</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">RecordAdPosition</td>
<td>广告位信息</td>
</tr>
<tr>
<td style="text-align: left;">device</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">RecordDevice</td>
<td>设备信息</td>
</tr>
<tr>
<td style="text-align: left;">app</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">RecordApp</td>
<td>应用信息</td>
</tr>
<tr>
<td style="text-align: left;">events</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">array of event</td>
<td>广告网络平台返回的广告信息，（无返回不需要上报）</td>
</tr>
</tbody>
</table>
<ul>
<li>event</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int（详见status_enum）</td>
<td>广告行为类型，例如：11（曝光）、12（点击）</td>
</tr>
<tr>
<td style="text-align: left;">ad_platform</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int（详见 platform_enum）</td>
<td>请求的广告网络平台，例如：0（广点通）、1（穿山甲）</td>
</tr>
<tr>
<td style="text-align: left;">pid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>广告网络上的广告位id（或称为代码位id，如穿山甲，百度）</td>
</tr>
<tr>
<td style="text-align: left;">ad_source_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>平台配置广告源ID</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">long</td>
<td>动作发生的毫秒时间戳</td>
</tr>
<tr>
<td style="text-align: left;">asset</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">asset</td>
<td>广告物料信息 ,如果没有返回广告，则不用上报</td>
</tr>
</tbody>
</table>
<ul>
<li>asset</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">title</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>广告标题，无则传空串</td>
</tr>
<tr>
<td style="text-align: left;">description</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>广告描述，无则传空串</td>
</tr>
<tr>
<td style="text-align: left;">img_url</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>图片url，多图时','分隔，无则传空串</td>
</tr>
<tr>
<td style="text-align: left;">video_url</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>视频播放url，无则传空串</td>
</tr>
<tr>
<td style="text-align: left;">landing_url</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>落地页</td>
</tr>
</tbody>
</table>
<ul>
<li>RecordAdPosition</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">ad_position_id</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>广告位唯一标识，全局唯一</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">int（详见imp_asset_type_enum）</td>
<td>曝光素材类型，例如：0（图片）、1（图文）等</td>
</tr>
<tr>
<td style="text-align: left;">ad_position_type</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">int</td>
<td>广告位类型，0，其他，1，开屏，2，插屏，3，banner，4，信息流，5，激励视频</td>
</tr>
<tr>
<td style="text-align: left;">ad_sources</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">array of AdSource</td>
<td>第三方广告位信息(adSource顺序为原序)</td>
</tr>
</tbody>
</table>
<ul>
<li>RecordDevice
imei,imei_md5,oaid,android_id,android_md5,idfa 必须传一个</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">imei</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>imei</td>
</tr>
<tr>
<td style="text-align: left;">imei_md5</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>imei的md5值</td>
</tr>
<tr>
<td style="text-align: left;">oaid</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>oaid</td>
</tr>
<tr>
<td style="text-align: left;">android_id</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>android_id</td>
</tr>
<tr>
<td style="text-align: left;">android_id_md5</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>android_id_md5</td>
</tr>
<tr>
<td style="text-align: left;">idfa</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>操作系统版本</td>
</tr>
<tr>
<td style="text-align: left;">os</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int (详见os_enum)</td>
<td>操作系统</td>
</tr>
<tr>
<td style="text-align: left;">osv</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>操作系统版本</td>
</tr>
<tr>
<td style="text-align: left;">ip</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>客户端ip</td>
</tr>
<tr>
<td style="text-align: left;">make</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备品牌</td>
</tr>
<tr>
<td style="text-align: left;">model</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备机型</td>
</tr>
<tr>
<td style="text-align: left;">mac</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>设备mac地址</td>
</tr>
<tr>
<td style="text-align: left;">ua</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">string</td>
<td>user-agent信息</td>
</tr>
<tr>
<td style="text-align: left;">network</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int（详见network_enum）</td>
<td>设备网络类型</td>
</tr>
<tr>
<td style="text-align: left;">carrier</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int（详见carrier_enum）</td>
<td>运营商</td>
</tr>
<tr>
<td style="text-align: left;">dpi</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备每英寸像素</td>
</tr>
<tr>
<td style="text-align: left;">h</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备屏幕高</td>
</tr>
<tr>
<td style="text-align: left;">w</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">int</td>
<td>设备屏幕宽</td>
</tr>
</tbody>
</table>
<ul>
<li>RecordApp</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: center;">必选</th>
<th style="text-align: center;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">bundle</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>app包名</td>
</tr>
<tr>
<td style="text-align: left;">version</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">string</td>
<td>app版本</td>
</tr>
</tbody>
</table>
<ul>
<li>status_enum</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">10</td>
<td style="text-align: left;">有广告请求</td>
</tr>
<tr>
<td style="text-align: left;">11</td>
<td style="text-align: left;">曝光</td>
</tr>
<tr>
<td style="text-align: left;">12</td>
<td style="text-align: left;">点击</td>
</tr>
<tr>
<td style="text-align: left;">13</td>
<td style="text-align: left;">有广告请求且返回</td>
</tr>
</tbody>
</table>
<p><strong>返回参数说明</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td>状态码，见附录</td>
</tr>
</tbody>
</table>
<p><strong>请求参数示例</strong></p>
<pre><code class="language-json">{
"request_id":"4a2bd086-7828-4743-997f-7f95bcecc0ce",
"jubian_id":4,
"app_key":"15c56bc2ab7778289feaec0ec8aaab46",
"app_id":10566,
"source":"2",
"ad_position_id":102399,
"experiment_id":209921,
"crowd_package_id":0,
"record_params":"{}",
"device":{
"oaid":"a9c796b578af17ea",
"network":0,
"os":1,
"osv":"10",
"ip":"39.100.121.148:8080",
"make":"Xiaomi",
"model":"Redmi K20 Pro",
"mac":"",
"ua":"",
"carrier":1,
"dpi":440,
"h":2210,
"w":1080
},
"app":{
"bundle":"FusionAiDemo",
"version":"1.0"
},
"ad_position":{
"ad_position_id":"102399",
"type":3,
"ad_position_type":0
},
"events":[
{
"status":12,
"ad_platform":3,
"pid":"90009001",
"ad_source_id":409,
"deal_price":0,
"timestamp":1610986774502,
"asset":{
"id":0,
"asset_id":0,
"title":"广告",
"img_url":"http://txmov2.a.yximgs.com/upic/2021/01/18/10/BMjAyMTAxMTgxMDI4MTNfMjAwOTMxODYwOF80MjU2MzQzNDg4NF8wXzM=_b_Be3c3f691c26bb110965b3cb4ae40f021.mp4?tag=1-1610983391-unknown-0-qmvr7dfbtg-ce0df3a8a0a7ed10&clientCacheKey=3xsn3zv86yjzdq2_b.mp4&tt=b&di=a3ccaf98&bp=13290",
"landing_url":"https://static.yximgs.com/s1/htmls/feed-joint-landing-page/feed-joint-landing-page-ee708d0628.html?callback=RGyGaz0vZwDfMc3KgI1dXi8L0loyhMZNucbyiCIITgvEib1j4O6MgHA6rpq_ppiQhzZ1aAyvl3RoepSI-2qBABNZQbJfsiCeTZiUipaNwjnUN0cl3GGLr8YHGhwAD-vere4Phb14w4FZUn-ynBGCQ2Bn9e5b4yY_puq2N0ippKKMApqziYgV_Yq12lO401Qe",
"description":"太值了!萌推福利天天有，大牌特惠，你还在等什么!"
}
}
]
}
</code></pre>
<h3>附录</h3>
<ul>
<li>错误码</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">值</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">成功</td>
</tr>
<tr>
<td style="text-align: left;">100001</td>
<td style="text-align: left;">param appKey not null</td>
</tr>
<tr>
<td style="text-align: left;">100002</td>
<td style="text-align: left;">param sortRequest not null</td>
</tr>
<tr>
<td style="text-align: left;">100003</td>
<td style="text-align: left;">param sortRequest.imp not null</td>
</tr>
<tr>
<td style="text-align: left;">100004</td>
<td style="text-align: left;">param sortRequest.imp.id not empty</td>
</tr>
<tr>
<td style="text-align: left;">100005</td>
<td style="text-align: left;">未设置对应的广告源</td>
</tr>
<tr>
<td style="text-align: left;">100006</td>
<td style="text-align: left;">广告位ID错误</td>
</tr>
<tr>
<td style="text-align: left;">100007</td>
<td style="text-align: left;">param appKey is error</td>
</tr>
<tr>
<td style="text-align: left;">100008</td>
<td style="text-align: left;">sort choose original no adList</td>
</tr>
<tr>
<td style="text-align: left;">400</td>
<td style="text-align: left;">请求不合法</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td style="text-align: left;">系统错误</td>
</tr>
</tbody>
</table>