广告流量通过此文档的接口协议向Taku DSP发送实时竞价请求,并获取竞价结果。Taku DSP接口协议基于OpenRTB 2.5进行的拓展。
注意:Taku DSP仅支持一价结算,单位默认为人民币元。
请求方式:
post/application/json
请求入参
字段
|
数据类型
|
是否必须
|
备注
|
---|---|---|---|
id | string | 是 | 本次请求id,用于跟踪 |
tmax | int | 是 | 超时时间 |
app | app | 是 | app信息,具体信息见app对象 |
imp | imp[] | 是 | 素材限制,具体格式见imp对象 |
device | device | 是 | 设备信息 |
test | int | 否 |
1:测试模式,0:正式模式。默认为正式模式 |
app
字段
|
数据类型
|
是否必须
|
备注
|
---|---|---|---|
id | string | 是 |
应用id |
ver | string | 否 | 应用版本 |
bundle | string | 是 | 包名 |
name | string | 否 | 应用名称 |
device
字段
|
数据类型
|
是否必须
|
备注
|
---|---|---|---|
ip | string | 是 | |
ua | string | 是 | |
os | string | 是 | iOS,Android |
osv | string | 是 | 系统版本 |
language | string | 否 | 系统语言 |
devicetype | int | 是 |
Mobile:1, Personal Computer:2,CTV:3 Phone:4,Tablet:5,Unknown:0 |
make | string | 是 | 品牌 |
model | string | 是 | 型号 |
h | int | 是 | 设备高 |
w | int | 是 | 设备宽 |
carrier | string | 运营商名称 | |
connectiontype | int | 是 |
Unknown:0, Ethernet:1, Wifi:2, 2G:4 3G:5, 4G:6, 5G:7
|
ifa | string | 是。device_ext_common下的oaid、gaid、did、dpid或device.ifa存在一个即可 |
ios时该字段值等于idfa 安卓时该字段值等于gaid 若字段重复,优先取device_ext_common的设备值 |
mccmnc | string | 否 | mmcmnc,例:460-09 |
ext | device_ext | 否 |
device_ext
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
common | device_ext_common | 否 | 此字段为字符串,即json格式 encode后的 |
adtype | int | 是,若tagid为taku 提供的id则可不传 | 0 原生 1 激励视频 2 banner 3 插屏 4 开屏 |
device_ext_common
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
sys_boot_time | string | 否 | 系统启动时间,毫秒 |
sys_up_ts | string | 否 | 系统更新时间戳,精确到毫秒,仅 iOS 流量传,示例:1600326333.862857 |
birth_time | string | 否 | 设备初始化时间 |
app_list | string[] | 否 | 已安装应用包名列表,需要转化成Taku的id形式。具体id请联系Taku运营 |
wx_applet | string | 否 | 微信小程序,1:不支持,2:支持 |
quick_app | string | 否 | 快应用,1:不支持,2:支持 |
firm | string | 否 |
厂商商店, 枚举值:huawei,xiaomi,vivo,oppo,honor, |
firm_version | string | 否 | 厂商商店版本 |
hms_version | string | 否 | HMS Core 版本号 |
boot_mark | string | 否 | 系统启动标识 |
update_mark | string | 否 | 系统更新标识 |
oaid | string | 是。device_ext_common下的oaid、gaid、did、dpid或device.ifa存在一个即可 | |
gaid | string | 是。device_ext_common下的oaid、gaid、did、dpid或device.ifa存在一个即可 | |
did | string | 是。device_ext_common下的oaid、gaid、did、dpid或device.ifa存在一个即可 | 明文imei |
dpid | string | 是。device_ext_common下的oaid、gaid、did、dpid或device.ifa存在一个即可 | 明文,ios为idfv,安卓为AndroidID |
caid_list | caid_info[] | 否 |
iOS 广协 caid 列表,若存在多个版本的 caid,则全部传送,示例: [ |
device_name |
string | 否 | 用户设备设置的名称 |
mem_total |
int64 | 否 |
内存容量(单位byte),如2983313408
|
disk_total |
int64 | 否 |
硬盘容量(单位byte),如63944380416
|
paid |
string | 否 |
参数齐全时,根据拼多多归因文档 v1.4 生成的 paid ,示例: 73581fadfdc25fe02a206f7b51939bbe-85c0b7ec2bc816fddf08bad447dbb804-
f4c7ea2d7a4567fee395567d9ae80917
|
imp
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
id | string | 是 | 本次请求的imp_id,用于跟踪 |
tagid
|
string | 是 |
广告位id。必填。由taku分配。 若不传taku 分配的id,默认会根据imp.ext.adtype进行分配。 |
bidfloor | float64 | 否 | 底价,单位为元 |
native | native | 三个对象必须传一个 | 图片素材 |
video | video | 视频素材,遵守vast协议 | |
banner | banner | 横幅广告,遵守mraid协议 |
native
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
request | string | 是 | 素材要求,填充nativeBidRequest的json-string |
ver | string | 是 | native版本,固定1.1 |
nativeBIdRequest
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
native | nativeRequest | 是 |
nativeRequest
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
assets | nativeRequestAssets[] | 是 | 素材限制 |
nativeRequestAssets
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
id | int | 是 | 素材类型约束顺序值 |
required | int | 是 | 是否必须 |
title | nativeRequestAssetsTitle | 是 | 一个asset填一个对象 |
img | nativeRequestAssetsImg | 是 | |
data | nativeRequestAssetsData | 是 |
nativeRequestAssetsTitle
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
len | int | 是 | 标题字符长度 |
nativeRequestAssetsImg
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
type | ImageAssetType | 是 |
图片类型 |
w | int | 是 | 图片宽度 |
h | int | 是 | 图片高度 |
wmin | int | 否 | 图片最小宽度 |
hmin | int | 否 | 图片最小高度 |
nativeRequestAssetsData
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
type | DataAssetType | 是 |
资源类型 |
len | int | 是 | 约束字符长度 |
video
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
mimes | string[] | 是 | 枚举值:video/mp4,video/ogg,video/webm |
minbitrate | int | 是 | 最小视频倒计时 |
maxbitrate | int | 是 | 最大视频倒计时 |
protocols | Protocol[] | 是 | 支持的vast版本 |
w | int | 是 | 视频宽度 |
h | int | 是 | 视频高度 |
响应参数
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
id | string | 是 | 本次请求id,用于日志跟踪 |
seatbid | BidResponseSeatBid[] | 是 | 素材内容 |
bidid | string | 是 | 本次bidid,用于日志跟踪 |
cur | string | 是 | 币种 |
BidResponseSeatBid
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
bid | BidResponseSeatBidBid[] | 是 | 素材内容 |
BidResponseSeatBidBid
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
id | string | 是 | bid |
impid | string | 是 | 素材限制impid |
price | float64 | 是 | 出价 |
nurl | string | 否 | 竟胜上报 |
lurl | string | 否 | 竞败上报 |
adm | string | 是 |
素材内容,根据样式类型解析,分为native,video,banner |
adomain | string[] | 否 | 域名 |
cid | string | 否 | 创意id |
crid | string | 否 | 素材id |
exp | int | 否 | 素材有效期 |
ext | BidResponseSeatBidBidExt | 否 |
adm-native
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
native | nativeResponse | 是 |
nativeResponse
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
assets | nativeResponseAssets[] | 是 | 素材内容 |
link | nativeResponseLink | 是 | 目的链接 |
imptrackers | string[] | 是 | 展示上报 |
nativeResponseAssets
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
id | int | 是 | 素材类型约束顺序值 |
required | int | 是 | 是否必须 |
title | nativeResponseAssetsTitle | 是 | |
img | nativeResponseAssetsImg | 是 | |
data | nativeResponseAssetsData | 是 |
nativeResponseAssetsTitle
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
text | string | 是 | 标题 |
len | int | 否 | 标题字符长度 |
nativeResponseAssetsImg
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
type | ImageAssetType | 是 |
图片类型,具体取值见ImageAssetType枚举值说明 |
w | int | 是 | 图片宽度 |
h | int | 是 | 图片高度 |
url | string | 是 | 图片地址 |
nativeResponseAssetsData
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
type | DataAssetType | 是 |
资源类型,具体取值见DataAssetType枚举值说明 |
len | int | 是 | 约束字符长度 |
value | string | 是 | 文案 |
nativeResponseLink
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
url | string | 否 | 落地页 |
clicktrackers | string[] | 是 | 点击上报 |
fallback | string | 否 | deeplink唤起链接。建议采用拓展字段的deeplink字段。详细说明见BidResponseSeatBidBidExt.deeplink |
Taku DSP需要流量方对链接中的宏参数进行替换。宏参数定义见宏替换说明
BidResponseSeatBidBidExt
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
deeplink |
string | 否 | 唤起链接 |
common_cn |
BidResponseSeatBidBidExtCommoncn | 否 |
BidResponseSeatBidBidExtCommoncn
字段
|
数据类型
|
是否必传
|
备注
|
---|---|---|---|
dp_start |
string[] | 否 | 尝试拉起app |
dp_succ |
string[] | 否 | 拉起app成功 |
dp_uninst_fail |
string[] | 否 | app未安装拉起失败 |
dp_inst_fail |
string[] | 否 | app已安装拉起失败 |
app_install |
string[] | 否 | 应用已安装 |
app_uninstall |
string[] | 否 | 应用未安装 |
app_unknow |
string[] | 否 | 无法获取应用安装信息 |
apk_dl_star |
string[] | 否 | apk下载开始 |
apk_dl_end |
string[] | 否 | apk下载结束 |
apk_install |
string[] | 否 | apk安装完成 |
apk_start_install |
string[] | 否 | apk开始安装 |
apk_active |
string[] | 否 | apk安装完成并打开应用 |
wx_username |
string | 否 | |
wx_path |
string | 否 | |
app_developer |
string | 否 | 下载类必传,应用信息明示-开发者 |
app_privacy |
string | 否 | 下载类必传,应用信息明示-隐私协议 |
app_permissions |
string | 否 | 下载类必传,应用信息明示-所需权限 |
app_name |
string | 否 | 下载类必传,应用名称 |
app_desc |
string | 否 | 下载类必传,应用信息明示-产品功能介绍 |
app_version |
string | 否 | 下载类必传,应用信息明示-版本号 |
link_type |
int | 否 | 下载类必传,枚举:3-网页打开,4-apk下载 |
download_link |
string | 否 | 下载类必传,当link_type=4时,不可为空 |
枚举值
ImageAssetType
枚举值
|
备注
|
---|---|
0 | unkown |
1 | icon |
2 | logo |
3 | main(主图) |
DataAssetType
枚举值
|
备注
|
---|---|
0 | unkown |
2 | desc |
12 | cta |
Protocol
枚举值
|
备注
|
---|---|
0 | unkown |
1 | vast1.0 |
2 | vast2.0 |
3 | vast3.0 |
宏替换
支持监测场景
|
宏
|
含义
|
---|---|---|
竞胜竞败通知 | ${AUCTION_CURRENCY} | 价格货币宏 |
${AUCTION_PRICE} |
价格宏 | |
展示监测上报 |
{__SHOW_T__}
|
本次广告展示持续时长
|
{__M_SHOW_RATIO__}
|
本次广告展示出来的最大比例
|
|
{__S_SCREEN_X__}
|
广告视图左上角相对屏幕原点横坐标,整数,单位为像素 (px)
|
|
{__S_SCREEN_Y__}
|
广告视图左上角相对屏幕原点纵坐标,整数,单位为像素 (px)
|
|
{__WIDTH__} |
实际广告视图的宽,单位为像素(px)
|
|
{__HEIGHT__} |
实际广告视图的高,单位为像素(px)
|
|
{__TS_MSEC__}
|
曝光事件发生的时间戳(毫秒)
|
|
点击监测上报 |
{__SLD__}
|
触发点击的交互方式(第一套)
0 - 常规触屏点击;
1 - 滑动点击,广告上有引导用户进行 滑动以触发点击;
2 - 摇一摇,需要替换加速度;
5 - 扭一扭或倾斜,需要替换角度;
6 - 擦除;
可获取到点击相关坐标,则正常上报;
当无法获取到点击相关坐标,以及触发点击的方式为摇一摇,扭一扭等触发,相关点击坐标宏参数值:替换为 -999;
|
{__DOWN_X__} | 用户手指按下时的全局横坐标。屏幕左上角为(0,0)像素点单位 | |
{__DOWN_Y__} | 用户手指按下时的全局纵坐标。屏幕左上角为(0,0)像素点单位 | |
{__UP_X__} |
用户手指离开设备屏幕时的全局横坐标。屏幕左上角为(0,0)像素点单位 | |
{__UP_Y__} | 用户手指离开设备屏幕时的全局纵坐标。屏幕左上角为(0,0)像素点单位 | |
{__RE_DOWN_X__} | 用户手指按下时的相对横坐标。相对于广告位的X坐标,即广告位左上角为(0,0)像素点单位 | |
{__RE_DOWN_Y__} | 用户手指按下时的相对纵坐标。相对于广告位的X坐标,即广告位左上角为(0,0)像素点单位 | |
{__RE_UP_X__} | 用户手指离开设备屏幕时的相对横坐标。相对于广告位的X坐标,即广告位左上角为(0,0)像素点单位 | |
{__RE_UP_Y__} | 用户手指离开设备屏幕时的相对纵坐标。相对于广告位的X坐标,即广告位左上角为(0,0)像素点单位 | |
{__C_SLD__}
|
触发点击交互方式(第二套)
0 - 常规触屏点击;
1 - 滑动点击,广告上有引导用户进行 滑动以触发点击;
2 - 摇一摇,需要替换加速度;
5 - 扭一扭或倾斜,需要替换角度;
6 - 擦除;
无法获取点击相关坐标时,点击相关坐标宏参数值:替换为 -999 ;
触发点击的方式为摇一摇,扭一扭等触发方式时,点击相关坐标宏参数:不替换; |
|
{__C_DOWN_X__}
|
用户手指按下时屏幕的绝对横坐标(第二套),单位为像素,原点(0,0)为设备屏幕左上角
|
|
{__C_DOWN_Y__}
|
用户手指按下屏幕时的绝对纵坐标(第二套),单位为像素,原点(0,0)为设备屏幕左上角
|
|
{__C_UP_X__}
|
用户手指离开屏幕时的绝对横坐标(第二套),单位为像素,原点(0,0)为设备屏幕左上角
|
|
{__C_UP_Y__}
|
用户手指离开屏幕时的绝对纵坐标(第二套),单位为像素,原点(0,0)为设备屏幕左上角
|
|
{__RE_C_DOWN_X__}
|
用户手指按下广告时的相对横坐标(第二套),单位为像素,原点(0,0)为广告容器左上角
|
|
{__RE_C_DOWN_Y__}
|
用户手指按下广告时的相对纵坐标(第二套),单位为像素,原点(0,0)为广告容器左上角
|
|
{__RE_C_UP_X__}
|
用户手指离开屏幕时的相对横坐标(第二套),单位为像素,原点(0,0)为广告容器左上角
|
|
{__RE_C_UP_Y__}
|
用户手指离开屏幕时的相对纵坐标(第二套),单位为像素,原点(0,0)为广告容器左上角
|
|
{__M_X_ACC__}
|
摇一摇触发点击时,X轴方向加速度峰值乘100取整,单位m/s2
|
|
{__M_Y_ACC__}
|
摇一摇触发点击时,Y轴方向加速度峰值乘100取整,单位m/s2
|
|
{__M_Z_ACC__}
|
摇一摇触发点击时,Z轴方向加速度峰值乘100取整,单位m/s2
|
|
{__TURN_X__}
|
扭动或前倾触发点击时的x轴扭动角度,取值为-180 到 180 的整数,单位 为:度(°)
|
|
{__TURN_Y__}
|
扭动或前倾触发点击时的y轴扭动角度,取值为-180 到 180 的整数,单位 为:度(°)
|
|
{__TURN_Z__}
|
扭动或前倾触发点击时的z轴扭动角 度,取值为-180 到 180 的整数,单位 为:度(°)
|
|
{__TURN_T__}
|
扭动触发点击的扭动时长,取整数,单位为毫秒(ms)
|
|
{__TS__}
|
事件发生的时间戳(秒)
|
|
{__TS_MSEC__}
|
事件发生的时间戳(毫秒),若为点击或滑动点击触发,则替换为点击(滑动)按下的时间戳(毫秒)
|
|
{__END_TS_MSEC__}
|
点击(滑动)事件触发时,点击(滑动)抬起的时间戳(毫秒)
|
例子、pb文件(暂时不支持pb,请用json)