获取广告单元列表
需要携带 Token，详情看 Token
获取广告单元列表，支持 campaign_id、campaign_name、offer_id、offer_name、offer_uuid、status、package_name 、ext_fields 条件查询。
请求地址
https://ss-api.mintegral.com/api/open/v1/offers
请求方法
GET
请求示例
json
GET /api/open/v1/offers
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "page": 1, "campaign_id": "12,13,15", "limit": 10 }请求参数
| 字段 | 类型 | 说明 | 默认值 | 例子 |
|---|---|---|---|---|
campaign_id 选填 | string | 广告 ID，多个用,隔开 | — | "12,13,15" |
campaign_name 选填 | string | 广告名称，支持模糊查询 | "" | "campaign_test" |
offer_id 选填 | string | 广告单元 ID，多个用,隔开 | — | "123,124,125" |
offer_name 选填 | string | 广告单元名称，支持模糊查询 | "" | "offer_test" |
offer_uuid 选填 | string | 系统自动生成的广告单元名称 | — | "ss_offer_test" |
package_name 选填 | string | 包名，支持模糊查询 | "" | "test" |
ext_fields 选填 | string | 扩展查询，多个用,号分隔。 支持如下信息查询: bid_rate_by_mtgid => mtg 渠道出价 target_app => 该字段用于屏蔽或者定向具体的应用 | "" | "bid_rate_by_mtgid" |
page 选填 | int | 页数 | 1 | 1 |
limit 选填 | int | 每页数量 最大值：50；大于 50 时，接口只返回 50 个 | 10 | 15 |
status 选填 | string | 可选值：[枚举值 - 广告单元状态]，多个用,隔开 | "" | "RUNNING" |
响应结果
| 字段 | 类型 | 说明 |
|---|---|---|
| code | int | 200 表示成功，其他表示失败 |
| msg | string | 成功，返回"success"，失败返回相应的错误信息 |
| data | json | 成功，返回广告单元信息，失败返回具体的错误信息 |
| page | int | 当前在第几页 |
| limit | int | 数量限制 |
| total | int | 总数量 |
| list | array<json> | |
| campaign_id | int | 广告 ID |
| campaign_name | string | 广告名称 |
| offer_id | int | 广告单元 ID |
| uuid | string | 系统自动生成的广告单元名称，主要应用与 tracking link 的配置 |
| offer_name | string | 广告单元名称 |
| promote_timezone | number | 投放时区，例如-5 |
| start_time | string | 广告单元开始投放时间的时间戳 |
| end_time | string | 广告单元结束投放时间的时间戳 |
| status | string | 可选值：[枚举值 - 广告单元状态] |
| target_geo | string | 如"US,CN" |
| stage | string | Offer维度冷启动阶段 |
| bid_type | string | 结算方式，可选值：[枚举值 - 结算方式] |
| bid_rate | float | 兜底价格，针对未额外设置出价的地区或者流量，默认按照此价格生效 |
| bid_rate_by_location | array<json> | 分地区价格，如[{"country_code":"US","bid_rate":"8.010"},{"country_code":"CN","bid_rate":"3.920"}] |
| budget | array<json> | 分地区预算 |
| offer_stop_reason | string | 广告单元被关停的原因，比如账户余额不足、无可用素材、tracking link 测试不通过。 |
| settlement_event | string | 结算事件,CPE 类型的广告单元，该值非空，否则显示为空 |
| tracking_method | string | 追踪方式。枚举值：[枚举值 - 追踪方式] |
| click_url | string | 点击追踪链接。 |
| impression_url | string | 展示追踪链接。注：系统会根据校验规则规范写法，和入参可能不一样。 |
| os_version_min | string | 投放设备要求的系统最低版本 |
| custom_ad_schedule | string | 广告投放的日程 |
| custom_ad_schedule_timezone | number | 投放日程的时区此字段已被弃用，使用 'promote_timezone' 字段代替。 |
| network | string | 网络类型定向 |
| target_ad_type | string | 展示类型 |
| currency | string | 结算币种，枚举值："CNY"、"USD" |
| target_device | string | 定向具体的设备 |
| click_url_status | string | 点击 url 的测试状态。枚举值： PENDDING => 链接未测试或者链接未测试通过，继续测试中 PASS => 链接测试通过 NOT_EXIST => 链接为空。 |
| target_app | array<json> | 需要屏蔽或者定向的应用详情 |
| switch | int | 1=>定向指定应用；2=>屏蔽指定应用；0=>不限，通投所有应用 |
| mtg_id | array<string> | mtgid |
| package | array<string> | package name |
| bid_rate_for_mtgid | array<json> | 获取针对流量，即 mtgid 的出价详情 |
| apply_in_area | string | 出价流量的起量地区 |
| mtgid | string | 目标流量的 mtgid |
| bid_rate | string | 指定 mtgid 在广告单元中特定地区的出价 |
| maintain_by | string | 表示广告单元的管理权限。当该值为AM时，广告单元由账户经理管理、维护，您只能查看广告详情，无修改权限；当该值为ADV时，除了查看详情，您可根据需要编辑、调整广告下的对应配置 |
| include_ta_id | rray<int> | 定向的人群包id |
| exclude_ta_id | rray<int> | 排除定向的人群包id |
| target_mtg_event | array<string> | 需要优化的目标，只有Target-ROAS才会返回 |
| target_goal_window | string | 优化目标的时间窗，枚举值：D0、D7 |
| target_goal | double | offer维度优化目标值 |
| target_goal_by_geo | array<json> | geo维度优化目标值 |
| geo | string | geo |
| target_goal | double | 优化目标值 |
应答示例
json
{
"code": 200,
"msg": "success",
"data": {
"page": 1,
"limit": 10,
"total": 1,
"list": [
{
"campaign_id": 25,
"campaign_name": "quanfutest",
"offer_id": 18490,
"uuid": "ss_cqf_testtt",
"offer_name": "cqf_testtt",
"promote_timezone": 0,
"start_time": 1578463214,
"end_time": 1578463300,
"status": "PENDING",
"target_geo": "",
"bid_type": "CPI",
"bid_rate": 5,
"offer_stop_reason": "",
"settlement_event": "",
"tracking_method": "REYUN",
"click_url": "https://uri6.com/tkio/aIBFJ3a?campuuid={uuid}&clickid={click_id}&ip={ip}&ua={ua}&subchannel={affiliate_id}&idfa={device_id}&imei={imei}&androidid={@info.args.androidid@}&muid={@info.args.imei_md5@}",
"impression_url": "https://uri6.com/tkio/aIBFJ3a?campuuid={uuid}&clickid={click_id}&ip={ip}&ua={ua}&subchannel={affiliate_id}&idfa={device_id}&imei={imei}&androidid={@info.args.androidid@}&muid={@info.args.imei_md5@}&impression=true",
"os_version_min": "8.8",
"custom_ad_schedule": "{\"1\":\"0,1,23\",\"2\":\"3,4,5\",\"2\":\"3,6,5\"}",
"custom_ad_schedule_timezone": 5,
"network": "WIFI",
"target_ad_type": "BANNER",
"target_device": "PHONE",
"click_url_status": "PENDDING",
"currency": "CNY",
"include_ta_id": [
1,
2,
3
],
"exclude_ta_id": [],
"bid_rate_by_location": [],
"budget": [
{
"target_geo": "ALL",
"total_budget": "OPEN"
"daily_cap_type": "BUDGET",
"daily_cap": "OPEN"
}
],
"target_app": {
"switch": 1,
"mtg_id": [
"mtg1136177844",
"mtg1145649416",
"mtg1147878844",
"mtg1159190054",
"mtg1161305803",
"mtg1162100014",
"mtg1173896830",
"mtg1213459814",
"mtg1219162787",
"mtg1222631077",
"mtg1231632728",
"mtg1231757768",
"mtg1233979988",
"mtg1252419046",
"mtg1344357333",
"mtg1412606974",
"mtg1427875116",
"mtg1552447933",
"mtg1880160718",
"mtg1928332330",
"mtg1985009108"
],
"package": []
},
"bid_rate_by_mtgid": [
{
"bid_rate": "1.001",
"apply_in_area": "CN",
"mtgid": "mtg1127838375"
},
{
"bid_rate": "22.000",
"apply_in_area": "IN",
"mtgid": "mtg1808626507"
}
],
"maintain_by": "ADV"
}
]
}
}