跳到主要内容

品牌排期资源相关 API

功能描述:GPB 品牌 DSP 可获取下单执行计划、deal_id 清单、定向条件等信息,并可通过接口配置 deal_id 状态。包括执行计划查询接口和执行计划资源 deal_id 设置接口。

1. 执行计划查询​

接口:adproposal/list

请求字段:

名称类型描述
pageint可以为空,默认值1
sizeint可以为空,默认值10,最大20
data数组类型可以为空,不为空则优先使用 data 参数,忽略 page,size 参数,最多20个

data 内容详细:

名称类型必填描述
pro_codestringY执行计划 code

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
pro_codestring执行计划 code
pro_namestring执行计划 名称
agentstring代理名称
advertiserstring广告主名称
brand_productstring品牌产品名称
begin_datestring开始时间
end_datestring结束时间
is_compensateint投放目的,是否补量;取值0:不是补量排期, 1:补量排期
main_pro_codestring如果是补量排期才有该值,代表补量的原排期 code
deal_data数组类型Dealid 清单列表

deal_data 内容详细:

名称类型描述
deal_idint计划资源ID
deal_namestring计划资源名称
location_idstring广告位ID
location_namestring广告位名称
display_idint广告形式ID
display_namestring广告形式名称
schedulestring投放日程
price_modestring计价模式(CPM/CPD)
gpb_factorstringGPB 推送倍数
target_infostring定向条件(只开放地区,平台维度查询)
deal_statusint配置状态,取值0:配置未完成 1:配置完成。

请求示例:

品牌资源请求示例

返回示例:

品牌资源返回示例

注意: 这里如果没有默认指定 data 里的 pro_code 参数,则取当前在投放中和即将投放的排期计划(即 end_date 大于等于当天日期)。

2. 执行计划资源 deal_id 设置​

接口:adproposal/setdeal

请求字段:

名称类型必填描述
data数组类型Y最多20个

data 内容详细:

名称类型必填描述
pro_codestringY执行计划 code(deal_id 和 pro_code 二选一,两者都传优先使用 pro_code)
deal_idintY计划资源ID,从排期资源 API 或邮件中获取。(deal_id 和 pro_code 二选一,两者都传优先使用 pro_code)
setintY设置配置完成状态,取值0:配置未完成 1:配置完成。默认为0。

接口返回:

名称类型描述
ret_codeint返回码
ret_msg数组类型返回内容
error_codeint错误补充码

ret_msg 内容详细:

名称类型描述
deal_idint
err_codeint需要时返回
err_msgstring需要时返回

请求示例:

执行计划资源 deal_id 设置请求示例

返回示例(成功):

执行计划资源 deal_id 设置返回示例(成功)

返回示例(失败):

执行计划资源 deal_id 设置返回示例(失败)

注意: 已配置完成的 deal_id 如果腾讯侧已开始放量,不可以再设置成【0:配置未完成】状态。