使用条款
Mix-Mind系统公司(以下简称“Mix-Mind”)所有文档,接收者有保密义务。未经Mix-Mind书面许可,任何人或任何机构不得向第三方披露、泄露有关本文件的任何内容或细节。Mix-Mind拥有修改、调整、增补本文件的权利。Mix-Mind系统™和Mix-Mind Systems™及相关延展标识为Mix-Mind公司在中国和/或其他国家或地区的注册商标或商标。
概述:Mix-MindAdExchange与媒体视频贴片对接(即对应AdExchange Video广告位)有以下两种方式
1.给到媒体视频容器接口url
2.vast协议(媒体播放器支持Vast协议)
以下分别针对这两种对接方式做接口说明和返量实现说明
http://v.ad.xelements.cn/ax?l=123&v=1&r=1&u=_Location_&f=_Referer_
投放代码参数说明:
| 参数名 | 描述 | 必填 |
|---|---|---|
| l | 广告位id(Mix-Mind投放平台唯一合作标识符),由Mix-Mind平台在提供给媒体代码时提供。 | Y |
| v | 返回值类型,媒体可根据自己平台的需要选择返回类型。 目前支持两种返回类型: 1)v=0或为空表示是Json格式的返回类型; 2)v=1表示是Vast3.0格式的返回类型(vast类型的返回用于视频贴片的投放,由媒体视频播放器解析vast播放视频) |
Y(v=1) |
| r | http协议版本(该版本r=1) | Y(r=1) |
| u | 广告播放所在页面url,需要urlencode。(具体由媒体替换宏参数_Location_的值) | Y |
| f | 广告播放来源页面url,需要urlencode。(具体由媒体替换宏参数_Referer_的值) | 可选 |
| ct | 视频播放页所属的一级频道ID 频道ID列表 | 可选 |
| cs | 视频播放页所属的二级频道ID 频道ID列表 | 可选 |
| are | 视频播放页所属的地域频道ID 频道ID列表 | 可选 |
| ti | 视频播放页的视频标题-节目名称,需要urlencode | 可选 示例:"A New Hope" |
| da | 视频播放页所属剧目,需要urlencode | 可选 示例:"花千骨" |
| openid | 微信用户ID | 可选,特殊使用,其它媒体请忽略该字段 |
| ct_name | 频道名称 | 可选,特殊使用,其它媒体请忽略该字段。需要urlencode |
| sex | 性别 | 可选,特殊使用,其它媒体请忽略该字段。需要urlencode |
| city | 所在城市 | 可选,特殊使用,其它媒体请忽略该字段。需要urlencode |
| oaid | 安卓设备的OAID 明文 | 可选 示例:47befdff-fb1f-4b96-ddff-bf3fb77f744e |
| oaidmd5 | 安卓设备的OAID MD5 | 可选 示例:e10adc3949ba59abbe56e057f20f883e |
当请求的参数v=1时,AdExchange系统返回的是VAST格式的数据。 数据格式遵循VAST v3.0版本。AdExchange返回的是VAST的一个子集,返回的全部字段都包含在下面的示例中
注: 关于VAST格式的详细说明,参看http://www.iab.net/vast
正常的广告返回示例如下:
<?xml version="1.0" encoding="UTF-8"?>
<VAST version="3.0">
<Ad>
<InLine>
<AdSystem>Mix-Mind AdExchange</AdSystem>
<AdTitle>title</AdTitle>
<Impression>https://securecdn1.xelements.cn/admanager/resources/images/blank.gif?t=1</Impression>
<Impression>https://securecdn2.xelements.cn/admanager/resources/images/blank.gif?t=2</Impression>
<Creatives>
<Creative>
<Linear>
<!-- 广告时长 -->
<Duration>00:00:30</Duration>
<MediaFiles>
<!-- 物料信息,MIME type,宽,高 -->
<MediaFile delivery="progressive" type="video/x-flv" width="200" height="400">
<!-- 物料地址 -->
<![CDATA[
http://i.stfile.com/aaaa.flv
]]>
</MediaFile>
</MediaFiles>
<TrackingEvents>
<!-- 曝光监测URL -->
<!—注意:具体何时发送曝光监测请求需要Mix-Mind、媒体、广告主三方协商确定,此处 start 表示在广告播放开始的时候发送监测请求 -->
<Tracking event="start">
<!-- 监测地址将包装到CDATA里面 需要支持多个曝光Tracking发送 -->
<![CDATA[
http://g.x.cn.xelements.cn/x.gif?....
]]>
</Tracking>
<Tracking event="midpoint">
<!-- 第三方曝光监测 -->
<![CDATA[
http://g.cn.xelements.cn/x.gif?....
]]>
</Tracking>
<Tracking event="complete">
<!-- dsp曝光监测 -->
<![CDATA[
http://dsp.xxx.com/x.gif?....
]]>
</Tracking>
</TrackingEvents>
<!-- 点击事件 -->
<VideoClicks>
<!-- ClickThrough 设置,跳转到Landing Page设置 -->
<ClickThrough>
<!-- 监测+跳转地址将包装到CDATA里面 -->
<![CDATA[
http://e.cn.xelements.cn/r.gif?....
]]>
</ClickThrough>
<!-- ClickTracking 设置,发送Mix-Mind、广告主、媒体第三方点击监测请求 需要支持多个点击监测ClickTracking发送 -->
<ClickTracking>
<!-- 点击监测地址将包装到CDATA里面 dsp监测地址 -->
<![CDATA[
http://www.dsp.com/r.gif?...
]]>
</ClickTracking>
<ClickTracking>
<!-- 点击监测地址将包装到CDATA里面 第三方监测地址-->
<![CDATA[
http://www.disanfang.com/r.gif?...
]]>
</ClickTracking>
</VideoClicks>
</Linear>
</Creative>
</Creatives>
</InLine>
</Ad>
</VAST>
vast协议Mix-Mind返回的广告内容包括ClickTracking的内容,用来发dsp或第三方的点击监测,所以媒体在开发vast协议的时候需要处理ClickTracking的内容,发送点击监测的请求。
当没有合适的物料返回时,AdResponse内容为(即vast协议返量的返回内容):
<VAST version="3.0"></VAST>
为了方便媒体Server监测AdExchange的服务器状况,AdExchange提供一个心跳接口,URL为格式为http://[AdExchange-HOST]:[PORT]/heartbeat,响应status为200,支持Keep-Alive,内容为空。
说明: 使用易传媒系统的媒体视频贴片flash容器对接请参见文档使用易传媒系统的媒体接入AdExchange说明
说明: 如果媒体采用视频容器进行对接,Mix-Mind会给到媒体一个swf的url地址,只要媒体的视频播放器和Mix-Mind容器接口能够适用就可以按这种方式投放。
Mix-Mind建议媒体用VAST协议的方式来对接视频贴片,投放出问题或数据gap的概率小。
Mix-Mindswf的url地址示例:
http://js.ad.xelements.cn/XtadPlayer_adchina_build20140403.swf?isNew=1&surl=http%3A%2F%2Fs.ad.xelements.cn%2Fax%3Fl%3D3148%26v%3D0%26r%3D1
Mix-MindAdExchange平台在返回空广告时(即返回json没有物料数据),Mix-Mindflash视频播放器会播放出错,同时发出一个播放出错的事件,媒体播放器监听这个事件实现返量。