创建广告单元
需要携带 Token,详情看 Token
通过此接口可用于创建广告单元。广告单元需要与已创建成功的广告关联。
请求地址
https://ss-api.mintegral.com/api/open/v1/offer
请求方法
POST
请求示例
json
POST /api/open/v1/offer
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
"campaign_id": "25",
"offer_name": "cqf_testtttt",
"promote_timezone": 7,
"start_time": 1578455012,
"target_geo": "ALL",
"billing_type": "CPI",
"bid_rate": 5,
"daily_cap_type": "BUDGET",
"daily_cap": "50",
"total_budget": "50",
"settlement_event": "",
"os_version_min": "8.8",
"custom_ad_schedule": {"1":"0,1,23","2":"3,4,5","3":"3,6,5"},
"custom_ad_schedule_timezone": 0,
"network": "WIFI",
"target_ad_type": "BANNER",
"creatives_sets": [
{"creative_set_name":"demo1","geos":["ALL"],"ad_outputs":[111],"creatives":[{"creative_name":"material1","creative_md5":"c09d944dcf2d6ded1acd6eb2237f8bad"},{"creative_name":"icon_512x512","creative_md5":"5a42fed89d97cfe253c2f7b6be86f8ed"},{"creative_name":"1200x627","creative_md5":"ea5c9ca2f16cace9c133bb327e1c83dd"}]}
],
"target_device": "PHONE"
}
请求参数
字段 | 类型 | 说明 | 默认值 | 例子 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
campaign_id | int | 广告 ID | — | 1234 | ||||||||||
offer_name | string | 广告单元名称,唯一。只允许数字字母下划线,字符长度 3~95。 | "" | "offer_test" | ||||||||||
promote_timezone | number | 广告单元投放时间对应的时区。可选值:枚举值 - 时区 | "" | 5.5 | ||||||||||
start_time | int | 广告单元开始投放时间的时间戳,时间不早于 2000 年(时间戳为 946656000)。如果填写了 end_time 的话,start_time 必须小于 end_time。 | — | 1578455012 | ||||||||||
end_time 选填 | int | 广告单元结束投放时间的时间戳,必须晚于 start_time。 | 0 | 1578455169 | ||||||||||
target_geo | string | 广告单元投放的地区,全部地区则写 “ALL”,分地区用,分隔 | — | "CN" | ||||||||||
bid_type 已弃用 | string | 结算方式,可选值:枚举值 - 结算方式注:bid type 可选值受权限管控,若权限不足,接口会返回"Permission denied" ,请联系 AM 授权后再试操作 | "" | "CPC" | ||||||||||
billing_type | string | 结算方式,可选值:枚举值 - 结算方式注:bid type 可选值受权限管控,若权限不足,接口会返回"Permission denied" ,请联系 AM 授权后再试操作 | "" | "CPC" | ||||||||||
bid_goal billing_type为OCPI时必填 | string | 优化目标类型:Target-ROAS、Install、impression,与billing_type关系如下:
| Target-ROAS | |||||||||||
target_mtg_event | array<string> | 需要优化的目标 获取允许配置优化目标的事件 bid_goal为Target-ROAS,必填,支持多选 | ["Ad Revenue", "Purchase"] | |||||||||||
target_goal_window bid_goal为Target-ROAS时必填 | string | 优化目标的时间窗,枚举值:D0、D7,不同bid_goal支持的时间窗如下: Target-ROAS:D0 | D0 | |||||||||||
target_goal bid_goal为Target-ROAS时必填 | double | offer维度优化目标值,不同bid_goal取值范围如下: Target-ROAS:该值取值范围为[1, 1000],保留两位小数,单位为百分比 | 80 | |||||||||||
target_goal_by_geo | array<json> | geo维度优化目标值 | ||||||||||||
geo | string | geo | ||||||||||||
target_goal | double | 优化目标值 | ||||||||||||
bid_rate | number | 广告单元结算价格,默认针对广告单元中所有地区生效。价格必须大于 0,精度为 3 位小数。CPE、 CPI、 CPM 价格不能小于 0.01,CPC 不能小于 0.001。 | "" | 0.04 | ||||||||||
daily_cap_type 选填 | string | 预算设置类型。可选值:"BUDGET" 、 "CONVERSION" 。 | "BUDGET" | "CONVERSION" | ||||||||||
daily_cap 选填 | number | 预算设置类型下的每天预算限制。不传则表示不设预算限制。如果 daily_cap_type 为 BUDGET,精度为 3 位小数,最小值为 50。如果 daily_cap_type 为 CONVERSION,格式必须是整数,最小值为 50。 | — | 100 | ||||||||||
total_budget 选填 | number | 总预算。精度为 3 位小数。不传则表示不设预算限制。如果 daily_cap_type 为 BUDGET,最小值为 50。 | — | 50.12 | ||||||||||
settlement_event 选填 | string | 结算事件。只允许数字字母下划线,最少 3 个字符,最长 50 字符。billing_type=CPE 时必填。 | "" | "purchase" | ||||||||||
os_version_min 选填 | string | 投放设备要求的系统最低版本。格式为 /^[0-9](\.[0-9]){0,2}$/ 。如果没传,默认使用关联广告的 min_version。若不限制最低版本,传值需为 "0.0.0 " | — | "9.0" | ||||||||||
os_version_max 选填 | string | 投放设备要求的系统最高版本。格式为 /^[0-9](\.[0-9]){0,2}$/ 。如果没传,默认使用关联广告的 max_version。 若不限制最高版本,传值需为 "99.0.0" | — | "9.0" | ||||||||||
custom_ad_schedule 选填 | json | 广告投放的日程。key 表示周一到周日(1-7),value 表示 0 点到 23 点(0-23)。默认为空值,代表所有。 | — | {"1":"0,1,23","2":"3,4,5"} | ||||||||||
custom_ad_schedule_timezone 已弃用 | number | 投放日程的时区。可选值:枚举值 - 时区 此字段已被弃用,使用 'promote_timezone' 字段代替。 | — | -5.5 | ||||||||||
network 选填 | string | 网络类型定向。可选值:枚举值 - 网络类型 | — | "2G,3G,4G,5G" | ||||||||||
target_ad_type | string | 广告展示类型。多个用,号分隔。可选值:枚举值 - 广告展示类型(图片) 枚举值 - 广告展示类型(视频) | — | "REWARDED_VIDEO,INTERSTITIAL_VIDEO" | ||||||||||
target_device 选填 | string | 设备类型定向。多个用,号分隔。可选值:"PHONE" 、"TABLET" 。 | ||||||||||||
creatives | array<json> | 素材信息,已废弃,请使用creative_sets | — | [{"creative_name":"1200x627.jpg","creative_md5":"ad7667f1faf1c14d13c4e03ed8f08e6c","apply_in_area":"ALL"},{"creative_name":"512x512.png","creative_md5":"77c561b05d00559671a5a462c077fb5b", "apply_in_area":"ALL"}] | ||||||||||
creatives_sets | array<json> | 创意组信息, 接口协议 - 创建创意组 | — | [{"creative_set_name":"demo1","geos":["ALL"],"ad_outputs":[111],"creatives":[{"creative_md5":"c09d944dcf2d6ded1acd6eb2237f8bad"},{"creative_name":"icon_512x512","creative_md5":"5a42fed89d97cfe253c2f7b6be86f8ed"},{"creative_name":"1200x627","creative_md5":"ea5c9ca2f16cace9c133bb327e1c83dd"}]}] |
响应结果
字段 | 类型 | 说明 |
---|---|---|
code | int | 200 表示成功,其他表示失败 |
msg | string | 成功,返回"success",失败返回相应的错误信息 |
data | json | 成功,返回广告单元信息,失败返回具体的错误信息 |
campaign_id | int | 广告 ID |
offer_id | int | 广告单元 ID |
offer_name | string | 广告单元名称 |
promote_timezone | number | 广告单元投放时间对应的时区 |
start_time | int | 广告单元开始投放时间的时间戳 |
end_time | int | 广告单元结束投放时间的时间戳 |
target_geo | string | 广告单元投放的地区 |
bid_type | string | 结算方式 |
billing_type 已弃用 | string | 结算方式 |
bid_rate | string | 广告单元结算价格 |
daily_cap_type | string | 预算设置类型 |
daily_cap | string | 预算设置类型下的每天预算限制 |
total_budget | string | 总预算 |
settlement_event | string | 结算事件 |
os_version_min | string | 投放设备要求的系统最低版本 |
os_version_max | string | 投放设备要求的系统最高版本 |
custom_ad_schedule | string | 广告投放的日程 |
custom_ad_schedule_timezone | number | 投放日程的时区此字段已被弃用,使用 'promote_timezone' 字段代替。 |
network | string | 网络状态定向 |
target_ad_type | string | 展示类型 |
creatives 已弃用 | array<json> | 素材信息, 请使用creative_sets |
creative_sets | array<json> | 创意组信息 |
target_device | string | 设备类型定向 |
应答示例
json
{
"code": 200,
"msg": "success",
"data": {
"campaign_id": "25",
"offer_id": 18496,
"offer_name": "cqf_testtttt",
"promote_timezone": 7,
"start_time": "1578455012",
"end_time": "0",
"target_geo": "ALL",
"bid_type": "CPI",
"billing_type": "CPI",
"bid_rate": "5",
"daily_cap_type": "BUDGET",
"daily_cap": "50",
"total_budget": "50",
"settlement_event": "",
"os_version_min": "8.8",
"custom_ad_schedule": {
"1": "0,1,23",
"2": "3,4,5",
"3": "3,6,5"
},
"custom_ad_schedule_timezone": 0,
"network": "WIFI",
"target_ad_type": "BANNER",
"creative_sets": [
{
"creative_set_name": "demo1",
"geos": [
"ALL"
],
"ad_outputs": [
111
],
"creatives": [
{
"creative_name":"material1",
"creative_md5": "c09d944dcf2d6ded1acd6eb2237f8bad"
},
{
"creative_name": "icon_512x512",
"creative_md5": "5a42fed89d97cfe253c2f7b6be86f8ed"
},
{
"creative_name": "1200x627",
"creative_md5": "ea5c9ca2f16cace9c133bb327e1c83dd"
}
]
}
],
"target_device": "PHONE"
}
}