使用条款

Mix-Mind系统公司(以下简称“Mix-Mind”)所有文档,接收者有保密义务。未经Mix-Mind书面许可,任何人或任何机构不得向第三方披露、泄露有关本文件的任何内容或细节。Mix-Mind拥有修改、调整、增补本文件的权利。Mix-Mind系统™和Mix-Mind Systems™及相关延展标识为Mix-Mind公司在中国和/或其他国家或地区的注册商标或商标。

目录

AdExchange对DSP接口文档

版本历史

版本/状态 完成日期 备注
2.7 2017-06-14 1.增加sourceid字段,用来标识视频流量的来源 2.增加Mix-Mind视频流量频道字典表。
2.8 2017-09-04 1.新物料信息上传-普通物料上传 增加name字段,用来标识物料的名称 2.新物料信息上传-普通媒体上传增加vendorId字段,用来标识物料所投放的渠道媒体。
2.9 2017-09-12 1.新物料信息上传-普通物料上传 增加cm字段,用来填写第三方点击监测地址
3.0 2017-09-18 新增曝光、点击监测宏定义和Bidresponse返回示例
3.1 2017-11-02 广告位展示类型增加两类:“TV端video”、“TV端视频暂停”
3.2 2017-11-15 增加 response.bid.ext.event字段,描述 监测事件或监测触发时间点
3.3 2017-11-29 新物料信息上传-普通物料上传,增加monitorPosition参数
3.4 2017-12-07 Deal 信息获取API-Deal信息增加group字段,用于表示PDB/PD活动下单的文本信息,可以使用group统一管理下单的deal
3.5 2018-01-03 特殊媒体增加芒果媒体的处理方式
3.6 2018-03-14 Deal 信息获取API-Deal信息增加sourceid、saleType字段
3.7 2018-03-30 物料上传接口-信息流物料上传增加source字段,用于表示广告主品牌名称;信息流视频增加coverurl字段,用于表示视频广告的封面素材图片;增加download_url字段,用于表示应用下载类广告下载url;竞价接口-增加cid,用于表示投放活动id,视频信息流增加event字段,用于描述 监测事件或监测触发时间点
3.7 2018-05-14 修改特殊媒体2的流量关于点击监测的处理
3.8 2019-08-08 新物料上传接口,natived对象增加mblog_text字段
3.9 2020-05-20 device增加oaidmd5字段
3.9.1 2020-08-24 更新vendorId、sub_sourceid媒体ID说明
12.9 2020-09-23 支持微信小程序;普通物料上传API增加扩展字段
12.9.2 2020-10-15 优酷媒体PDB形式宏模式响应
12.9.3 2022-04-21 更新monitor字段说明:腾讯媒体PDB形式默认指定第1条曝光监测作为结算监测
12.9.4 2022-05-05 更新腾讯媒体宏模式响应规则,详见“宏使用说明”腾讯媒体相关
12.9.5 2022-07-20 新增广协IOS系统上统一设备标识caid

总述

为了方便DSP接入Mix-Mind,Mix-Mind提供了两组API供DSP使用。信息同步API用于DSP和Mix-Mind之间互相同步将会用于竞价过程的各种信息;实时竞价API是Mix-Mind用来向DSP发送实时竞价请求,并获取竞价结果的接口。 为了能够使用这两组接口,DSP需要获取Mix-Mind提供的dspid和相应的token信息。

API参数编码

所有参数采用UTF-8编码

信息同步接口

以下的各个API,请求参数为JSON格式,均通过HTTP POST发送,必须将Content-type设置为:application/json。参数分为两种:系统参数和业务参数,系统参数每个API请求都必须携带;业务参数将分别说明。

系统参数

参数名称 类型 是否必须
dspid string
token string

注:业务参数将在下面的每个接口分别进行说明,系统参数和业务参数组成的对象对应的JSON,作为请求的参数。

API以JSON格式返回,返回信息是由如下的参数组成的对象对应的JSON数据:

参数名称 是否必须 含义
result 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message 如果API执行成功,返回结果数据或成功提示信息;如果执行失败,返回具体的错误提示信息

广告位信息获取API

说明:DSP通过该接口获得Exchange拥有的库存信息,包括广告位总量,每个广告位的ID、名称、尺寸、底价、广告主行业黑名单以及支持的物料格式(暂时支持gif、jpg、png、swf、flv、x和c七种物料格式)

API地址:POST http://{exchange.domain}/dsp/api/adplacements

业务参数:

参数名称 类型 含义
pageIndex int 页码,必填,从1开始
pageSize int 查询记录条数,必填,最大1000

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 若result为0,message类型为object,为审核通过的广告位列表;若result不为0,则message类型为string,为具体的错误提示信息

请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/adplacements'
\\ JSON:
{
  "dspid": "11268",
  "token": "92205dff8f9d48e1b7a26b0b88af7dc1",
  "pageIndex": 2, // 页码,必填,从1开始
  "pageSize": 10 // 查询记录条数,必填,最大1000
}

正常返回示例:

{
    "result":0,
    "message":
    { 
        "total" :100, //总数
        "count" :2, //返回记录条数
        "records" : [
        { 
            "adplacementid": "101", 
            "adplacementname": "汽车-首页-banner" , 
            "size": "300*250" , 
            "blockcategory": [] , //广告主行业黑名单
            "allowmaterial": ["jpg", "gif", "swf", "png"] 
        }, 
        { 
            "adplacementid": "102", 
            "adplacementname": "新闻-视频", 
            "size": "400*300", 
            "blockcategory": ["010", "020"], 
            "allowmaterial": ["flv"] 
        }
        ]
    }   
}

新物料信息上传API-v2

说明: Mix-Mind需要对DSP将要投放的物料进行审核,如果审核不通过,将不会允许在Mix-Mind上进行交易。DSP通过该接口向Mix-Mind提交需要审核的物料信息,物料的类型包括:1.普通物料 2.普通信息流 3.微博博文信息流 4.微博品牌信息流 5.搜狐素材。

因为业务升级,物料上传接口增加了其他类型创意的上传,之后Mix-Mind平台将维护新接口提供给DSP对应服务,dsp升级物料上传接口,可以在Mix-Mind平台上投放更多类型的资源。为了保证已经接入的DSP购买资源不受影响,旧接口暂时保留,但业务功能上不再更新。

API地址:POST http://{exchange.domain}/dsp/v2/api/upload

业务参数:

字段名称 类型 是否必填 描述
creativeType string 必填,示例:“creativeType”:“1” 创意类型,取值包括:1.普通物料banner或video 2.普通信息流 3.普通博文 4.微博品牌大Card 5.搜狐素材。
material array of objects 当”creativeType”=“1”时必填 banner或video创意类型对象数组
natived array of objects 当”creativeType”=“2”时必填 普通信息流创意类型对象数组
wax_feed array of objects 当”creativeType”=“3”时必填 普通博文创意类型对象数组
wax_feed_activity array of objects 当”creativeType”=“4”时必填 微博品牌大Card创意类型对象数组
sohu array of objects 当”creativeType”=“5”时必填 搜狐媒体创意类型对象数组

material banner或video创意类型对象:

字段名称 类型 是否必填 描述
creativeId string 必填 DSP平台的创意ID,和BidResponse.crid一致
name string 必填 DSP平台的创意名称
vendorId integer 非必填 媒体ID标识详见媒体ID说明
category array of string 非必填 Mix-Mind平台行业ID,对外暂不使用
url string 必填 素材URL地址
width integer 非必填 素材宽度
height integer 非必填 素材高度
duration integer 非必填 素材时长,图片类素材制定素材时长为零
landingpage string 必填 广告落地页(广告点击后跳转的地址);Mix-Mind平台一部分媒体使用物料绑定的landingpage,一部分媒体使用竞价实时响应的ldp,具体参见投放说明
deeplinkUrl string 非必填 应用直达URL,当返回了deeplinkurl,优先唤醒本地app,如果无法唤醒,则调用ldp(打开或者下载)
搜狐、腾讯、美团、微博这些媒体投放统一使用物料上传时指定的deeplinkurl,其他媒体投放使用RTB接口实时返回的deeplinkurl
advertiser string 必填 DSP平台广告主名称,需要和资质文件中的广告主名称一致
startdate string 必填 物料生效时间,格式要求:YYYY-mm-dd,必须在有效期内的物料才能在Mix-Mind平台投放
enddate string 必填 物料失效时间,格式要求:YYYY-mm-dd,必须在有效期内的物料才能在Mix-Mind平台投放
monitor array of string 必填 用于填写第三方曝光监测地址。腾讯媒体PDB形式默认指定第1条曝光监测作为结算监测。Mix-Mind平台一部分媒体使用物料绑定的曝光监测,一部分媒体使用竞价实时响应的曝光监测,具体参见投放说明
monitorPosition array of string 非必填 仅针对投放腾讯的视频素材,在上传了monitor的情况下配合使用,监测视频播放完成度;不需要监测视频播放完成度时,可以无此参数。monitor与monitorPosition 一一对应,monitorPosition =0时,为首帧监测,monitorPosition =1时,为第2秒监测,以此类推
cm array of string 必填 用于填写第三方点击监测地址。Mix-Mind平台一部分媒体使用物料绑定的点击监测,一部分媒体使用竞价实时响应的点击监测,参见投放说明
type string 当”type”=“x”时必填,其他情况非必填 物料类型,取值:“jpg”,“png”,“gif”,“swf”,“flv”,“mp4”,“x”。“jpg”,“png”,“gif”,“swf”,“flv”,“mp4”这些物料类型,Mix-Mind平台会根据物料url后缀判断出物料类型。“type”=“x”自带跳转地址的flash物料,对于”type”=“x”的物料,Mix-Mind平台会忽略RTB接口实时返回的ldp落地页
action string 必填,示例”action”=“1” 广告交互类型,1-打开网页 2-下载 3-deeplink 4-微信小程序 5-点击不跳转
miniProgramId string “action”=“4”时必填 小程序ID,示例:gh_aef698030129,备注:目前支持微信小程序媒体:爱奇艺、爱奇艺群邑、芒果、芒果群邑
miniProgramUrl string “action”=“4”时必填 小程序路径,示例:pages/index/index
extendInfo string 非必填 搜狐、米赋互动开屏创意传zipurl,优酷暂停视频创意传mp4 url
port array of Integer 非必填 端口:1-PC,2-Phone,3-Pad,4-OTT;不填默认为所有端口
appPkg string 非必填 应用包名

natived 普通信息流创意类型对象:

字段名称 类型 是否必填 描述
creativeId string 必填 DSP平台的创意ID,和BidResponse.crid一致
name string 必填 DSP平台的创意名称
vendorId integer 非必填 素材所投放的渠道媒体ID,渠道媒体为 0-Mix-Mind、2-手百、3-搜狐、41-搜狐群邑、4-优土、5-乐视、6-爱奇艺、40-爱奇艺群邑、7-腾讯PMP、8-小米、9- 暴风移动端、11-暴风网页端、12-风行、15-微博、16-芒果ADX、50-芒果TV-群邑、24-腾讯RTB、34-Oppo、36-头条、38-暴风OTT、39-MadHouse、48-米赋、49-美图、51-网易、52-Vivo、53 -UC浏览器、54-乐播。 投放非具体的媒体渠道,vendorId指定为0,默认为0。
category array of string 非必填 Mix-Mind平台行业ID,对外暂不使用
nativepic array of object 非必填 图片素材对象,对象元素:{“type”:““,”width”:““,”height”:““,”url”:““}。 type取值:1-icon 2-logo 3-main(image)
nativevideo array of object 非必填 贴片视频素材对象,对象元素:{“width”:““,”height”:““,”duration”:““,url”:““,”coverurl”:““,”logourl”:““} 上传信息流视频素材时,coverurl必填
landingpage string 必填 广告落地页(广告点击后跳转的地址);Mix-Mind平台一部分媒体使用物料绑定的landingpage,一部分媒体使用竞价实时响应的ldp,具体参见投放说明。当app_type=0 Android应用下载:landingpage为apk下载地址 当app_type=1 ios应用下载:landingpage为app store url
deeplinkUrl string 非必填 应用直达URL,当返回了deeplinkurl,优先唤醒本地app,如果无法唤醒,则调用ldp(打开或者下载)
搜狐、腾讯、美团、微博这些媒体投放统一使用物料上传时指定的deeplinkurl,其他媒体投放使用RTB接口实时返回的deeplinkurl
advertiser string 必填 DSP平台广告主名称,需要和资质文件中的广告主名称一致
startdate string 必填 物料生效时间,格式要求:YYYY-mm-dd,必须在有效期内的物料才能在Mix-Mind平台投放
enddate string 必填 物料失效时间,格式要求:YYYY-mm-dd,必须在有效期内的物料才能在Mix-Mind平台投放
monitor array of string 非必填 用于填写第三方曝光监测地址。Mix-Mind平台一部分媒体使用物料绑定的曝光监测,一部分媒体使用竞价实时响应的曝光监测,具体参见投放说明
monitorPosition array of string 非必填 仅针对投放腾讯的视频素材,在上传了monitor的情况下配合使用,监测视频播放完成度;不需要监测视频播放完成度时,可以无此参数 。monitor与monitorPosition 一一对应,monitorPosition =0时,为首帧监测,monitorPosition =1时,为第2秒监测,以此类推
cm array of string 必填 用于填写第三方点击监测地址。Mix-Mind平台一部分媒体使用物料绑定的点击监测,一部分媒体使用竞价实时响应的点击监测,参见[投放说明](#普通媒体和
特殊媒体投放说明)
title string 非必填 信息流广告标题
description string 非必填 信息流广告描述
source string 必填 广告主品牌名称
action string 必填,示例”action”=“1” 广告交互类型,1-打开网页 2-下载 3-deeplink 4-微信小程序 5-点击不跳转
download_info object 当”action”=2时必填 下载的应用信息对象
mblog_text string 非必填 微博正文, 若无链接, 不多于 140字, 若有链接正文 处直接 添加链接(占 10 个 字) ,其余 不多于 130 个
miniProgramId string “action”=“4”时必填 小程序ID,示例:gh_aef698030129,备注:目前支持微信小程序媒体:爱奇艺、爱奇艺群邑、芒果、芒果群邑
miniProgramUrl string “action”=“4”时必填 小程序路径,示例:pages/index/index
port array of Integer 非必填 端口:1-PC,2-Phone,3-Pad,4-OTT;不填默认为所有端口
appPkg string 非必填 应用包名

natived.download_info 下载应用信息对象:

字段名称 类型 是否必填 描述
app_type integer 必填 应用类型: 0为 Android,1为 ios
packagename string 必填 应用包名称
appname string 必填 应用名称
app_intro_url string 当”app_type”=0时必填 Android应用介绍页面
app_size string 必填 应用大小
app_ver string 必填 应用版本
itunesId string 当”app_type”=1时必填 iOS应用 App Store ID
app_id string 当”app_type”=0时必填 Android应用在应用商店上架的appid
download_url string 必填 应用下载链接

请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/v2/api/upload'
\\ JSON:
{
  "dspid": "11268",
  "token": "92205dff8f9d48e1b7a26b0b88af7dc1",
  "creativeType": "1",
  "material": [
    {
      "creativeId": "material_1",
      "name":"测试物料",
      "vendorId":0,
      "category": [],
      "url": "http://d.yoyi.tv/plus/2016/05/30/4f4e1c62206f394e9d8ea4825360096e.swf",
      "width": 400,
      "height": 300,
      "duration": 10,
      "advertiser": "Mix-Mind",
      "startdate": "2015-05-07",
      "enddate": "2018-08-30",
      "landingpage": "http://tv.sohu.com/20150505/n412440832.shtml",
      "action": 1,
      "monitor": [
        "http://g.cn.miaozhen.com/x/k=2006958&p=6wxzh&dx=0&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&nd=__DRA__&np=__POS__&nn=__APP__&o="
      ],
      "cm": [
        "http://e.cn.miaozhen.com/r/k=2012716&p=6wn6u&dx=0&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&nd=__DRA__&np=__POS__&nn=__APP__&o="
      ]
    }
  ]
}
\\ POST 'http://sandbox.adx.xelements.cn/dsp/v2/api/upload'
\\ JSON:
{
  "dspid": "11268",
  "token": "92205dff8f9d48e1b7a26b0b88af7dc1",
  "creativeType": "1",
  "material": [
    {
      "creativeId": "material_1",
      "name":"测试物料",
      "vendorId":7,// 或者是24
      "category": [],
      "url": "http://pludev.xelements.cn/8/d6/8d63c85b577724d237afd90d3712c0a5.mp4",
      "width": 640,
      "height": 480,
      "duration": 13,
      "advertiser": "Mix-Mind",
      "startdate": "2015-05-07",
      "enddate": "2018-08-30",
      "landingpage": "http://wwww.baidu.com",
      "action": 1,
      "monitor": [
        "http://g.cn.miaozhen.com/x/k=2006958&p=6wxzh&dx=0&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&nd=__DRA__&np=__POS__&nn=__APP__&o=",
        "http://g.cn.miaozhen.com/x/k=2006958&p=6wxzh&dx=0&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&nd=__DRA__&np=__POS__&nn=__APP__&o="
      ],
      "monitorPosition": [
        "0", // monitor_position=0时,为首帧监测
        "1" // monitor_position=1时,为第2秒监测
      ],
      "cm": [
        "http://e.cn.miaozhen.com/r/k=2012716&p=6wn6u&dx=0&rt=2&ns=__IP__&ni=__IESID__&v=__LOC__&nd=__DRA__&np=__POS__&nn=__APP__&o="
      ]
    }
  ]
}
\\ POST 'http://sandbox.adx.xelements.cn/dsp/v2/api/upload'
\\ JSON:
{
  "dspid": "11268",
  "token": "92205dff8f9d48e1b7a26b0b88af7dc1",
  "creativeType": "2",
  "natived": [
    {
      "creativeId": "native_1",
      "category": [],
      "nativepic": [
        {
          "width": 300,
          "height": 50,
          "url": "http://v.behe.com/2016/05/05/132425d6065ccff0f30274d03b7d496a.jpg",
          "type": 1
        }
      ],
      "landingpage": "http://www.baidu.com",
      "advertiser": "Mix-Mind",
      "source":"",
      "startdate": "2015-05-07",
      "enddate": "2018-08-30",
      "monitor": [],
      "title": "",
      "description": "",
      "action": 1,
      "download_info": {
        "app_type": 0,
        "packagename": "",
        "appname": "",
        "app_intro_url": "",
        "app_size": "",
        "app_ver": "",
        "itunesId": "",
        "download_url":""
      }
    }
  ]
}

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object result=0表示本次接口可以调用,如果物料成功上传,message为{},接口返回信息为:{“result”:0,“message”:{}};如果物料上传失败,message对象会返回具体的错误code码,接口返回信息为:{“result”:0,“message”:{“104”:[“http://d.xxxx/2016/04/15/144103f8f43867dace51918d62a8b194.flv”]}}

示例如下:

{
  "result":0,
  "message":
  {
    "405":["creativeId"]
  }
}

物料上传时会反馈的错误类型:

error_code 错误注释   处理说明 
101 文件加载失败 文件加载经常是因为根据物料url地址获取信息时超时,在确保url正常的情况下可以重新再试一下
102 不支持的文件格式,目前支持的文件格式:jpg,gif,png,swf,flv,x
103 根据素材url获取不到尺寸信息 
104 执行插入过程中发生了错误 该错误经常是因为将物料保存到本地是超时,在确保url正常的情况下可以重新再试一下
105 物料所属的广告主为空
106 物料生效时间为空或者不能解析 注:时间格式为YYYY-mm-dd
107 物料失效时间为空或者不能解析 注:时间格式为YYYY-mm-dd
108 系统异常  估计哪抛异常了
109 物料尺寸不符合广告位要求 上传到exchange状态会直接是未通过
201 缺少必填的参数/crative类型不匹配
202 参数格式错误
203 JSON数据格式错误
401 creativeId为空
402 物料生效时间为空或格式错误无法解析
403 物料失效时间为空或格式错误无法解析
404 文件无法识别,目前支持的文件格式(jpg,gif,png,swf,flv,mp4,x)
405 不支持的素材尺寸
406 素材文件加载失败
407 素材保存失败(素材保存到server本地失败)
408 广告主保存失败
409 创意保存失败
410 button_type 类型错误
411 mblog_text 字符数错误
412 title 字符数错误
413 desc 字符数错误
414 download app应用错误
415 PDB campaignId必填
416 解析资源获取不到duration/width/height,或者上传参数中的duration/width/height验证未通过 素材不符合Exchange平台要求
417 数据库操作异常
418 微博mid为空时,uid、mblog_text、pics必须存在
419 title长度约束问题
420 desc长度约束问题
421 download_info内部参数约束问题
422 某些属性验证不通过
423 某些约束验证不通过
424 dspid, token, creativeType三个属性当中出现问题
425 开始日期没有早于结束日期
426 obj_id和uid, mblog_text, pics之间的约束关系有问题
427 campaignId和deliveryType之间的约束关系有问题
428 至少出现数组[nativepic,nativevideo,title,desc]中的一个元素,且出现的元素值需要被校验通过
429 monitor与monitorPosition数量不一致
430 monitorPosition监测点大于视频时长
431 monitorPosition不能用于非视频物料
433 上传deeplink素材时,落地页和应用唤起地址不能为空!
434 广告交互类型为:4-微信小程序时,微信小程序ID和小程序页面路径均不能为空!

注:对已上传过的物料,dspid和creativeId相同的情况下,会更新原有物料,并且需要重新审核。

新物料审核结果获取APIs-v2

说明:物料上传到Mix-Mind以后,无vendorId 的物料,返回Mix-Mind的审核状态,状态为”待审核”、“通过”、“拒绝”,有 vendorId 的物料,返回渠道媒体的审核状态,状态为”待审核”、“通过”、“拒绝”。

新获取指定物料的审核结果-v2

说明:

DSP通过该API获取Mix-Mind对请求中指定的物料审核的结果

API地址:

POST http://{exchange.domain}/dsp/v2/api/status

业务参数:

字段名称 类型 描述
creativeIds array of string 需要查询的创意ID列表

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 若result为0,message类型为object,为查询的物料的审核结果;如果查询的某个物料url不存在,则在返回信息中不会有该url相关的信息;若result不为0,则message类型为string,为具体的错误信息

请求示例:


\\ POST 'http://sandbox.adx.xelements.cn/dsp/v2/api/status'
\\ JSON:
{
  "dspid":"11268",
  "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
  "creativeIds":["creative_1","creative_2","creative_3"]
}

正常返回示例:

{
  "result": 0,
  "message": {
    "total": 3,
    "records": [
      {
        "creativeId": "creative_1",
        "result": "不通过",
        "reason": "素材黑屏"
      },
      {
        "creativeId": "creative_2",
        "result": "通过",
        "reason": ""
      },
      {
        "creativeId": "",
        "result": "待审核",
        "reason": ""
      }
    ]
  }
}

旧物料信息上传API

说明:

Mix-Mind需要对DSP将要投放的物料进行审核,如果审核不通过,将不会允许在Mix-Mind上进行交易。DSP通过该接口向Mix-Mind提交需要审核的物料信息,包括物料URL,LandingPage URL,广告主名称(中文)、监测代码。

API地址:POST http://{exchange.domain}/dsp/api/upload

业务参数:

字段名称 类型 描述
material array of objects 本次同步需要新增或者修改的物料信息,是JSON格式的数据

关于物料上传的两点说明:

请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/upload'
\\ JSON:
{
  "dspid":"11268",
  "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
  "material":
  [{ 
    "url": "http://material.client.com/123.swf", // 物料素材的地址
    "landingpage": "http://www.some.com", // 必填 广告落地页,广告点击后跳转的最终地址。landingpage本身可以包含302条转或第三方监测。物料绑定的landingpage在实时投放时是否会使用,参见[投放说明](#普通媒体和特殊媒体投放说明) 
    "advertiser": "广告主的中文名称",    //必须填写 
    "startdate":"2012-07-16",    //物料生效时间,格式要求:YYYY-mm-dd,必须填写
    "enddate":"2012-08-30",     //物料失效时间,格式要求:YYYY-mm-dd,必须填写
    "monitor": [], // 用于填写第三方曝光监测地址。物料绑定的第三方曝光监测地址在实时投放时是否会使用,参见[投放说明](#普通媒体和特殊媒体投放说明)
    "type":"x" // 物料类型:非必填,如果需要指定上传的flash物料是多跳转地址型的flash物料,可以加上"type":"x",其他情况时都可以不用指定,服务器会自动检测物料类型。
  },  
  { 
    "url": "http://material.client.com/123.swf", 
    "landingpage": "http://www.some.com", 
    "advertiser": "广告主的中文名称", 
    "startdate":"2012-7-16",
    "enddate":"2012-8-30",
    "monitor": ["http://xelements.cn/1", "http://xelements.cn/2"]
  }]
}

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或string 如果result为0,message为object,返回上传失败的物料的信息;如果result不为0,message为string,返回具体的错误提示信息

注:

示例如下:

{
  "result":0,
  "message":
  {
    "102":["http://material.client.com/123.abc"],
    "103":["http://material.client.com/134.txt"]
  }
}

物料上传时会反馈的错误类型:

error_code 错误注释   处理说明 
101 文件加载失败 文件加载经常是因为根据物料url地址获取信息时超时,在确保url正常的情况下可以重新再试一下
102 不支持的文件格式,目前支持的文件格式:jpg,gif,png,swf,flv,x
103 根据素材url获取不到尺寸信息 
104 执行插入过程中发生了错误 该错误经常是因为将物料保存到本地是超时,在确保url正常的情况下可以重新再试一下
105 物料所属的广告主为空
106 物料生效时间为空或者不能解析 注:时间格式为YYYY-mm-dd
107 物料失效时间为空或者不能解析 注:时间格式为YYYY-mm-dd
108 系统异常  估计哪抛异常了
109 物料尺寸不符合广告位要求 上传到exchange状态会直接是未通过

旧物料审核结果获取APIs

说明:物料上传到Mix-Mind以后,有三种状态:待审核,通过,不通过。因为审核不通过的物料,将不会允许在Mix-Mind上进行交易,所以DSP最好通过该接口确保正在投放的物料的审核状态为通过

旧获取指定时间之后上传物料的审核结果

说明:

DSP可以通过该接口查询在某个时间点之后上传的物料的审核状态,该接口只返回审核不通过的物料;在距离当前时间48小时之内上传的物料,默认为待审核状态;则在查询时间点之后上传的其他物料状态是审核通过。

API地址:POST http://{exchange.domain}/dsp/api/reject

业务参数:

字段名称 类型 描述
uploaddate string 上传的时间:将返回该时间之后上传的所有未审核通过的物料列表 可以为空,为空时返回所有的未审核通过的物料列表 格式要求:YYYY-mm-dd

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 若result为0,message类型为object,为未审核通过的素材列表;若result不为0,则message类型为string,为具体的错误信息

请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/reject'
\\ JSON:
{
  "dspid":"11268",
  "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
  "uploaddate":"2013-12-24"
}

正常返回示例:

{ 
  "result":0,
  "message":
  {
    "total" :2,
    "records" : [
    { 
      "url": "http://material.client.com/123.swf", 
      "reason": "显示异常" 
    }, 
    { 
      "url": "http://material.client.com/134.swf", 
      "reason": "跳转地址异常"
    }
    ]
  }
}

旧获取指定物料的审核结果

说明:

DSP通过该API获取Mix-Mind对请求中指定的物料审核的结果

API地址:

POST http://{exchange.domain}/dsp/api/status

业务参数:

字段名称 类型 描述
materialurl array of string 需要查询的一个或多个物料的URL

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 若result为0,message类型为object,为查询的物料的审核结果;如果查询的某个物料url不存在,则在返回信息中不会有该url相关的信息;若result不为0,则message类型为string,为具体的错误信息

请求示例:


\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/status'
\\ JSON:
{
  "dspid":"11268",
  "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
  "materialurl":["http://material.client.com/134.swf","http://material.client.com/135.swf","http://material.client.com/136.swf"]
}

正常返回示例:

{ 
  "result":0,
  "message":
  { 
    "total" :3,
    "records" : [
    {
      "url": "http://material.client.com/134.swf", 
      "result":"不通过"
      "reason": "默认素材不需要上传了"
    },
    {
      "url": "http://material.client.com/135.swf", 
      "result":"通过"
      "reason": ""
    },
    {
      "url": "http://material.client.com/136.swf", 
      "result":"待审核"
      "reason": ""
    }
    ]
  }
}

报表获取API

DSP可以通过该API向Mix-Mind请求下载报表,报表分为天报表和小时报表,天报表和小时报表下面分概览数据报表和详细数据报表两个形式。概览数据报表内容包括查询日期段内,DSP整体竞价请求数、竞价响应数、竞价胜出次数、曝光量、点击量、费用;天报表-概览数据报表每次查询日期段最大允许31天,小时报表-概览数据报表每次查询日期最大允许7天。详细数据报表内容包括查询日期段内,DSP每天、每个广告位上竞价请求数、竞价响应数、竞价胜出次数、曝光量、点击量、费用;天报表-详细数据报表查询日期段最大允许7天,小时报表-详细数据报表查询日期段最大允许1天。

API地址:

POST http://{exchange.domain}/dsp/api/report

业务参数:

字段名称 类型 描述
type string 请求的报表类型,包括:general(概览)和detail(详细数据),如果为空,则默认为general
startdate string 报表查询的开始日期,要求是YYYY-MM-dd的格式,如2012-02-01,不能为空
enddate string 报表查询的结束日期,要求是YYYY-MM-dd的格式,如2012-02-07,不能为空

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 如果result为0,message为object,返回报表信息;如果result不为0,message为string,返回具体的错误提示信息

天报表请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/report'
\\ JSON:
{
  "dspid":"11268",
  "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
  "type":"general"/"detail",
  "startdate":"2012-12-01",
  "enddate":"2012-12-07"
}

天报表请求中type为general,返回示例:

{ 
  "result":0,
  "message":
  {
    "bid": 5000,
        "bidresponse": 4500,
    "winbid": 4000,
    "pv": 3950,
    "click": 125,
    "cost": 120.00
  }
}

天报表请求中type为detail,返回示例:

{
  "result":0,
    "message":
    {
      "total" :1,
      "records" :
      {
        "2012-02-01":
          [{
            "aid": "101",
            "bid": 6400,
                        "bidresponse":5000,
            "winbid": 4300,
            "pv": 4100,
            "click": 200,
            "cost": 980.00
                    },
          {
            "aid": "102",
            "bid": 3600,
                        "bidresponse":3000,
            "winbid": 2000,
            "pv": 1990,
            "click": 40,
            "cost": 90.00
          }]
      }
    }
}

小时-概览报表,最多查7天 请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/report/hour/general'
\\ JSON:
{
    "dspid":"11268",
    "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
    "startdate":"2012-12-01", 
    "enddate":"2012-12-07" 
}

小时-概览报表,返回示例:

{
  "result": 0,
  "message": {
    "total": 2,
    "records": {
      "2012-02-01": {
        "00": {
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        },
        "01": {
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        }
      },
      "2012-02-02": {
        "00": {
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        },
        "01": {
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        }
      }
    }
  }
}

小时-详细报表,只能查1天 请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/report/hour/general'
\\ JSON:
{
    "dspid":"11268",
    "token":"92205dff8f9d48e1b7a26b0b88af7dc1",
    "date":"2012-12-07" 
}

小时-详细报表,返回示例:

{
  "result": 0,
  "message": {
    "total": 2,
    "records": {
      "00": [
        {
          "aid": "101",
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        },
        {
          "aid": "101",
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        }
      ],
      "01": [
        {
          "aid": "101",
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        },
        {
          "aid": "101",
          "bid": 6400,
          "bidResponse": 22,
          "winbid": 4300,
          "pv": 4100,
          "click": 200,
          "cost": 980
        }
      ]
    }
  }
}

备注: 上面的API接口示例中,我们在Exchange的沙箱系统http://sandbox.adx.xelements.cn 上设置了一个用来测试的DSP,其ID为11268,名称为”guest”。所以这上面列出来的API例子都是可以实际调用的。

Deal 信息获取API

说明: dsp通过该接口获取Deal信息。

API地址: POST http://{exchange.domain}/dsp/api/deals

业务参数:

参数名称 类型 含义
pageIndex int 页码,必填,从1开始
pageSize int 查询记录条数,必填,最大1000

返回信息:

参数名称 类型 含义
result int 0:执行成功 1:系统认证失败 2:请求参数错误 3:其他错误
message object或者string 如果result为0,message为object,返回结果数据;如果result不为0,message为string,返回具体的错误提示信息

请求示例:

\\ POST 'http://sandbox.adx.xelements.cn/dsp/api/deals'
\\ JSON:
{
  "dspid": "11268",
  "token": "92205dff8f9d48e1b7a26b0b88af7dc1",
  "pageIndex": 2, // 页码,必填,从1开始
  "pageSize": 10 // 查询记录条数,必填,最大1000
}

正常返回时,message的示例:

{ 
    "total" :100, //总数
    "count" :2, //返回记录条数
    "records" : [
        { 
            "id": 1, // deal id
            "startTime": "2015-01-02", // 投放开始日期
            "advertisers": ["广告主1", "广告主2"], //广告主
            "deviceTypes": ["pc", "pad", "phone", "tv"], //设备类型。包括pc:PC,pad:平板,phone:手机,tv:电视。
            "price": 65, //cpm价格,单位为分
            "name": "Deal01", // deal名称
            "osTypes": ["ios", "android", "windows","other"], //操作系统类型。包括ios:IOS,android:Android,windows:Windows,other:其他。
            "areas": ["山西省", "内蒙古"],//投放地区
            "endTime": "2015-01-11",//投放结束日期
            "adplacements": [26, 27], //广告位Id
            "group": "",//用于标识PDB/PD活动下单的文本信息,可以使用group统一管理下单的deal;String类型,默认值是""
            "sourceid":"0",//上游媒体id,type-string;0-无上游媒体;3-sohu;4-youku;5-letv;6-iqiyi;7-tencent
            "saleType":1 //售卖类型,type-integer;1-PDB、2-PD、3-RTB、4-others
        }, 
        { 
            "id": 2,
            "startTime": "2015-01-02",
            "advertisers": ["广告主1", "广告主2"],
            "deviceTypes": [],
            "price": 65,
            "name": "Deal02",
            "osTypes": [],
            "areas": [],
            "endTime": "2015-01-11",
            "adplacements": [26, 27],
            "group": "",
            "sourceid":"0",//type-string;0-无上游媒体;3-sohu;4-youku;5-letv;6-iqiyi;7-tencent
            "saleType":1 //type-integer;1-PDB、2-PD、3-RTB、4-others
        }
    ]
}

实时竞价接口

Bid Request

协议采用HTTP POST,开启keep-alive,消息格式为JSON,目前timeout设为120ms。请求头中需要设Content-Type为application/json。

Bid Request结构图:

bid request native

Request Object

字段名称 类型 描述
id string 请求ID
imp array of objects 曝光对象,一次request可以包含多个imp
site object 媒体站点对象
device object 设备对象
user object 用户对象
app object 应用对象(内含移动应用的信息)
wseat array of string DSP允许竞价的seat白名单
ext object 扩展字段,参看request.ext字段说明
request.ext object详细字段及含义:
字段名称 类型 描述
media_source Integer 流量来源,1-Mix-Mind 2-GroupM
sourceid Integer 即将废弃字段,请勿使用
clickthrough Integer 支持点击类型:0-异步点击、1-串行点击
skipSizeCheck Integer adx物料校验类型:0-校验、1-不校验
sub_sourceid Integer 媒体ID标识详见媒体ID说明
imp object

说明:只包含一个banner或video对象或nativead对象,不会同时包含

字段名称 类型 描述
id string 曝光 ID
tagid string 广告位ID
bidfloor float 底价,单位是分/千次曝光,即CPM
banner object banner类型的广告位
video object video类型的广告位
nativead object 原生类型的广告位,NativeAd定义详见文档AdExchange RTB原生广告接口文档
pmp object pmp字段,deal相关的参数,参看pmp字段的说明
secure Integer 用来标识流量端对监测、广告创意、落地页等资源HTTPS/HTTP协议请求,secure=1 监测、广告创意、落地页必须返回https的广告信息,secure=0 监测、广告创意、落地页不限制,http/https都可以, secure=2 监测、落地页必须为https,广告创意不限制
ext object 扩展字段,参看imp.ext字段的说明
字段名称 类型 描述
w integer 广告位宽度
h integer 广告位高度
pos integer 广告位位置,兼容openRTB2.2中6.5表格关于广告位置的规定,见附录C展示位置
mimes array of string 允许投放的物料类型[“image/png”,“application/x-shockwave-flash”,“text/html”]
video object
字段名称 类型 描述
mimes array of string 支持播放的视频格式,目前支持: video/x-flv,application/x-shockwave-flash
linearity integer 广告展现样式,1为in-stream, 2为overlay。“In-stream” or “linear” video refers to pre-roll, post-roll, or mid-roll video ads where the user is forced to watch ad in order to see the video content. “Overlay” or “non-linear” refer to ads that are shown on top of the video content.
minduration integer 视频广告最短播放时长,单位是秒
maxduration integer 视频广告最长播放时长,单位是秒
w integer 广告位宽度
h integer 广告位高度
pos integer 广告位位置,兼容openRTB2.2中6.5表格关于广告位置的规定,见附录C展示位置
adType integer 贴片类型,可为空,目前支持的贴片类型包括:1-前贴、2-中贴、3-后贴
auto_match integer 贴片video类型的广告位是否支持尺寸自适应:1-支持,0-不支持
pmp object详细字段及含义:
字段名称 类型 描述
deals Array of 符合exchange系统的deal条件的deals对象数组,见deals对象说明
private_auction integer 1表示只接受deal竞价;0表示在deal竞价失败的时候,可以接受公开竞价
pmp.deals object 详细字段及含义:
字段名称 类型 描述
id string 符合条件的deal的id
dealType Integer 下单类型,0-RTB、1-PDB、2-PD
bidfloor Integer Exchange系统中deal的价格
wseat array of string 可参与deal的广告主名称列表
at Integer 竞价的方式,目前都是1,即第一竞价法。最高的deal获得竞价成功。价格为最高的deal的价格。
media_source Integer 流量来源,1-Mix-Mind 2-GroupM
screen_type Integer 0-小屏,3-大屏,请求投屏广告时对应的请求设备屏幕类型(请求投屏广告时,dsp可根据此字段,识别请求的投屏广告是大屏的还是小屏的)
app_crid string 请求投屏广告时携带的小屏缓存的素材id(请求小屏广告时,若此字段有值,dsp侧返回的小屏素材id要与此字段保值持一致;请求大屏投屏广告时,若此字段有值,dsp侧需要根据此素材id选择对应的大屏素材返回)
support_adeffect array of string 优酷流量支持哪些广告样式的创意
imp.ext object详细字段及含义:
字段名称 类型 描述
showtype integer 展示类型,Mix-Mind对广告展示形式的一种分类,具体见附录B展示类型
has_winnotice integer 该字段表示是取物料上传指定的(曝光、点击监测、落地页)还是实时响应的(曝光、点击监测、落地页)。 1-实时响应(曝光、点击监测、落地页) 0-物料上传指定的(曝光、点击监测、落地页)
action_type integer 媒体资源位置支持的交互类型:1.支持网页打开类+下载类广告 2.只支持打开类广告 3.只支持下载类广告
launch_date string 闪屏预加载投放日期(仅闪屏部分媒体传值,其它为空),示例:2022-08-01
site object
字段名称 类型 描述
name string 媒体网站名称
page string 当前页面URL
ref string referrer URL
content object 视频的内容相关信息。只有视频贴片类型的广告位才会有这个字段,参见site.content对象描述
cat Array of string 广告位内容分类,兼容IAB分类,符合openRTB 2.2表格6.1的分类方法。
site.content
字段名称 类型 描述
title string 视频标题名称
keywords string 视频标签关键字,如果是多个关键字,则使用英文逗号分隔
ext object 参见site.content.ext描述
site.content.ext object
字段名称 类型 描述
channel string 视频的频道ID,例如”1”。频道id需要与sourceid配合使用。视频流量的频道字典详见附录E
cs string 二级频道ID
copyright Integer 版权信息 0—版权信息未知 1—有版权
quality Integer 流量质量 1—流量质量保障 2—流量质量未知
device object
字段名称 类型 描述
ua string user agent(Browser user agent string)
ip string 客户端ip或Ipdx IP.1.dsp在Mix-Mind平台上开启了IPDX服务,在Mix-Mind平台查询到ipdx的情况下是ipdxip,未查到ipdx的情况下是客户端ip 2.dsp在Mix-Mind平台上未开启IPDX服务,ip字段传的是客户端ip
geo object 设备的当前地理位置信息,参见geo对象详细字段描述。
didmd5 string 使用MD5哈希的Device ID(对应Android系统MMA字段的IMEI值,iOS系统api限制获取不到该值)
dpidsha1 string 使用SHA1哈希的Device ID值(对应Android系统MMA字段的IMEI值,iOS系统api限制获取不到该值)
dpidmd5 string 使用MD5哈希的平台相关ID,不同的系统会传不同的值,具体对应的移动端MMA字段: Android系统会传–Android ID,iOS系统会传–openudid,Windows Phone系统会传–DUID
make string 设备生产商,如”Apple”
model string 设备型号,如”iPhone”
os string 操作系统 “Android”/“iOS”/“WP”/“Others” (忽略大小写)
osv string 操作系统版本号,如”4.1”
carrier string 运营商的ID:0-未知、1-中国移动、2-中国联通、3-中国电信、4-中国铁通
language string 安卓:“zh”、iOS:“zh-Hans-CN”
js integer 是否启用Javascript,1—启用(默认值),0—未启用
connectiontype integer 网络连接类型,和OpenRTB一致:0—未知,1—Ethernet,2—wifi,3—蜂窝网络,未知代,4—蜂窝网络,2G,5—蜂窝网络,3G,6—蜂窝网络,4G, 7-5G
devicetype integer 设备类型,和0—手机,1—平板,2—PC,3—互联网电视。
ext object 扩展信息,参见device.ext详细字解释。
oaid string 安卓设备的oaid取原值
oaidmd5 string 安卓设备的oaid取MD5值(小写)。
device.ext object
字段名称 类型 描述
idfa string 对应的移动端MMA字段:iOS的IDFA字段(iOS系统 osv>=6时会传该字段,传的是原始值未经过md5 sum),如:“1E2DFA89-496A-47FD-9941-DF1FC4E6484A”
idfamd5 string 对应的移动端MMA字段:iOS的IDFA字段取MD5值,如:“40C7084B4845EEBCE9D07B8A18A055FC”
caid string 广协作为IOS系统上统一设备标识ID,包括当前最新版本号和上一版本号的CAID值,用英文逗号分隔;也有只有一个版本的情况;示例:20230330_5b41664dcfc8ef0c8d9ff8c940a1415f,20220111_2d8037b89f46cd273a736d72cbd84b1e
caidmd5 string 广协作为IOS系统上统一设备标识ID MD5值,包括当前最新版本号和上一版本号的CAID值,用英文逗号分隔;也有只有一个版本的情况;示例:20230330_3360a1404ffbeb21e2b9b6cbf47357ad,20220111_13e537c8fdf9da8560b4243c5b9e506e
mac string 去除分隔符”:”(保持大写)的MAC地址取MD5摘要,eg:3D8A278F33E4F97181DF1EAEFE500D05
macmd5 string 保留分隔符”:”(保持大写)的MAC地址取MD5摘要,eg:DC7D41E352D13D60765414D53F40BC25
macsha1 string MAC地址取sha1摘要
ssid string WIFI的
w integer 设备的屏幕宽度,以像素为单位
h integer 设备的屏幕高度,以像素为单位
ppi integer 屏幕每英寸像素数量
brk integer 设备是否越狱,1—已启用(默认),0—未启用。
ts integer 发送请求时的本地UNIX时间戳(秒数,10进制)
interstitial integer 是否使用全屏/互动方式来展现广告。1—是,0—否(默认值)。
realip string 客户端ip地址
isipdx boolean true:device中ip的值为ipdx ip;false:device中ip的值是客户端ip
hw_name string md5后的设备名称
hw_machine string 系统型号
country_code string 国家代码,默认”CN”
sys_memory string 系统内存
sys_disk_size string 硬盘容量
app_list array of string 用户app安装列表
os_update_time string 系统更新时间:安卓:“1599477811000”; iOS:“1597312869.074839”
boot_mark string 系统启动参数(阿里),具体私底下沟通,⽰例:iOS:1668445049.857251 安卓:99f595fb-ec71-4cbf-82a1-718b9eb5d9d7
update_mark string 系统启动参数(阿里),⽰例:iOS:1642902073.788313499 安卓:1668842127.672008850
hms_core_version string 华为 HMS Core 版本号
appstore_ver string 厂商应用商店版本号(vovi、小米、华为、oppo 等厂商应 用商店)
geo object
字段名称 类型 描述
lat float 纬度(-90~90)
lon float 经度(-180~180)
ext object 扩展属性,参见geo.ext详细字段解释。
geo.ext object
字段名称 类型 描述
accuracy integer GPS的精确度,单位为米。如:100表示精确度为100米。
user object
字段名称 类型 描述
id string Mix-Mind用户ID(即Mix-Mind域的cookie id)
ext object 扩展属性,包括DMP信息,参见 user.ext说明
user.ext object
字段名称 类型 描述
models array of string Mix-Mind的DMP标签, 形式是字符串标签组成的数组,例如[“10000”, “10008”],具体的标签说明参见Mix-Mind DMP标签说明
upuid string 表示媒体用户ID(即Mix-Mind透传给DSP的cookie id),若媒体用户ID为空,则不传该字段,而非”upuid”=” “。
tag string 透传风行媒体ta浓度值,取值0-100
app object
字段名称 类型 描述
name string App的名称
bundle string APP应用的包名称或bundleID
ver string APP应用版本
itid string iOS App iTunes ID 例如”28677149 ”
content object 视频的内容相关信息。只有视频贴片类型的广告位才会有这个字段,同site.content对象
cat Array of string 广告位内容分类,兼容IAB分类,符合openRTB 2.2表格6.1的分类方法。对应的编号和中英文对照表见附录Content Category
ext object 扩展信息,参见app.ext详细字段解释。
app.ext object
字段名称 类型 描述
sdk string 投放SDK的版本,例如“91_v1”
market integer 应用商店,1—iOS Appstore,2—Google Play,3—91Market。
deeplink integer 是否支持应用直达 0-不支持(默认) 1-支持

:上面给出的Bid Request Object的各个字段都存在,但是值可能为空

Bid Request-banner示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//请求id
    "site":{//媒体站点对象
        "name":"baofeng",
        "ref":"",
        "page":"http://www.baofeng.com",//当前页面url
    "cat":["IAB1","IAB2","IAB3"]//媒体分类
  },
    "device":{//设备对象
      "devicetype":2,//设备类型
        "ip":"59.108.43.2",
        "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36"
    },
    "user":{//用户对象
        "id":"qfHdV0ez0N10",//xtid 也就是Mix-Mind的cookie id
        "ext":{
          "models":["10000","10002"]
        }
    },
    "imp":[{//曝光对象
        "id":"00448754623f45c7a245274392213a0f",//曝光id
        "tagid":"319",//曝光对应的exchange系统的广告位id
        "bidfloor":1,//广告位低价
        "banner":{
          "w":300,
            "h":250,
            "pos":4//广告展示位置
        },//广告位尺寸
        "ext":{
          "showtype":1//广告展示类型
        }
    }]
}
Bid Request-video示例
{
    "id": "y020_8081-t15-1422532390-69-436",
    "site": {
        "name": "新蓝网",
        "ref": "",
        "page": "http://www.cztv.com/",
        "cat":["IAB1","IAB2","IAB3"]//媒体分类
    },
    "device": {
      "devicetype":1,
        "ip": "59.108.43.2",
        "ua": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36"
    },
    "user": {
        "id": "payyX0mC0Xc3",
        "ext": {
            "models": ["10001","10008"]
        }
    },
    "imp": [
        {
            "id": "1b010fb513ae4bfc927d9f95874d721f",
            "tagid": "3091",
            "bidfloor": 700,
            "video": {
                "w": 640,
                "h": 480,
                "mimes": [
                    "application/x-shockwave-flash",
                    "video/x-flv"
                ],
                "linearity": 1,
                "minduration": 14,
                "maxduration": 16,
                "pos": 4//广告展示位置
            },
            "ext":{
              "showtype":2 //广告展示类型
            }
        }
    ]
}
Bid Request-app示例

{
  "id":"v1.2-test-1-t12-1396427099-0-779",
    "device":{
      "devicetype": 0,
      "ip":"59.108.43.2",
        "ua":"Mozilla/5.0(iPhone;CPUiPhoneOS6_0likeMacOSX)AppleWebKit/536.26(KHTML,likeGecko)Version/6.0Mobile/10A403Safari/8536.25",
        "didmd5":"86582ed374218d769fa365bf29dc70e8",
        "dpidmd5":"2fb25aac4555d7ffc89ca998cce00ecc",
        "os":"Android",
        "ext":{
          "macmd5":"DC7D41E352D13D60765414D53F40BC25"
        }
    },
    "user":{
      "id":""
    },
    "app":{
      "name":"test_app",
      "bundle":"com.test.cn",
        "cat":["IAB1","IAB2"]
    },
    "imp":[
      {
        "id":"35829dda8b5642f99d5dd4c6e3628dbe",
          "tagid":"1","bidfloor":13400,
          "banner":{
            "w":399,
              "h":299,
                "pos":1
          },
            "ext":{
              "showtype":14
            }
      }
    ]
}
Bid Request-preferred deal示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//请求id
    "site":{//媒体站点对象
        "name":"baofeng",
        "ref":"",
        "page":"http://www.baofeng.com",//当前页面url
    "cat":["IAB1","IAB2","IAB3"]//媒体分类
  },
    "device":{//设备对象
      "devicetype":2,//设备类型
        "ip":"59.108.43.2",
        "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36"
    },
    "user":{//用户对象
        "id":"qfHdV0ez0N10",//xtid 也就是Mix-Mind的cookie id
        "ext":{
          "models":["10000","10002"]
        }
    },
    "imp":[{//曝光对象
        "id":"00448754623f45c7a245274392213a0f",//曝光id
        "tagid":"319",//曝光对应的exchange系统的广告位id
        "bidfloor":1,//广告位低价
        "banner":{
          "w":300,
            "h":250,
            "pos":4//广告展示位置
        },//广告位尺寸
        "pmp":{
          "private_auction":1,
            "deals":[
              {
                  "id":"xxxx",
                    "at":1,
                    "bidfloor":200,
                    "wseat":["adver1","adver2"]
                }
            ]
        },
        "ext":{
          "showtype":1//广告展示类型
        }
    }]
}

Bid Response

说明:DSP正常出价响应包的返回状态码为HTTP 200 ok,决定不出价的则为204 no content。其他情况会当做出错处理,如403 forbidden或500 internal server error。

注:DSP决定不出价时,需要返回的状态码是204,而不是200OK。

Bid Response结构图

bid response

Bid Response object

字段名称 类型 描述
id string 请求ID
bidid string DSP给出的该次竞价的ID
seatbid array of objects DSP出价
seatbid object
字段名称 类型 描述
bid array of objects 针对单次曝光的出价
seat string 有Mix-Mind平台提供给DSP的本次出价的seat ID
bid object
字段名称 类型 描述
id string DSP对该次出价分配的ID
impid string Bid Request中对应的曝光ID
price float DSP出价,单位是分/千次曝光,即CPM
nurl string win notice url,处理和曝光监测一样,nurl是否支持发送 参见投放说明
adm string 广告物料URL。如果是动态创意,这个字段存放的是创意的HTML标签,标签中支持三种宏替换,%%CLICK_URL_ESC%%(encode的Exchange的点击监测地址)、%%CLICK_URL_UNESC%%(未encode的Exchange点击监测地址)和%%WINNING_PRICE%%(竞价最终价格)。
crid string DSP系统中的创意ID,对于后审核的创意(即动态创意),这个字段可以留作历史查证。
pvm array of string 字段已废弃,请使用ext.pm字段
clickm string 字段已废弃,请使用ext.ldp字段
dealid string Dsp参加的deal的id
ext object 扩展字段
cid string 投放活动id
ext object
字段名称 类型 描述
ldp string 点击目标URL。广告点击后会跳转到物料上绑定的landingpage,还是取实时返回的ldp,参见投放说明
deeplinkurl String 应用直达URL,当返回了deeplinkurl,优先唤醒本地app,如果无法唤醒,则调用ldp(打开或者下载)
ulk string IOS的universal link 链接
pkg_name String action_type=1或deeplinkurl!=““时必须
program_id String 微信小程序ID,示例:gh_18991c977786
program_path String 微信小程序页面路径,示例:pages/remind/questionnaire/index?source=tencent
pm array of strings 曝光监测URL,监测数组支持的曝光条数和广告展现时是否会发物料上绑定的monitor地址,参见投放说明
cm array of strings 点击监测URL,监测数组支持的点击监测条数,参见投放说明
action_type integer 媒体资源位置支持的交互类型:1.download—下载类广告 2.landingpage—打开落地页型广告 4.微信小程序 5.点击不跳转
type string 物料的类型,包括png,gif,jpg,swf,flv,c和x。具体参见 Exchange物料类型注意:c和x类型物料必须指定类型,其他物料可以不用指定这个字段。
imp_ext1 String 曝光宏值,替换动态内容
imp_ext2 String 曝光宏值,替换动态内容
imp_ext3 String 曝光宏值,替换动态内容
imp_ext4 String 曝光宏值,替换动态内容
clk_ext1 String 点击宏值,替换动态内容
clk_ext2 String 点击宏值,替换动态内容
event array of object 描述 监测事件或监测触发时间点。目前只对视频贴片广告有效。event object 可以有多个;目前支持event监测事件的视频媒体:搜狐、优土、爱奇艺、乐视、芒果、PPTV、风行;其他视频媒体暂不支持
trv String 投放腾讯媒体固定响应值为2,其它媒体可不返回
cover_img String 开屏视频的封面图(针对普通物料)
event object
字段名称 类型 描述
t float 描述监测事件节点 0-start、0.25-firstQuartile、0.5-midpoint、0.75-thirdQuartile、1-complete、2-主动播放(只对头条媒体有效)、3-有效结算监测(只针对爱奇艺、搜狐有效)、11-自定义秒数监测。目前只对视频贴片广告有效,仅支持返回监测事件。4-deeplink调起成功、5-deeplink调起失败 4、5事件对非视频也有效;下载类事件:6-开始下载、7-下载完成、8-开始安装、9-安装完成、10-应用激活
point integer 描述监测触发秒数(s)。事件节点t=3或11时,取监测触发秒数;其它事件节点秒数不生效(仍然以事件节点处理)
tm array of strings 描述 曝光监测url,指定监测事件或时间点发送的一组监测地址
Bid Response一般示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//竞价请求ID(对应Bid Request中的id)
    "bidid":"100002_200004_1000014",//DSP给出的该次竞价的ID
    "seatbid":[{//注意第一层数组  DSP出价
        "bid":[{//注意第二层数组 针对单次曝光的出价
            "adm":"http://xxx.jpg",
            "id":"100002_200004_1000014_0",//DSP对该次出价分配的ID
            "impid":"297902be955e49a291bcc44c7f13448c",//Bid Request中对应的曝光ID
            "nurl":"http://test.xxx.com?id=${AUCTION_ID}&bidid=${AUCTION_BID_ID}&impid=${AUCTION_IMP_ID}&price=${AUCTION_PRICE}",//目前nurl支持这四个宏替换
            "price":600,//DSP出价,注意单位是分/千次曝光,即CPM
            "crid":"1000014",//投放动态创意(即c类型的物料),需添加该字段
            "ext":{
                "ldp":"http://ss.thinkworld.com.cn/",
                "pm":["http://test.xxx.com"],//注意曝光监测url是数组
                "cm":["http://test.xxx.com"]//注意点击监测url是数组
            }
        }]
    }]
}
Bid Response-Preferred Deal示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//竞价请求ID(对应Bid Request中的id)
    "bidid":"100002_200004_1000014",//DSP给出的该次竞价的ID
    "seatbid":[{//注意第一层数组  DSP出价
        "bid":[{//注意第二层数组 针对单次曝光的出价
            "adm":"http://xxx.jpg",
            "id":"100002_200004_1000014_0",//DSP对该次出价分配的ID
            "impid":"297902be955e49a291bcc44c7f13448c",//Bid Request中对应的曝光ID
            "nurl":"http://test.xxx.com?id=${AUCTION_ID}&bidid=${AUCTION_BID_ID}&impid=${AUCTION_IMP_ID}&price=${AUCTION_PRICE}",//目前nurl支持这四个宏替换
            "price":600,//DSP出价,注意单位是分/千次曝光,即CPM
            "crid":"1000014",//投放动态创意(即c类型的物料),需添加该字段
            "dealid":"xxxx",
            "ext":{
                "ldp":"http://ss.thinkworld.com.cn/",
                "pm":["http://test.xxx.com"],//注意曝光监测url是数组
                "cm":["http://test.xxx.com"]//注意点击监测url是数组
            }
        }]
    }]
}
Bid Response动态创意示例

note:Mix-MindADX支持iframe和js代码两种形式的动态创意广告

iframe形式的动态创意广告
{
    "bidid":"auction-server-1.2-sandbox-1-t12-1383719279-0-965",
    "id":"auction-server-1.2-sandbox-1-t12-1383719279-0-779",
    "seatbid":[{
        "bid":[{
            "id":"GoJztreCnAY=",
            "impid":"61d7460dd7cf456e9a83ae330562f8da",
            "adm":"<iframe frameborder='0' scrolling='no' marginwidth='0' marginheight='0' padding='0' width='300' height='250' src='http://test.dsp.com/s?clickm=%%CLICK_URL_ESC%%' ></iframe><img src=http://test.dsp.com/s?price=%%WINNING_PRICE%%/>",//动态创意直接通过adm字段返回代码广告,Mix-MindADX会针对adm code中的宏做对应替换
            "nurl":"",
            "price":290.0,
            "crid":"10450934",//创意id
            "ext":{
                "cm":[],
                "ldp":"",//动态创意点击跳转地址有dsp控制,真实线上投放不会使用该字段的ldp地址
                "pm":[],//
                "type":"c"//注意动态创意必须指明"type":"c"字段,Mix-MindADX会忽略物料检查,否则会投放不出去
            }
        }]
    }]
}
Bid Response-监测宏动态参数示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//竞价请求ID(对应Bid Request中的id)
    "bidid":"100002_200004_1000014",//DSP给出的该次竞价的ID
    "seatbid":[{//注意第一层数组  DSP出价
        "bid":[{//注意第二层数组 针对单次曝光的出价
            "adm":"http://xxx.jpg",
            "id":"100002_200004_1000014_0",//DSP对该次出价分配的ID
            "impid":"297902be955e49a291bcc44c7f13448c",//Bid Request中对应的曝光ID
            "nurl":"http://test.xxx.com?id=${AUCTION_ID}&bidid=${AUCTION_BID_ID}&impid=${AUCTION_IMP_ID}&price=${AUCTION_PRICE}",//目前nurl支持这四个宏替换
            "price":600,//DSP出价,注意单位是分/千次曝光,即CPM
            "crid":"1000014",//投放动态创意(即c类型的物料),需添加该字段
            "dealid":"xxxx",
            "ext":{
                "ldp":"http://ss.thinkworld.com.cn/",
                "pm":["http://test.xxx.com"],//注意曝光监测url是数组
                "cm":["http://test.xxx.com"],//注意点击监测url是数组
                "imp_ext1":"impression_dynamic_data_1",
                "imp_ext2":"impression_dynamic_data_2",
                "clk_ext1":"clk_dynamic_data_1",
                "clk_ext2":"clk_dynamic_data_2"
            }
        }]
    }]
}
Bid Response 监测事件event参数示例
{
    "id":"auction-server-1.2-sandbox-1-t12-1387962585-0-702",//竞价请求ID(对应Bid Request中的id)
    "bidid":"100002_200004_1000014",//DSP给出的该次竞价的ID
    "seatbid":[{//注意第一层数组  DSP出价
        "bid":[{//注意第二层数组 针对单次曝光的出价
            "adm":"http://xxx.mp4",
            "id":"100002_200004_1000014_0",//DSP对该次出价分配的ID
            "impid":"297902be955e49a291bcc44c7f13448c",//Bid Request中对应的曝光ID
            "nurl":"http://test.xxx.com?id=${AUCTION_ID}&bidid=${AUCTION_BID_ID}&impid=${AUCTION_IMP_ID}&price=${AUCTION_PRICE}",//目前nurl支持这四个宏替换
            "price":600,//DSP出价,注意单位是分/千次曝光,即CPM
            "crid":"1000014",//投放动态创意(即c类型的物料),需添加该字段
            "dealid":"xxxx",
            "ext":{
                "ldp":"http://ss.thinkworld.com.cn/",
                "pm":["http://test.xxx.com"],//注意曝光监测url是数组
                "cm":["http://test.xxx.com"],//注意点击监测url是数组
                "imp_ext1":"impression_dynamic_data_1",
                "imp_ext2":"impression_dynamic_data_2",
                "clk_ext1":"clk_dynamic_data_1",
                "clk_ext2":"clk_dynamic_data_2",
                "event":[
                    {
                      "t":0,
                      "tm":["http://imp1"]
                      
                    },
                    {
                      "t":0.25,
                      "tm":["http://imp2"]
                      
                    },
            {
                       "t":0.25,
               "point":30,
                       "tm":["http://trueview"]

                   }   
                  ]
            }
        }]
    }]
}

动态创意

  1. 动态创意BidResponse返回中必须指明”type”:“c”字段,根据该值Mix-MindADX会忽略物料检查,否则会投放不出去。

  2. 动态创意的广告,需要dsp方处理两件事:1.Mix-Mind点击监测的处理(注意:Mix-Mind的点击监测在o=之后是需要追加一个地址,否则Mix-Mind点击监测发送不成功) 2.广告落地页的处理。 具体示例:

    http://teste.x.cn.xelements.cn/r.gif?bp=1&bf=11116&l=319&m=48&bb=65&br=aBGG5yakY-pakpTPkjcodAnsZzyB4Twvnn7E86n-W19UX-ryFr7Gkp0lcl_f7k2dOiN4IbDVe-pwVMp2FFZPFRbUUeR0WZmVwmerGNrkf4I&be=1014&bo=08FDB6553C05&o=[dsp点击监测地址或广告落地页地址] 
    
    注意:Mix-Mind点击监测o=之后必须加一个地址,否则Mix-Mind点击监测发送不成功
  3. 动态创意的价格宏是%%WINNING_PRICE%%,winnotice中价格宏是${AUCTION_PRICE}

  4. 对于动态创意的广告,可以不用bid.nurl和bid.ext.pm字段接收winnotice和广告曝光。具体可以在动态创意广告中增加img标签来监测广告曝光。 示例:

    <iframe frameborder='0' scrolling='no' marginwidth='0' marginheight='0' padding='0' width='300' height='250' src='http://test.dsp.com/s?clickm=%%CLICK_URL_ESC%%' ></iframe><img src=http://test.dsp.com/s?price=%%WINNING_PRICE%%/>   

动态创意中支持的宏如下:

字段名称 类型 描述
price %%WINNING_PRICE%% Settlement price,曝光的最终拍卖价。具体和WINNOTICE中的宏${AUCTION_PRICE}一致
Mix-Mind点击监测-1 %%CLICK_URL_ESC%% 经过encode处理的Mix-Mind点击监测-示例如:http%3A%2F%2Fteste.x.cn.xelements.cn%2Fr.gif%3Fbp%3D1%26ci%3D0%26bf%3D11288%26icp%3D0%26l%3D351%26m%3D48%26bb%3D95%26br%3De725FgFiqZcPDYLAm5fmUiDhUy-8fhMNis117cCsy_IlkgEFqmWA4xFlp8UwT69oBLbtXAwk3CYqC3BoIZ5CCW9s4viLX9qSgRC_8vpSFpEDfxnSiA6CK9jIQ0Odwh5l%26be%3Dnull%26bo%3D0%26o%3D 注意:Mix-Mind点击监测代码之后需要添加落地页或302跳转的地址
Mix-Mind点击监测-2 %%CLICK_URL_UNESC%% 没有经过encode处理的Mix-Mind点击监测-示例如:http://teste.x.cn.xelements.cn/r.gif?bp=1&ci=0&bf=11288&icp=0&l=351&m=48&bb=95&br=e725FgFiqZcPDYLAm5fmUiDhUy-8fhMNis117cCsy_IlkgEFqmWA4xFlp8UwT69oBLbtXAwk3CYqC3BoIZ5CCW9s4viLX9qSgRC_8vpSFpEDfxnSiA6CK9jIQ0Odwh5l&be=null&bo=0&o= 注意:Mix-Mind点击监测代码之后需要添加落地页或302跳转的地址

WINNOTICE

Mix-Mind对竞标成功的DSP发送获胜通知(win notice url),同曝光通过用户客户端发送,协议为 HTTP GET。 DSP在定义win notice url时可以使用下面的宏,Mix-Mind在发送win notice前,会对宏进行替换。DSP可以在Bid response中通过nurl字段提供win notice url,如果nurl为空,则ADX会发送DSP在账号注册时提供的默认win notice url。

注:nurl除了宏替换的参数外,dsp可自己拼nurl的地址,加入其它的动态参数,我们的系统会查找nurl中的宏进行替换。 以下定义宏替换范围:nurl、ldp、pm、cm、imp_ext1、imp_ext2、imp_ext3、imp_ext4、clk_ext1、clk_ext2

目前支持的宏如下:

字段名称 宏定义 描述 替换范围
id ${AUCTION_ID} Bid Request ID 曝光、点击监测
bidid ${AUCTION_BID_ID} Bid Response ID per request 曝光、点击监测
impid ${AUCTION_IMP_ID} Impression ID 曝光、点击监测
price ${AUCTION_PRICE} Settlement price,曝光的最终拍卖价。这个字段会使用AES加密,加密的Key是DSP的token。为了和其他Exchange 统一,加密之前我们会在价格之后加上时间戳后缀,即形式如”PRICE_TIME”这样(例如:’201_1376468920380’),再进行加密。解密时请注意需要split出来分别获得价格和时间戳。这里的时间戳是精确到毫秒的。另外,对于动态物料,也可以在”bid”:“adm”字段中通过宏%%WINNING_PRICE%%来获取价格。 曝光、点击监测
${DOWN_X} ${DOWN_X} 用户手指按下时的横坐标 落地页、点击监测
${DOWN_Y} ${DOWN_Y} 用户手指按下时的纵坐标 落地页、点击监测
${UP_X} ${UP_X} 用户手指抬起时的横坐标 落地页、点击监测
${UP_Y} ${UP_Y} 用户手指抬起时的纵坐标 落地页、点击监测
${CLICK_TS} ${CLICK_TS} 客户端触发时间戳(单位:秒) 落地页、点击监测
${CLICK_TMS} ${CLICK_TMS} 客户端触发时间戳(单位:毫秒) 落地页、点击监测
${CLICK_DOWN_TMS} ${CLICK_DOWN_TMS} 点击按下时间戳(单位:毫秒) 落地页、点击监测
${CLICK_UP_TMS} ${CLICK_UP_TMS} 点击抬起时间戳(单位:毫秒) 落地页、点击监测
${M_SLD} ${M_SLD} 广告交互:0-常规触屏点击 1-滑动点击(左右划、全屏划…) 2-摇一摇 5-扭一扭 6-擦除 点击监测
${M_XMAX_ACC} ${M_XMAX_ACC} 用户摇动点击时x轴加速度峰值,单位为(m/s2);当__M_SLD__=2时推荐上报,用户摇动点击时x轴加速度峰值100倍取整,iOS端端乘以980取整 点击监测
${M_YMAX_ACC} ${M_YMAX_ACC} 用户摇动点击时y轴加速度峰值,单位为(m/s2);当__M_SLD__=2时推荐上报,用户摇动点击时y轴加速度峰值100倍取整,iOS端端乘以980取整 点击监测
${M_ZMAX_ACC} ${M_ZMAX_ACC} 用户摇动点击时z轴加速度峰值,单位为(m/s2);当__M_SLD__=2时推荐上报,用户摇动点击时z轴加速度峰值100倍取整,iOS端端乘以980取整 点击监测
${M_TURN_X} ${M_TURN_X} 扭动或前倾触发点击时的x轴扭动角度,取值为-180到180的整数,单位为:度(°)当__M_SLD__=5时且涉及到屏幕角度变化,推荐上报 点击监测
${M_TURN_Y} ${M_TURN_Y} 扭动或前倾触发点击时的y轴扭动角度,取值为-180到180的整数,单位为:度(°)当__M_SLD__=5时且涉及到屏幕角度变化,推荐上报 点击监测
${M_TURN_Z} ${M_TURN_Z} 扭动或前倾触发点击时的z轴扭动角度,取值为-180到180的整数,单位为:度(°)当__M_SLD__=5时且涉及到屏幕角度变化,推荐上报 点击监测
${M_TURN_TIME} ${M_TURN_TIME} 扭动触发点击时扭动的总时间(单位毫秒,保留整数)。即最后一次监听到3个方向扭动角度均小于±5度,到点击触发的时间。当__M_SLD__=5时必填 点击监测
${M_DOWN_TIME} ${M_DOWN_TIME} 点击(滑动)按下时(TOUCH_DOWN)的时间戳,UTC时间1970年1月1日00:00:00以来的毫秒数。当__M_SLD__=0或1必须上报。 点击监测
${M_UP_TIME} ${M_UP_TIME} 点击(滑动)抬起时(TOUCH_UP)的时间戳,UTC时间1970年1月1日00:00:00以来的毫秒数。当__M_SLD__=0或1必须上报。 点击监测

曝光宏替换

Mix-Mind会向竞标成功的dsp发送dsp在pm或pvm数组中返回的曝光地址,协议为 HTTP GET.

pm或pvm数组中的曝光url是由dsp自己拼的地址,dsp可以加入动态参数,同时pm和pvm数组中的曝光地址也支持宏参数替换,具体曝光地址中支持的宏参数和WINNOTICE支持的宏是完全一致的。ADX会查找曝光数组url中的所有宏进行替换。

搜狐新闻、腾讯媒体和UC浏览器替换宏

字段名称 类型 描述
imp_ext1 ${IMP_EXT1} 曝光动态参数宏1;必须按照序列号顺序使用宏
imp_ext2 ${IMP_EXT2} 曝光动态参数宏2;必须按照序列号顺序使用宏
imp_ext3 ${IMP_EXT3} 曝光动态参数宏3;必须按照序列号顺序使用宏
imp_ext4 ${IMP_EXT4} 曝光动态参数宏4;必须按照序列号顺序使用宏
clk_ext1 ${CLK_EXT1} 点击动态参数宏1;必须按照序列号顺序使用宏
clk_ext2 ${CLK_EXT2} 点击动态参数宏2;必须按照序列号顺序使用宏

CookieMapping

沙箱环境cookiemapping服务器测试地址:http://testc.x.cn.xelements.cn/cm.gif?dspid=xxxx

说明:目前cookiemapping和投放过程是分开的,即cookiemapping是单独的流程与投放过程无关。所以cookiemapping需要dsp单独找流量来累计cookie对应值。

Mix-Mind向DSP发送Bid Request中,会携带当前曝光的用户的xtid,而DSP需要通过xtid获取对应的DSP的用户ID,Cookie Mapping就是用来建立这一对应关系的过程。

cookiemapping的过程如下图所示:

CookieMapping

两个url:Mix-Mind服务器地址和dsp服务器地址 Mix-Mind接收Cookie Mapping服务器地址:http://testc.x.cn.xelements.cn/cm.gif?dspid=xxxx(注:该url地址为沙箱环境cookiemapping测试地址),将该地址提供给DSP;DSP向Mix-Mind提供其接收302重定向的服务器的地址:http://cm.dsp.com

整个Cookie Mapping的流程如下:

  1. DSP将Mix-Mind提供的url中的dspid的值修改成Mix-Mind给其分配的dspid,通过img标签嵌入到其某个页面上(dsp找到的流量),当该页面曝光时,将会向Mix-Mind的Cookie Mapping服务器发送一次请求
  2. Mix-Mind的Cookie Mapping服务器接收到请求以后,从Cookie中获得Mix-Mind的用户ID,然后,将该ID以xtid为参数名,附在DSP提供的url上:http://cm.dsp.com?xtid=xxxx,然后返回302,redirect到这个URL(如果不能获取到xtid,则返回200)
  3. DSP的Cookie Mapping服务器收到请求以后,从url中获取xtid参数即可

附录A Exchange物料类型说明

物料类型 对应文件类型 MIME 备注
png *.png image/png PNG图片
jpg *.jpg,*.jpeg image/jpeg JPG或JPEG图片
gif *.gif image/gif GIF图片
flv *.flv video/x-flv FLV视频
swf *.swf application/x-shockwave-flash Flash动画
mp4 *.mp4 video/mp4 MP4视频
x *.swf,*.flv application/x-shockwave-flash,video/x-flv 富媒体类型的Flash动画。注意,Exchange处理x类型物料时,会忽略掉落地页字段(即bidobject中”bid”:“clickm”或”bid”:“ext”:“ldp”字段),因为x类型物料是应当自带点击跳转地址的。但是点击监测地址可以传送过来。
c HTML text/html HTML类型的动态物料,包括iframe或javascript格式。可以内嵌任何形式的HTML。

说明:

视频广告位投放,目前Mix-Mind Exchange允许四种物料类型flv、swf、mp4、x,分别对应文件类型(即BidRequest中指定的文件类型)请参见上Exchange物料类型说明表。
视频素材大小一般的限制:15s要求1M以内,30s一般要求2M以内 ,有些30s要求在1.5M以内。

附录B 展示类型及其编号的说明

实时竞价中给dsp发送的广告位的展示类型是其在Mix-Mind系统exchange中的编号,具体对应的中文名称如下。
编号 中文名
1 PC端网页banner
2 PC端网页video
3 PC端网页背投
4 PC端网页视频暂停
5 PC端网页弹窗
6 PC客户端banner
7 PC客户端video
8 PC客户端弹窗
9 PC端网页视频悬浮
10 PC端网页端信息流
11 移动WAP端banner
12 移动WAP端video
13 移动WAP端信息流
14 移动APP端横幅
15 移动APP端开屏
16 移动APP端插屏
17 移动APP端video
18 移动端视频暂停
19 移动APP端应用墙
20 移动APP端信息流
21 TV端video
22 TV端视频暂停

附录C 展示位置及其编号的说明

实时竞价中给dsp发送的广告位的展示类型是其在Mix-Mind系统exchange中的编号,具体对应的中文名称如下。
编号 中文名 英文名
0 未知 Unknown
1 首屏 Above the fold
3 首屏以下 Below the fold
4 页面顶部 Header
5 页面底部 Footer
6 侧边栏 Sidebar
7 全屏 Fullscreen
8 二屏
9 三屏
10 四屏
11 五屏
12 五屏以下

附录D Mix-Mind DMP标签说明

附录E Mix-Mind视频流量频道字典表


END.

普通媒体和特殊媒体投放说明

物料上传绑定的landingpage/monitor/cm和RTB实时返回的nurl/ext.ldp/ext.pm/ext.cm,Mix-MindAd Exchange平台上根据接入的流量区分处理方式不同:

  1. 普通媒体,广告投放使用RTB实时返回的ext.ldp/ext.pm/ext.cm,物料上传时指定的landingpage/monitor/cm只做素材审核使用,实时投放不会使用或发出。
  2. 特殊媒体1,广告投放落地页使用物料上传指定的landingpage(ext.ldp不使用),曝光、点击监测使RTB实时返回的ext.pm和ext.cm
  3. 特殊媒体2 ,区分标识ext.has_winnotice=0,广告投放只取物料上传指定的landingpage/monitor/cm,实时响应的忽略
  4. 特殊媒体3,优酷、优酷群邑PDB形式,广告投放只取物料上传指定的landingpage/monitor/cm,实时响应的忽略。优酷、优酷群邑PD形式和普通媒体一致。

备注:以上落地页和点击监测的处理逻辑为媒体端的处理逻辑,Mix-MindADX只取实时响应字段给媒体返回

实时投放普通媒体和特殊媒体区分:

流量类型 协议字段 说明
普通媒体 ext.has_winnotice=1&&(sub_sourceid!=4&&sub_sourceid!=69) 普通媒体,取RTB实时返回的nurl/ext.ldp/ext.pm/ext.cm,物料上传时指定的landingpage/monitor只做素材审核使用,实时投放不会使用。
特殊媒体1 sub_sourceid=2(手百)、sub_sourceid=3(搜狐)、sub_sourceid=41(搜狐群邑)、sub_sourceid=15(新浪微博)、sub_sourceid=16(芒果)、sub_sourceid=50(芒果-群邑)、sub_sourceid=34(OPPO)、sub_sourceid=51(网易)、sub_sourceid=52(Vivo)、sub_sourceid=53(UC浏览器)、sub_sourceid=61(PP体育)、sub_sourceid=62(PP体育-群邑)、sub_sourceid=32(咪咕)、sub_sourceid=60(咪咕-群邑)、sub_sourceid=48(米赋)、sub_sourceid=66(米赋-群邑) 媒体端广告投放落地页使用物料上传指定的landingpage(ext.ldp不使用),曝光、点击监测使RTB实时返回的ext.pm和ext.cm
特殊媒体2 ext.has_winnotice=0(腾讯PMP、腾讯RTB、搜狐新闻、UC浏览器) 特殊媒体2,曝光监测、点击监测、落地页统一取物料上传的,实时响应的会被忽略。
1.曝光监测:物料上传指定的曝光监测数组会被触发(实时响 > 应的曝光数组和nurl都会被忽略) 2.落地页:广告点击跳转地址为物料上传指定的落地页(实时响应的落地页会被忽略) 3.点击监测:物料上传指定的点击监测数组会被触发(实时响应的点击数组都会被忽略)
注意:监测url动态参数请指定宏参数上传;bidresponse.seatbid.bid.ext.trv固定指定为2
特殊媒体3 ext.has_winnotice=1&&(sub_sourceid=4”优酷”||sub_sourceid=69”优酷群邑”)&&pmp.deals.dealType==1”PDB” 广告投放只取物料上传指定的landingpage/monitor/cm,实时响应的忽略

宏使用说明

1.物料上传支持带宏的监测代码,示例:
"monitor":["http://dsp.impression.com?${IMP_EXT1}",
"cm":["http://dsp.click.com?${CLK_EXT1}"]

动态宏会使用BidResponse实时返回的宏值替换,在广告曝光时通过客户端发出来监测地址。 非按照宏协议处理的媒体物料上传绑定的带宏监测和BidResponse实时返回的宏值都会被忽略。

移动端流量信息FAQ

  1. 如何区分移动端和PC端流量? 流量区分请根据bidrequest.device.devicetype字段。
  2. 移动端怎么区分app和wap流量?
  1. 移动端wap流量不能获取移动端设备id,可以获取cookie
  2. 移动端app流量唯一id的提供?
  1. 移动端app流量提供的信息?
字段 BidRequest字段 备注
MD5哈希的设备ID device.didmd5 Android系统提供imei值
MD5哈希的平台相关ID device.dpidmd5 使用MD5哈希的平台相关ID,不同的系统会传不同的值,具体对应的移动端MMA字段: Android系统会传–Android ID,iOS系统会传–openudid,Windows Phone系统会传–DUID
MAC地址 device.ext.mac 去除分隔符”:”(保持大写)的MAC地址取MD5摘要,eg:3D8A278F33E4F97181DF1EAEFE500D05
MD5哈希的MAC地址 device.ext.macmd5 保留分隔符”:”(保持大写)的MAC地址取MD5摘要,eg:DC7D41E352D13D60765414D53F40BC25
iOS的IDFA字段 device.ext.idfa iOS>=6的系统会提供该字段
操作系统 device.os Android,iOS,WP,Others 忽略大小写,os示例值:Android

注意: 移动端流量的设备id至少会选择一个提供,不能保证移动端唯一id所有字段都有值。 除上面支持的字段外,对RTB协议中bidrequest的其他字段也是会选择性提供。

  1. 什么是 DeepLink 广告?

    用户点击广告后,直接到达广告主应用内广告指定的App页面,叫做DeepLink。具体来说,应用直达广告允许广告主在投放广告时,指定一个在广告主APP内的落地页(schema URI)。用户点击广告后,系统根据当前广告和用户的情况作出判断,如果条件符合,直接打开APP,并在该APP内打开广告主指定的页面。

    DeepLink广告可以提升用户体验,并提升广告的转化效果。移动端屏幕比较小,APP比WEB更适合用户浏览,能实现更多的功能。

  2. 如何投放 DeepLink 广告

    • 在物料层级添加一个deeplinkurl,投放DeepLink的广告需要在上传素材时填写该字段。
    • 在bidResquest请求层级添加是否支持deeplink字段
    • 在BidResponse返回层级添加deeplinkurl,投放DeepLink的广告需要在实时返回时返回该字段。