竞价请求
上一页 第 4 章 RTB协议 下一页

竞价请求

对象层次

对象定义

Bid Request Object

FieldScopeTypeDescription
idrequiredstring竞价ID
imprequiredarray of object参见“Impression Object”一节
siteoptionalobject参见“Site Object”一节
appoptionalobject参见“App Object”一节
deviceoptionalobject参见“Device Object”一节
useroptionalobject参见“User Object”一节
atoptionalinteger竞价类型

  • 1:first price auction

  • 2:second price auction

curoptionalarray of string货币编码，参见ISO 4217标准
bcatoptionalarray of string屏蔽的行业，参见 https://developers.google.com/adwords/api/docs/appendix/productsservices
badvoptionalarray of string屏蔽的广告主，例如：www.company.com
testoptionalinteger是否为测试模式

  • 0:live mode

  • 1:test mode

extoptionalobject扩展字段 参见 “Extension Object”一节

Extension Object

FieldScopeTypeDescription
reqidoptionalstring唯一的请求id
hybridoptionalint竞价类型:0 普通竞价；1 混合竞价

Impression Object

FieldScopeTypeDescription
idrequiredstring广告位ID
bannerrequired for banner impressionobject参见“Banner Object”一节
videorequired for video impressionobject参见“Video Object”一节
nativerequired for native impressionobject参见“Native Object”一节
bidflooroptionalfloat底价，单位为分/CPM
bidfloorcuroptionalstring货币编码，参见ISO 4217标准
pmpoptionalobject参见“PMP Object”一节
secureoptionalinteger标识该曝光需要 https url 的广告素材 和曝光监控; 0=不需 要 https 广告, 2=需要 https 广告

Banner Object

FieldScopeTypeDescription
wrequiredinteger广告位的宽度，单位为像素
hrequiredinteger广告位的高度，单位为像素
posoptionalinteger广告位位置

  • 0:unknown

  • 1:above the fold

  • 3:below the fold

extoptionalobject参见“Extension Object”一节
Extension Object
FieldScopeTypeDescription
typeoptionalstring参见附录 A, 广告位类型
numoptionalinteger需要的广告数目

Video Object

FieldScopeTypeDescription
mindurationrequiredinteger广告的最小时长，单位为秒，小于等于0表示不限制
maxdurationrequiredinteger广告的最大时长，单位为秒，小于等于0表示不限制
linearityrequiredinteger是否为linear

  • 1:linear/in-stream

  • 2:non-linear/overlay

mimesrequiredarray of string支持的MIME类型 video/x-flv
protocolsrequiredarray of integer支持的VAST协议

  • 3:VAST 3.0

  • 6:VAST 3.0 Wrapper

woptionalinteger播放器的宽度，单位为像素
hoptionalinteger播放器的高度，单位为像素
minbitrateoptionalinteger广告的最小码率，单位为kbps
maxbitrateoptionalinteger广告的最大码率，单位为kpbs

Native Object

FieldScopeTypeDescription
requestrequiredstring参见“广告位说明”一节
verrequiredstring原生广告规范的版本号

PMP Object

FieldScopeTypeDescription
private_auctionoptionalinteger竞价范围

  • 0:all bids are accepted

  • 1:bids are restricted to the deals specified and the terms thereof

dealsoptionalarray of object参见“Direct Deal Object”一节

Direct Deal Object

FieldScopeTypeDescription
idrequiredstringdirect deal ID
bidflooroptionalfloat底价，单位为分/CPM
bidfloorcuroptionalstring货币编码，参见ISO 4217标准
atoptionalinteger竞价类型

  • 1:first price auction

  • 2:second price auction

  • 3:fixed price deal

Site Object

FieldScopeTypeDescription
pageoptionalstring页面URL
mobileoptionalinteger是否为mobile

  • 0:no

  • 1:yes

contentoptionalobject参见“Content Object”一节
nameoptionalstring网站名称，新浪网的流量name为“sina”
domainoptionalstring网站域名

  • 1.新浪PC：sina.com

  • 2.新浪wap：sina.cn

App Object

FieldScopeTypeDescription
nameoptionalstring应用名称

  • iOS:app store id

  • Android:fullyqualified package name

bundleoptionalstringA platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it is a numeric ID.
catoptionalstring应用分类，参见 https://developers.google.com/adwords/api/docs/appendix/mobileappcategories
veroptionalstring应用版本号
contentoptionalobject参见“Content Object”一节

Content Object

FieldScopeTypeDescription
lenoptionalinteger内容长度，如视频长度，单位为秒
urloptionalstring内容url
extoptionalobject参见“Extension Object”一节
Extension Object
FieldScopeTypeDescription
channeloptionalstring参见附录 B, 频道编码

Device Object

FieldScopeTypeDescription
ipoptionalstringIP地址
geooptionalobject参见“Geo Object”一节
uaoptionalstring浏览器的user agent
makeoptionalstring设备品牌，例如：Apple, Samsung
modeloptionalstring设备型号，例如：iPhone 5S, Galaxy S4
osoptionalstring操作系统，例如：iOS, Android
osvoptionalstring操作系统版本，例如：7.1, 4.4.3
devicetypeoptionalinteger设备类型

  • 0:unknown

  • 4:phone

  • 5:tablet

connectiontypeoptionalinteger网络连接类型

  • 0:unknown

  • 2:WIFI

  • 4:cellular network-2G

  • 5:cellular network-3G

  • 6:cellular network-4G

  • 7:cellular network-5G

carrieroptionalstring运营商，参见 https://developers.google.com/adwords/api/docs/appendix/mobilecarriers

Geo Object

FieldScopeTypeDescription
latoptionalfloat纬度，-90 ~ 90，南纬为负
lonoptionalfloat经度，-180 ~ 180，西经为负
regionoptionalstring地域编码，参见 附录中的地域编码

User Object

FieldScopeTypeDescription
idoptionalstring用户ID，site广告为新浪cookie ID，app广告为设备ID（Android 设备，id为IMEI；IOS设备，id为idfa），先做MD5加密,再做BASE64加密
dataoptionalarray of object参见“Data Object”一节
extoptionalobject参见“Ext Object”一节

Ext Object

FieldScopeTypeDescription
cidoptionalstringPC和WAP的cookie id
didoptionalstringios客户端根据某种算法生成的ID,唯一性较好，存储在钥匙串中，android客户端根据老算法生成的ID，某些情况下有较多重复
uidoptionalstring微博uid
idfaoptionalstring苹果手机广告标志符,明文
idfvoptionalstring苹果手机identifierForVendor
imeioptionalstringAndroid imei的md5值
aidoptionalstring通行证根据某种算法生成的ID，用于与新浪/微博系的其他APP的数据互通
ldidoptionalstringandroid客户端根据新算法生成的ID，唯一性较好，存储在app私有目录和sd卡特定目录
oaidoptionalstringAndroid 10 版本及以上的手机广告标志符，明文
caidoptionalstringios设备的根据广协算法得到的caid的值，明文

Data Object

FieldScopeTypeDescription
nameoptionalstring数据源名称
segmentoptionalarray of object参见“Segment Object”一节

Segment Object

FieldScopeTypeDescription
nameoptionalstring字段名称
valueoptionalstring字段取值