API接入注意事项
[info]设备号传递
媒体在请求广告时,需要保证能将用户的设备号正确传递给东风引擎,
- iOS设备要求传递idfa(明文),
- 安卓设备要求传递明文imei或者imei md5加密后的值,imei加密前请将原始imei转大写,安卓Q版本以上要求传递明文oaid
- OTT设备要求传递明文mac地址或mac md5加密后的值,mac加密前请将原始mac转大写后去冒号后进行md5加密。
请求未填写设备号或者填写了错误的设备号,将影响广告精准投放的效果。
[info]开屏广告资源位尺寸
开屏广告请求需要填写资源位的尺寸,东风引擎会根据传入的尺寸返回合适的广告。在正式投放时东风运营同学会根据媒体素材规范进行配置,因此媒体需要确保请求所传尺寸在素材规范尺寸范围内,否则将无法返回广告。
[info]开屏广告资源位的实时请求与预加载
- 实时请求:如果媒体采用的是实时请求开屏广告,并且实时拉取素材并进行渲染,则请求广告时不填写
campaign_date
字段。- 预加载:如果媒体的开屏广告是采用预加载的方式,需要提前缓存广告素材的图片,请求广告时需要填写imp对象中
campaign_date
字段,表示请求哪一天的预加载广告。如果需要同时请求多天预加载的广告素材,Request对象中可以填充多个imp对象。
[info] 程序化监测链接下发数量
程序化投放时东风系统收到请求后会返回曝光监测、点击监测和素材点击链接
- 曝光监测数量:2条
- 点击监测数量:2条
- H5点击链接数量:1条
- Deeplink链接数量:1条
请媒体确保能够正确上报接口下发的全部监测,如有疑问请联系商务同学
[info]Universal Link 支持
- ULink(全称 Universal link)是苹果官方在 iOS9 版本开始支持的跳转方式,首 次跳转无需用户点击确认,也无需重定向,可以无障碍到达指定 app 指定页面。
- 如媒体默认支持 Universal Link 功能,需要联系运营同学对指定广告位进行配置 开启 ULink 功能。此后,方可在 Response 的 Ad 对象 click_through_url 字段中返回 ULink 地址,同时 open_type 值为 4,且不再返回 deeplink_url 地址。
[info]实时竞价
- 接入RTB流量可返回价格,参与媒体 ADX 的实时竞价。媒体需返回结算价格(一般为 GSP 二价结算)。
- Seat::Ad 结构中的 bid_price 字段为 Tanx 对媒体的报价,表示 Tanx 可接受的最 高 CPM 价格,单位:分。媒体的最终结算价格不能高于此价格。
- Seat::Ad 结构中的 winnotice_url 为 Tanx 的竞价成功监测地址,当 Tanx 在媒体 ADX 竞价成功时,媒体服务端立即通过此地址通知 Tanx,注意不能在客户端发送。 媒体通知 Tanx 前,需替换 url 中的宏占位符:
%%SETTLE_PRICE%%
; 当竞价不成功时,不需要通知。- 结算价格为 CPM 价格,单位:分,整数形式,不应高于 bid_price 竞价价格。 在 Tanx 返回的曝光监测和竞价通知的原始 URL 中均包含价格宏占位 符:
%%SETTLE_PRICE%%
,曝光监测在客户端真正曝光时由客户端发送,竞价通知在媒 体处竞价成功时由媒体服务端立即发送。 媒体对 Tanx 的结算价格加密后替换整个占位符%%SETTLE_PRICE%%
,若 URL 中包 含多个%%SETTLE_PRICE%%
,需支持多次替换。 结算价格解密后传输,加密规则为: urlsafe_base64(aes_128_ecb_encrypt(cpm_price 的字符串形式)),nopadding 加密所需的秘钥,向接入运营申请。 例:原始结算价格为:1200,步骤为:
- 转为字符串形式:”1200”
- tmp= aes_128_ecb_encrypt(“1200”)
- price= urlsafe_base64(tmp)