仙果DSP对接文档V2.0.1-JSON

目录

  • 仙果DSP对接文档V2.0.1-JSON
  • 1 修订记录
  • 1.1 说明
  • 1.2 接入说明
  • 2 竞价接口
  • 2.1 BidRequest
  • 2.2 BidResponse
  • 3 错误码详情

1修订记录

2016-11-15

(1)DSP-JSON版本修订开始(Ver:2.0.1)

1.1 说明

(1). 该技术文档帮助DSP使用仙果广告的实时竞价接口。通过广告家的接口所传递的参数,匹配出最合适的广告。

(2). 仙果广告和DSP之间实时交互,使用标准的HTTP协议,通过POST方式进行交互,交互格式:json

(3). 同时你可以标准的OpenRTB广告交互协议。

1.2 接入说明

(1). (流量方)合作方通过商务流程: 将贵方的媒介产品报备给仙果广告进行效验。

(2). 仙果的实时竞价请求接口: http://www.xxx.com/api 。

2 竞价接口

实时竞价接口URL:http://192.168.1.166:8090/dsp/ad (正式)

2.1 XianGuoRequest

(1)基础信息

string request_id = 1;  // 请求ID 必填!接入方自定义请求ID,[a-zA-Z0-9]{32}
int iswap=2; // 是否支持WAP 0:不支持;1:支持 默认为0(支持WAP时,必填!)
ArrayList dmp_tag=3;// 用户标签(选填)
double bidprice=4;//选填!底价
参数 类型
Body request_id Object string
Body iswap Object int
Body dmp_tag Object ArrayList
Body bidprice Object double

(2)配置信息

int ssp_id = 1;  // 必填!仙果提供此ID
int medium_id = 2;  // 必填!仙果提供此ID
int mads_id = 3;  // 必填!仙果提供此ID
参数 类型
Body ssp_id Object int
Body medium_id Object int
Body mads_id Object int

(3)app信息

string medium_name=1;必填! app名称
string packageList=2;// app包名(选填)
string cat=3;//app分类(选填)
参数 类型
Body medium_name Object string
Body packageList Object string
Body cat Object string

(4)设备信息

string dpid = 1;  // 必填!安卓ID(暂无IOS量)
string imei = 2;  // 必填!
string imsi = 3;  // 必填!
string user_ip=4; //必填!必须是客户端IP
string mac=5; //必填!MAC地址
int nettype=6; //必填!网络类型(UNKNOWN=0,WIFI=1,2G=2,3G=3,4G=4,Ethenet=5)
string province=7;//推荐填写!省份
string carrier=8;//必填!运营商(1:移动 2:联通 3:电信)
string serise=9;//必填!设备型号
string brand=10;//必填!设备品牌
string idfa=11;//IOS量必填!
参数 类型
Body dpid Object string
Body imei Object string
Body imsi Object string
Body user_ip Object string
Body mac Object string
Body nettype Object int
Body province Object string
Body carrier Object string
Body serise Object string
Body brand Object string
Body idfa Object string

(5)广告位信息

string adtype=1;//必填!广告类型(通用=0;横幅=1;开屏=2;插屏=3;信息流=4;焦点图=5;通知栏=6;视频=7)
string adwidth=2;//必填!广告位宽度
string adheight=3;//必填!广告位高度
string clicktype=4;//选填 广告资源类型(0:应用下载,1:浏览器跳转,2:片段广告)
参数 类型
Body adtype Object string
Body adwidth Object string
Body adheight Object string
Body clicktype Object string

(6)用户信息

string gmuid=1;//必填!用户id (生成规则:JS流量:用户唯一标识(CookieID)MD5加密;其他流量:(imei+dpid)MD5加密)
string mwh=2;
参数 类型
Body gmuid Object string
Body mwh Object string

2.2 XianGuoResponse

(1)XianGuoResponse是发送给流量合作方回写数据的顶层对象。对象包含所有信息 例如:广告物料信息,状态码,错误信息

(2)XianGuoResponse 对象

int code = 1;  //状态码 
string msg= 2;//错误信息
Adinfo adInfo=3;//广告物料信息
参数 类型
Body code Object int
Body msg Object string
Body adInfo Object Adinfo

(3)Adinfo 对象

string adurl = 1;  //落地页 
string title= 2;//标题
string content=3;//描述
string src=4;//图片地址
string clicktype=4;// 广告资源类型(0:应用下载,1:浏览器跳转,2:片段广告)
string icon=5;//图标icon
string pname=6;//广告名
string packagename=7;//包名
string adlibid=8;//广告位id
string fs=9;//包大小
string imgSize=10;//物料尺寸
string crid=11;//创意id
string crAdid=12;//广告id
string dsp_AppCat=13;//二级分类id
ArrayList showurl = 14;  // 曝光上报日志URL列表,用户曝光后,通知服务器。
ArrayList clickurl = 15;  // 点击上报URL列表,用户点击后,通知服务器。
ArrayList downurl = 16;  // 下载完成上报URL列表,用户下载完成后,通知服务器。
ArrayList insturl = 17;  // 安装完成上报URL列表,用户安装完成后,通知服务器。
参数 类型
Body adurl Object string
Body title Object string
Body content Object string
Body src Object string
Body clicktype Object string
Body icon Object string
Body pname Object string
Body packagename Object string
Body adlibid Object string
Body fs Object string
Body imgSize Object string
Body crid Object string
Body crAdid Object string
Body dsp_AppCat Object string
Body showurl Object ArrayList
Body clickurl Object ArrayList
Body downurl Object ArrayList
Body insturl Object ArrayList

3 错误码详情

JSON状态码 解释
200 正常返回
400 无广告返回
500 参数错误