功能描述:GPB品牌dsp可获取下单执行计划,dealid清单,定向条件等信息。
并可通过接口配置dealid状态。
包括执行计划查询接口,执行计划资源dealid设置接口。
1.执行计划查询
接口:adproposal/list
请求字段:
名称 | 类型 | 描述 |
---|---|---|
page | int | 可以为空,默认值1 |
size | int | 可以为空,默认值10,最大20 |
data | 数组类型 | 可以为空,不为空则优先使用data参数,忽略page,size参数,最多20个 |
data内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
pro_code | string | Y | 执行计划code |
接口返回:
名称 | 类型 | 描述 |
---|---|---|
ret_code | int | 返回码 |
ret_msg | 数组类型 | 返回内容 |
error_code | int | 错误补充码 |
ret_msg内容详细:
名称 | 类型 | 描述 |
---|---|---|
pro_code | string | 执行计划code |
pro_name | string | 执行计划 名称 |
agent | string | 代理名称 |
advertiser | string | 广告主名称 |
brand_product | string | 品牌产品名称 |
begin_date | string | 开始时间 |
end_date | string | 结束时间 |
is_compensate | int | 投放目的,是否补量;取值0:不是补量排期, 1:补量排期 |
main_pro_code | string | 如果是补量排期才有该值,代表补量的原排期code |
deal_data | 数组类型 | Dealid清单列表 |
deal_data 内容详细:
名称 | 类型 | 描述 |
---|---|---|
deal_id | int | 计划资源id |
deal_name | string | 计划资源名称 |
location_id | string | 广告位id |
location_name | string | 广告位名称 |
display_id | int | 广告形式id |
display_name | string | 广告形式名称 |
schedule | string | 投放日程 |
price_mode | string | 计价模式(CPM/CPD) |
gpb_factor | string | GPB推送倍数 |
target_info | string | 定向条件(只开放地区,平台维度查询) |
deal_status | int | 配置状态,取值0:配置未完成 1:配置完成。 |
请求示例:
返回示例:
注意: 这里如果默认没有指定data里pro_code参数的话,取当前在投放中和即将投放的排期计划(即end_date大于等于当天日期)。
2.执行计划资源dealid设置
接口:adproposal/setdeal
请求字段:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
data | 数组类型 | Y | 最多20个 |
data内容详细:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
pro_code | string | Y | 执行计划code(deal_id和pro_code二选一,两者都传优先使用pro_code) |
deal_id | int | Y | 计划资源id,从排期资源API或邮件中获取。(deal_id和pro_code二选一,两者都传优先使用pro_code) |
set | int | Y | 设置配置完成状态,取值0:配置未完成 1:配置完成。默认为0。 |
接口返回:
名称 | 类型 | 描述 |
---|---|---|
ret_code | int | 返回码 |
ret_msg | 数组类型 | 返回内容 |
error_code | int | 错误补充码 |
ret_msg内容详细:
名称 | 类型 | 描述 |
---|---|---|
deal_id | int | |
err_code | int | 需要时返回 |
err_msg | string | 需要时返回 |
请求示例:
返回示例(成功):
返回示例(失败):
注意:已配置完成的dealid如果腾讯侧已开始放量,dealid不可以再设置成【0:配置未完成】的状态。