注意:
- 由于系统之间的同步机制,通过AdX界面查询到的广告创意审核状态,与API查询结果可能不同。必须API同步到审核通过的素材,才可用于投放。
创意素材(包括但不限于视频素材)大小限制150M,ADX拉取素材(dsp提供的file_url)时间限制在90秒,超过90秒未拉取完整素材会提示601错误, dsp需要保证素材url所在的CDN服务器的出口带宽,建议出口带宽最低限速在3MB/s以上。 - 接口开发时,可登录ADX平台,在“运营工具”页面使用“API测试工具”自助联调;联调后,可直接在ADX的线上环境做提交创意测试,但必须使用广告主“合约广告测试专用_品牌(9699840)”,且确保测试用的非正式创意,不会用于线上流量投放。(广告主需要同步到DSP账号后才能使用)
DSP通过该系列API进行广告创意的相关工作,包括新建、修改、查询、获取创意数量、更新有效期、创意下线。
PDB/PD接口说明:
- 在广告主下上传广告创意,审核通过的素材才能用来实时回复流量请求,否则系统将报错。
- 由于腾讯广告平台对于每个广告主下的创意总量有限制,因此ADX平台也需限制DSP提交的创意上限。详见:【通知】腾讯PDB/PD广告创意使用规范变更https://docs.qq.com/doc/DVXJwQnZySlZIbkh2?u=22225ec704d64c8f946fc3a3b76ff198
RTB:若广告主未审核通过,则无法上传广告创意。
1.创建
接口:adcreative/add
请求字段:
名称 | 类型 | 描述 |
---|---|---|
data | 数组类型 | 最多10个 |
data内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
dsp_order_id | string | Y | 广告创意素材id,dsp需保证该id在dsp测的唯一性 |
advertiser_id | int | Y | 广告主id 和 name 二选一,都传的话优先使用id |
advertiser_name | string | Y | 同上 |
display_id | int | Y | 广告形式id |
end_date | string | N | 有效期,最长可设90天,示例:2022-05-19 (建议按实际投放需要填写,在线时间过长将持续占用创意额度;如不填写,默认设为90天) |
targeting_url | string | Y | 落地页,支持302 |
no_click | string | N | (仅支持白名单客户填充) 禁止点击:当前仅支持no_click=Y,不传该字段表示默认可点击; 当值为Y时,点击监测链接和落地页链接均需要为空 |
ldp_demo_url | string | N | 落地页截图,仅针对优投客户(落地页在推广日期之前不能打开的情况) |
is_only_pd | int | N | 是否只投放PD (默认为0:否,1:是,即只能投放PD) |
monitor_url | 数组类型 | N | 曝光监测地址,最多5个 |
monitor_position | 数组类型 | N | 在设置了monitor_url的情况下配合使用。仅针对视频贴片素材,监测请求位置 (该字段的填充值仅支持0,如需要自定义其他上报时机,请联系销售走白名单申请流程) |
monitor_settle_bill | 数组类型 | N | 在设置了monitor_url的情况下配合使用。(仅支持PDB) |
visible_monitor_url | 数组类型 | N | 可见曝光监测地址(仅支持新闻app信息流) |
click_monitor_url | 数组类型 | N | 点击监测地址,最多3个 |
video_monitor_by _time_url | 数组类型 | N | 仅针对 信息流视频监测地址 video_monitor_by _time_url ,对象数组 (仅PDB、PD支持使用,RTB不支持) |
ad_content | 数组类型 | Y | 创意素材内容,包括视频、图片、文本等。需严格按照广告形式的定义顺序来指定上传 |
ad_ext | 对象类型 | N | 高级扩展参数。详见下面请求示例 |
ad_ext2 | 对象类型 | N | 高级扩展参数2。详见下面请求示例 |
mini_program_id | string | N | 小程序id 长度(字节):最小1,最大512 可以为空 |
mini_program_path | string | N | 小程序路径 长度(字节):最小1,最大2048 可以为空 |
video_monitor_by_time_url内容详细:
名称 | 类型 | 必填 | 描述 |
url | string | Y | 监测链接,最多5个 |
time | int | Y | 上报时间点(秒) |
ad_content内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
file_text | string | Y | file_text,file_url 必须指定其中一个,按照广告形式id的定义校验,文件大小,类型,尺寸 |
file_url | string | Y | 同上 |
file_md5 | string | N | 仅针对视频文件,如果指定了md5值,其它两项就不再需要传了。 |
说明:
file_md5 字段仅针对视频文件,如果传入了该参数,则先查找该md5值的素材以前是否传入过adx系统,如果已经传入过则直接使用该文件,不在拉取素材,节省了网络传输流量和时间。
ad_ext内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
app_info | 对象类型 | N | app下载唤起特性 |
universal_link | string | N | 仅支持XQ系流量;广告点击后,优先触发ulink,其次是deeplink,最后触发“推广目标”(即product_type中设置的目标) |
share_info | 对象类型 | N | 分享特性 |
app_info内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
product_type | int | Y | 枚举说明: 1-普通链接(仅支持1) |
deep_link | string | N | 应用直达URL(deep_link包名必须与下单时设置的一致) |
应用直达及跳转小程序说明:
- 应用直达:通过deeplink、ulink字段唤起app,使用该字段时,①必须确认媒体下单时已设置了允许使用使用直达;② 素材上也需要填写该字段;③ deeplink链接对应的包名,必须与下单时填写的一致。
- 跳转小程序:通过mini_program_id、mini_program_path字段唤起微信小程序,使用该字段时,① 必须确认媒体下单时已设置了允许使用小程序;② 素材上填写的小程序id,必须与下单时保持一致。
share_info内容详细:
名称 | 类型 | 必填 | 描述 |
description | string | Y | 分享文案,4-28汉字 |
image | string | Y | 分享配图, 图片的URL,尺寸114*114, jpg 格式 |
ad_ext2内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
feed_card | 数组类型 | N | 信息流轮卡片播放形式专用 |
feed_card内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
targeting_url | string | N | 轮播卡片targeting_url(H5落地页链接) |
mini_program_path | string | N | 轮播卡片mini_program_path(小程序页面链接) |
deep_link | string | N | 轮播卡片deeplink(应用直达链接) |
universal_link | string | N | 轮播卡片universal_link(Ulink通用链接) |
接口返回:
名称 | 类型 | 描述 |
---|---|---|
ret_code | int | 返回码 |
ret_msg | 数组类型 | 返回内容 |
error_code | int | 错误补充码 |
ret_msg内容详细:
名称 | 类型 | 描述 |
---|---|---|
dsp_order_id | string | dsp唯一订单号 |
err_code | int | 需要时返回,成功时不返回,失败返回具体错误码。 |
err_msg | string | 需要时返回,成功时不返回,错误具体描述 |
请求示例:
{
"data":[
{
"dsp_order_id":"6001",
"advertiser_id":100,
"display_id":10389,
"targeting_url":"http://xinwen.qq.com/adtargetpage?a=1",
"is_only_pd":1,
"monitor_url":[
"http://monitor.qq.com/monitor1",
"http://monitor.qq.com/monitor2"
],
"monitor_position":[
2,
5
],
"monitor_settle_bill":[
1,
0
],
"click_monitor_url":[
"http://click.qq.com/click1"
],
"video_monitor_by_time_url":[
{
"url":"http://tytx.m.cn.miaozhen.com/r/",
"time":"0"
},
{
"url":"http://t.cr-nielsen.com/dar?_t=r",
"time":"0"
}],
"ad_content":[
{
"file_text":"广告标题 t"
},
{
"file_url":"http://cdn.qq.com/pic640x246.jpg"
},
{
"file_url":"http://cdn.qq.com/pic114x114.jpg"
},
{
"file_text":"摘要 c"
},
{
"file_text":"广告主名称 a"
}
],
"ad_ext":{
"app_info":{
"product_type": 3,
"app_id": 989673964
}
},
"mini_program_id": "gh_abcdef",
"mini_program_path": "abcdef"
}
]
}
注:
ad_ext 高级扩展参数目前仅支持app_info,如需使用请注意参数key值,evokeapp已废弃不再使用。
SDK客户端会对deeplink地址进行有效性校验,无效的话会自动转成非唤起的广告形式,打开落地页。
PDB/PD模式新增参数 is_only_pd,说明:是否只投放PD (默认为0:否,1:是,即只能投放PD)。
PDB模式新增参数 monitor_settle_bill 对应 monitor_url 参数设置指定哪条曝光监测地址是用于第三方结算的,用于结算的会进行monitor_url的强校验。
对于PDB必须指定一条用于结算的第三方监测url。
例如: monitor_url 指定了2条 [“http://a.com”,”http://b.com“], 如果要设置a.com是用于结算第三方监测url, 那么 monitor_settle_bill 应设置为 [1,0]
返回示例(成功):
{
"ret_code":0,
"ret_msg":[
{
"dsp_order_id":"6001",
}
]
}
返回示例(失败):
{
"ret_code":1,
"ret_msg":[
{
"dsp_order_id":"6001",
"err_code":1107,
"err_msg":"either file_url/file_text was needed."
}
]
}