开发者后台管理 API
修订历史
| 发布时间 | 修订说明 |
|---|---|
| 2026-11-16 | 广告源查询支持标准平台与自定义平台。 |
| 2026-11-09 | /api/placement/store 的 placement_list.group_list 改为传 adseat_uuid,服务端换成广告位数字 ID。只传 adseat_id 会报缺参。 |
| 2026-10-28 | /api/seat/store 支持可选 is_share 创建共享主广告位,更新通过 share_adseat_uuid 绑定/解绑;查询返回绑定 UUID。 |
| 2026-09-18 | 支持 start.io(28)、Google Ad Manager(48)、Verve(53)广告源手工创建(不含自动化)。start.io / Verve 须 Header Bidding(S2S);Google Ad Manager 不支持 Header Bidding。PID 与样式见附录2。 |
| 2026-09-14 | 自定义中介组更新未传 cache_num 时沿用该组已有并行数,不再改成广告类型默认;未传 min_cache 也不再被写成并行数。创建未传 cache_num 仍按类型默认。 |
| 2026-09-11 | 补齐独立绿字段传参:发布地区、中介组超时/频控/开屏重试、组底价与公司级别(二级中级 / 三级高级 / 九级默认)、广告源 group_list 的 selected/rate/is_auto_price。更新只传要改的键,未传保持原值。 |
| 2026-09-11 | 写接口补齐联动校验:上架与安卓市场配对、展示回调类型、填充回调与等待时长、自动刷新开关与时长、最小缓存与并行数、竞价底价仅竞价源可写、创建广告源 is_modify_pid。广告源 group_list 传入须为全量覆盖(含 [] 全关)。更新应用 2/3 可沿用库里的域名和商店链接。 |
| 2026-09-10 | /api/seat/store 回调密钥由系统生成:打开回调只传地址;编辑传 refresh_secret_key / refresh_imp_secret_key=1 换新密钥。查询仍明文回显。 |
| 2026-09-04 | /api/seat/store 支持创建互动广告(ad_type=7)、插播(ad_type=8)。未传 cache_num 时互动广告默认 1、插播默认 2。 |
| 2026-09-02 | 应用/广告位/中介组/广告源写读对齐开发者后台:上架与域名、奖励与展示回调、超时与频控、group_list / 底价 / is_modify_pid。补齐类型校验、group_list 对不上报错不改库、is_modify_pid 冲突说明。 |
| 2026-09-01 | 支持 Digital Turbine、YSO 广告源自动化创建及三方 Placement ID 回写;支持 zMaticoo 广告源手动创建。 |
| 2026-08-31 | 开放 Unity Ads 广告源自动化创建能力(仅非 Bidding),补充 Game ID、Placement ID 回写及横幅尺寸填写说明。 |
| 2026-08-21 | 穿山甲(adsource_id=17)手动创建须填 placement_config.primeRitId;不支持 OpenAPI 自动化。 |
| 2026-08-21 | AdMob、Moloco 原生横幅 native_ad_size 仅支持 3(300 x 250);历史数据不迁移。 |
| 2026-08-20 | 支持 Moloco、Magnite 广告源手工创建(不含自动化),对齐后台广告类型与 Header Bidding(S2S)。 |
| 2026-08-12 | 重新开放 Yandex 广告源自动化创建能力,补充权限、应用 ID 及激励相关填写说明。 |
| 2026-08-07 | 获取广告位接口(/api/seat/seats)返回新增 adseat_label,用于区分普通、共享、智能策略广告位。 |
| 2026-08-06 | 支持开屏:Unity Ads 插屏开屏。 |
| 2026-07-27 | 支持 Mintegral、Vungle、Bigo、TaurusX、Inmobi 广告源自动化创建能力,覆盖各类广告类型转换适配场景。 |
| 2026-07-24 | 新增中介组排序。 |
| 2026-07-14 | 原生横幅尺寸与关闭按钮配置扩展至 Columbus、TaurusX。 |
| 2026-06-26 | 扩展原生横幅广告源的尺寸与关闭按钮配置说明,新增 Meta、Mintegral、Inmobi、Yandex、Bigo 等平台;Meta 横幅补充原生拼横幅的创建与查询说明。 |
| 2026-06-12 | 支持 AdMob、Google Ad Manager 横幅内嵌式自适应广告源。 |
| 2026-06-11 | 原生横幅广告源支持在 placement_config 中配置 native_ad_size、close_button;适用 AdMob、Pangle、Vungle。 |
| 2026-05-26 | 更新 AdMob 广告源创建说明,统一手动与自动化创建的应用 ID 填写方式。 |
| 2026-05-07 | 支持 Pangle 广告源自动化创建能力,覆盖各类广告类型转换适配场景。 |
| 2026-04-14 | 接口功能更新:查询广告源信息增加可选参数 ,创建和编辑中介组 支持默认组的更新操作。 |
| 2026-04-09 | 支持 Meta、AdMob 广告源自动化创建能力,覆盖各类广告类型转换适配场景。 |
| 2026-03-25 | 支持 A/B 测试全流程管理能力 |
1 获取 Api Key
在 TradPlus 开发者后台 ,进入“用户信息”,“我的账号”,“API Key”,获取 API Key 和秘钥。
| 名称 | 用途 |
|---|---|
| API Key(bear) | 标识用户身份 |
| 密钥(secret) | 生成请求签名 |
2 API 接入
所有请求都采用post方式,POST 请求数据默认格式为:multipart/form-data;请求域名为:https://openapi.tradplusad.com
2.1 请求公参
| 参数 | 说明 | 传递方式 | 样例 |
|---|---|---|---|
| bear | API key | HTTP Header | 157E4A5D-3877-1236-DE06-457FT3F70C4 |
| sign | 签名 | GET | 5DE008C88087D8556D276A9E5B8E37E6 |
| timestamp | 时间戳,当前时间的秒数 | GET | 1629525680 |
| nonce | 16位长度随机字符,数字与字母组合 | GET | 5c672d4e9628d0a7 |
2.2 生成签名
获取 bear 和 secret,参考 1 获取 Api Key
具体规则如下:
- 拼接 secret, timestamp, nonce 和请求路径
- md5加密并且转换为大写
$sign = strtoupper(md5($secret+$timestamp+$nonce+$path));
2.3 调用示例
curl --location --request POST 'https://openapi.tradplusad.com/api/seat/store?sign=5DE008C88087D8556D276A9E5B8E37E6×tamp=1629525680&nonce=5c672d4e9628d0a7' \
--header 'bear: 157E4A5D-3877-1236-DE06-457FT3F70C4' \
--form 'adseat_list[0][app_uuid]="BA04D9C5A5E736CCDA8003BC5D936BE5"' \
--form 'adseat_list[0][seat_name]="test创建"' \
--form 'adseat_list[0][ad_type]="5"' \
--form 'adseat_list[0][adseat_uuid]=""'
2.4 返回参数
返回 json 格式
2.4.1 成功
{
"code": 200,
"status": 0,
"data": {
"list": [
{
"adseat_uuid": "8629EE09A4E3C6B60AEC48FA7D6CA4D4",
"seat_name": "test创建",
"error_message": ""
}
]
}
}
2.4.2 失败
{
"code": 403,
"status": -1,
"error_message":"sign error"
}
3 报表
3.1 提交三方广告平台报表数据
请求路径: /api/report/submit
请求参数:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| report_data_list | Array | Y | 最多10个超过会被丢弃 | |
| report_data_list.day | String | Y | 日期,仅支持到天 Y-m-d 格式 | 示例:2021-02-01 |
| report_data_list.iso | String | Y | 国家二位码(短码) | 示例:GE 见:8.1 |
| report_data_list.adsource_id | Int | Y | tradplus 广告平台 ID | 见:8.2 |
| report_data_list.placement_id | String | Y | 三方广告平台广告位 ID | Mintegral 需要用 "_" 拼接 AD Unit ID Unity_Ads 需要拼接 Game ID Applovin 需要拼接 SDK Key Kidoz 需要拼接应用的包名 package_name ReklamUp 需要拼接应用的包名 package_name 示例:placementID_adUnitID |
| report_data_list.currency | String | N | 币种单位 CNY 或 USD,不传默认 CNY | |
| report_data_list.bidding_request | Int | N | 竞价请求 | 默认 0 |
| report_data_list.bidding_response | Int | N | 竞价响应 | 默认 0 |
| report_data_list.request | Int | N | 请求 | 默认 0 |
| report_data_list.fill | Int | N | 填充 | 默认 0 |
| report_data_list.impression | Int | N | 展示 | 默认 0 |
| report_data_list.click | Int | N | 点击 | 默认 0 |
| report_data_list.income | Float | N | 收入 | 默认 0 |
返回字段:
| 字段 | 类型 | 必传 | 说明 |
|---|---|---|---|
| error | Array | Y | 错误信息列表 |
| error.message | String | N | 错误信息 |
| error.report_data | Array | N | 错误信息详情(同请求数据) |
返回样例:
{
"code": 200,
"status": 0,
"data": {
"error": [
{
"message": "国家二位码(短码) 缺失或者错误",
"report_data": {
"day": "2022-01-18",
"iso": "USA",
"adsource_id": "16",
"placement_id": "abc123",
"currency": "CNY",
"income": "50",
"fill": "800"
}
},
{
"message": "广告网络ID 缺失或者错误",
"report_data": {
"day": "2022-01-19",
"iso": "CN",
"adsource_id": "475",
"placement_id": "22",
"currency": "CNY",
"income": "20",
"fill": "600",
"impression": "100"
}
}
]
}
}
4 应用管理
4.1 获取应用分类
请求路径: /api/app/allcategory
请 求参数:无
返回字段:
| 字段 | 类型 | 必传 | 说明 |
|---|---|---|---|
| first_category | Array | Y | 一级分类 |
| first_category.id | String | Y | 分类 id |
| first_category.name_cn | String | Y | 中文名 |
| first_category.name_en | String | Y | 英文名 |
| sub_category | Array | Y | 二级分类 |
| sub_category.id | String | Y | 二级分类 id |
| sub_category.pid | String | Y | 对应的一级分类 id |
| sub_category.name_cn | String | Y | 中文名 |
| sub_category.name_en | String | Y | 英文名 |
返回样例:
{
"code": 200,
"status": 0,
"data": {
"first_category": [
{
"id": "1",
"name_cn": "游戏",
"name_en": "Game"
},
{
"id": "2",
"name_cn": "应用",
"name_en": "App"
}
],
"sub_category": [
{
"id": "101",
"name_cn": "动作",
"name_en": "Action",
"pid": "1"
},
{
"id": "102",
"name_cn": "冒险",
"name_en": "Adventure",
"pid": "1"
}
...
]
}
}
4.2 获取应用
请求路径: /api/app/apps
请求参数:
如果传了 app_uuids 则忽略 page,只有在 app_uuids 不传的情况下才返回 has_more 和 total
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| app_uuids | Stirng | N | 应用 ID | 每次最多接受100个 |
| page | Int | N | 页数 默认1 | 每页100条 |
返回字段:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| total | Int | N | 总数 | |
| has_more | Int | N | 是否还有更多 | |
| app_list | Array | Y | 应用信息 | |
| app_list.app_uuid | String | Y | 开发者应用 ID | |
| app_list.app_name | String | Y | 应用名称 | |
| app_list.category_id | Int | Y | 二级分类 | |
| app_list.app_url | String | Y | 应用商店链接 | |
| app_list.package_name | String | Y | 应用包名 | |
| app_list.os | Int | Y | 应用平台 | 1:安卓 2:iOS |
| app_list.is_release | Int | Y | 是否上架 | 1:未上架 2:已上架 3:其他应用市场 |
| app_list.domain | String | Y | 应用域名 | |
| app_list.other_app_market | Int | N | 安卓应用市场 | 仅 Android。取值见附录4 |
| app_list.app_release_region | Int | N | 发布地区 | 1 全球地区、2 中国地区、3 海外地区 |
请求示例
curl --location --request POST 'https://openapi.tradplusad.com/api/app/apps?sign=5DE008C88087D8556D276A9E5B8E37E6×tamp=1629525680&nonce=5c672d4e9628d0a7' \
--header 'bear: 157E4A5D-3877-1236-DE06-457FT3F70C4' \
--header 'Content-Type: application/json' \
--data '{"app_uuids":"348FA2C4CFA91471D09DC529EAB1459E","page":1}'
返回样例:
{
"code": 200,
"status": 0,
"data": {
"has_more": 0,
"total": 25,
"app_list": [
{
"app_uuid": "A741926221D7FEFBCB179D08B4477713",
"app_name": "test1",
"os": 1,
"is_release": 2,
"package_name": "com.test1",
"app_url": "http://www.test1.com",
"category_id": 102,
"domain": "example.com",
"other_app_market": 13,
"app_release_region": 1
},
{
"app_uuid": "4F1E43B002376A505FFFB03F04C170E5",
"app_name": "test2",
"os": 1,
"is_release": 2,
"package_name": "com.test.4iphone",
"app_url": "http://www.test2.com",
"category_id": 111
},
...
]
}
}
4.3 创建和编辑应用
请求路径: /api/app/store
请求参数:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| app_list | Array | Y | app 信息 | 每次最多10个,超过会被丢弃 |
| app_list.app_uuid | String | N | 开发者应用 ID | 编辑必传 |
| app_list.app_name | String | N | 应用名称 | 编辑必传 |
| app_list.os | Int | N | 应用平台 1:安卓 2:iOS | 创建后不可编辑 |
| app_list.package_name | String | N | 应用包名 | 创建必传 |
| app_list.app_url | String | N | 应用商店链接 | is_release=2 或 3 时须有值:创建必传;更新未传则沿用库里已有链接,显式传空会失败。iOS 已上架或 Android other_app_market=13 时,本次若带了链接会按链接拉取商店信息;app_name、package_name 可覆盖 |
| app_list.category_id | Int | N | 分类参考 3.1 获取应用分类 | 创建必传 |
| app_list.direction | Int | N | 屏幕方向 | 1-竖屏 2-横屏 0-自适应 |
| app_list.is_release | Int | Y | 是否上架 | 创建必填。1 未上架 2 已上架 3 其他应用市场。2/3 时须有 domain 与 app_url:创建必传;更新只改 is_release 时可沿用库里已有值 |
| app_list.domain | String | N | 应用域名 | is_release=2 或 3 时须有值。更新未传则沿用已有域名,显式传空会失败 |
| app_list.other_app_market | Int | N | 安卓应用市场 | 仅 Android。取值见附录4。is_release=2 须为 13;is_release=3 须为 0–12,不能为 13。13 时会按商店链接拉取元数据 |
| app_list.app_release_region | Int | N | 发布地区 | 1 全球地区、2 中国地区、3 海外地区。更新未传则保持原值 |
返回字段:
| 字段 | 类型 | 必传 | 说明 |
|---|---|---|---|
| list | Array | Y | 应用信息 |
| list.app_uuid | Stirng | N | 开发者应用 ID |
| list.app_name | Stirng | N | 应用名称 |
| list.error_message | Stirng | N | 错误信息,空字符表示成功 |
请求示例
curl --location --request POST 'https://openapi.tradplusad.com/api/app/store?sign=5DE008C88087D8556D276A9E5B8E37E6×tamp=1629525680&nonce=5c672d4e9628d0a7' \
--header 'bear: 157E4A5D-3877-1236-DE06-457FT3F70C4' \
--header 'Content-Type: application/json' \
--data '{"app_list":[{"app_uuid":"","app_name":"API\u5e94\u7528","os":1,"package_name":"api","app_url":"","category_id":101,"direction":1}]}'
返回样例:
{
"code": 200,
"status": 0,
"data": {
"list": [
{
"app_uuid": "",
"app_name": "a1",
"error_message": "应用名称已存在"
},
{
"app_uuid": "A741926221D7FEFBCB179D08B4477713",
"app_name": "test1",
"error_message": ""
}
]
}
}
5 广告位管理
5.1 获取广告位
请求路径: /api/seat/seats
请求参数:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| app_uuid | Stirng | N | 单个应用 ID,可以获取某个应用下的所有广告位 | app_uuid 和 adseat_uuid 互斥 都传只取 app_uuid |
| adseat_uuids | String | N | 广告位 ID,多个逗号分割, 最多返回100 | |
| page | String | N | 页数 默认1 | 每页100条 |
返回字段:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| has_more | Int | N | ||
| total | Int | N | ||
| adseat_list | Array | Y | ||
| adseat_list.app_uuid | String | Y | 开发者应用 ID | |
| adseat_list.seat_name | String | Y | 广告位名称 | |
| adseat_list.adseat_uuid | String | Y | 广告位 ID | |
| adseat_list.adseat_label | String | Y | 广告位类型标签,只读。normal 普通广告位;shared 共享主广告位;intelligent 智能策略广告位(含主广告位与子广告位)。每个广告位仅返回一个标签;绑定共享的广告位(非共享主广告位)返回 normal | |
| adseat_list.share_adseat_uuid | String | Y | 绑定的共享主广告位 UUID;未绑定返回空字符串。绑定后的普通广告位仍返回 adseat_label=normal | |
| adseat_list.cache_num | Int | Y | 并行请求数 | |
| adseat_list.ad_type | Int | Y | 广告类型: 1 原生 2 插屏 3 开屏 4 横幅 5 激励视频 7 互动广告 8 插播 | |
| adseat_list.use_frequency | Int | Y | 是否设置展示频次上线:1 是 0 否 | |
| adseat_list.frequency_limit | Int | Y | 展示数上限 | |
| adseat_list.frequency_unit_count | Int | Y | 单位间隔 | |
| adseat_list.frequency_unit | Int | Y | 次数单位:1 分钟 2 小时 3 天 | eg: 每5(frequency_unit_count) 分钟 (frequency_unit) 展示10次(frequency_limit) |
| adseat_list.ad_type_template | Int | N | 原生模版类型 标准原生: 1 原生横幅: 2 Draw 信息流: 3 原生开屏: 4 | 原生类型返回 |
| adseat_list.refresh_time | Int | N | 刷新时间 | 原生横幅,横幅返回 |
| adseat_list.skip_time | Int | N | n 秒后显示跳过按钮 | 开屏,原生开屏类型返回 |
| adseat_list.countdown_time | Int | N | 倒计时总时长 | 开屏,原生开屏类型返回 |
| adseat_list.is_skip | Int | N | 是否可跳过 | 开屏,原生开屏字类型返回 |
| adseat_list.monetary_name | String | N | 奖励项目 | 激励视频类型返回 |
| adseat_list.monetary | Int | N | 奖励数量 | 激励视频类型返回 |
| adseat_list.is_server_callback | Int | N | 奖励回调开关 | 1 开 0 关;激励视频返回 |
| adseat_list.callback_url | String | N | 奖励回调 URL | |
| adseat_list.secret_key | String | N | 奖励回调密钥 | 明文;系统生成,只读 |
| adseat_list.imp_is_server_callback | Int | N | 展示回调开关 | 1 开 0 关 |
| adseat_list.imp_callback_url | String | N | 展示回调 URL | |
| adseat_list.imp_secret_key | String | N | 展示回调密钥 | 明文;系统生成,只读 |
| adseat_list.imp_callback_type | Int | N | 展示回调类型 | 1 普通 2 精准 |
请求示例
curl --location --request POST 'https://openapi.tradplusad.com/api/seat/seats?sign=5DE008C88087D8556D276A9E5B8E37E6×tamp=1629525680&nonce=5c672d4e9628d0a7' \
--header 'bear: 157E4A5D-3877-1236-DE06-457FT3F70C4' \
--header 'Content-Type: application/json' \
--data '{"app_uuid":"348FA2C4CFA91471D09DC529EAB1459E", "adseat_uuids":"","page":1}'
返回样例:
{
"code": 200,
"status": 0,
"data": {
"has_more": 0,
"total": 58,
"adseat_list": [
{
"app_uuid": "A741926221D7FEFBCB179D08B4477713",
"seat_name": "cp1",
"adseat_uuid": "E1FF0FF0BFF1EBDB61C0FED50E66229D",
"adseat_label": "normal",
"share_adseat_uuid": "",
"ad_type": 2,
"cache_num": 2,
"use_frequency": 0,
"frequency_limit": 0,
"frequency_unit_count": 0,
"frequency_unit": 0
},
{
"app_uuid": "1BCEFCAD3011A276134CC6225E724064",
"seat_name": "bzys",
"adseat_uuid": "D202406D331F32A5BBD1231065BAD7A0",
"adseat_label": "normal",
"share_adseat_uuid": "",
"ad_type": 1,
"cache_num": 2,
"use_frequency": 0,
"frequency_limit": 0,
"frequency_unit_count": 0,
"frequency_unit": 0,
"ad_type_template": 1
},
...
]
}
}
5.2 创建和编辑广告位
请求路径: /api/seat/store
请求参数:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| adseat_list | Array | Y | 最多10个超过会被丢弃 | |
| adseat_list.app_uuid | String | Y | 开发者应用 ID | 开发者应用 ID ,创建后不可编辑。 |
| adseat_list.seat_name | String | Y | 广告位名称 创建必传 | |
| adseat_list.adseat_uuid | String | N | 广告位 ID 编辑必传 | |
| adseat_list.is_share | Int | N | 广告位属性:0 普通(默认),1 共享主广告位 | 创建时可选;更新不能改变已有属性 |
| adseat_list.share_adseat_uuid | String | N | 绑定的共享主广告位 UUID | 仅更新普通广告位:非空 UUID 绑定,"" 解绑,不传保持原关系;不能传 null |
| adseat_list.status | Int | N | 广告位状态:0 停用,1 启用 | 仅更新普通/共享广告位;不传保持原状态。不能传 null、布尔值或其他枚举;创建时不支持传入 |
| adseat_list.cache_num | Int | N | 广告并行请求数。未传时默认 2;互动广告(7)默认 1,插播(8)默认 2 | 开屏范围:1 |
| adseat_list.ad_type | Int | Y | 广告类型: 1 原生 2 插屏 3 开屏 4 横幅 5 激励视频 7 互动广告 8 插播 | 广告类型,创建必传,创建后不可编辑。 |
| adseat_list.use_frequency | Int | N | 是否设置展示频次上线:默认否 | 1 是 0 否 |
| adseat_list.frequency_limit | Int | N | 展示数上限 n 次展示,默认 1 | |
| adseat_list.frequency_unit_count | Int | N | 单位间隔, 默认 1 | |
| adseat_list.frequency_unit | Int | N | 次数单位, 分钟:1 小时: 2 天:3 默认 1 | |
| adseat_list.ad_type_template | Int | N | 1 标准原生 2 原生横幅 3 Draw 信息流 4 原生拼接开屏 | 创建原生类型必传,创建后不可编辑。 |
| adseat_list.refresh_time | Int | N | 自动刷新,范围:15~150秒 | 仅对横幅与原生横幅生效 可以不传,表示不刷新 |
| adseat_list.skip_time | Int | N | n 秒后显示跳过按钮 范围:0~10秒 默认为2 | 创建开屏与原生开屏必传,仅对开屏与原生开屏生效 |
| adseat_list.countdown_time | Int | N | 倒计时总时长 范围:3~10秒, 默认 5 | 创建开屏与原生开屏必传 仅对开屏与原生开屏生效 倒计时总时长必须大于 skip_time |
| adseat_list.is_skip | Int | N | 是否可跳过,1是 0否, 默认是 | 创建开屏与原生开屏必传,仅对开屏与原生开屏生效 |
| adseat_list.monetary_name | String | N | 奖励项目 | 仅对激励视频生效 |
| adseat_list.monetary | Int | N | 奖励数量 | 仅对激励视频生效 |
| adseat_list.is_server_callback | Int | N | 奖励回调开关 | 仅激励视频;1=开时须同时传 callback_url。密钥由系统生成,查询列表明文回显。非激励广告位传奖励回调字段会报「非激励视频无需设置奖励回调」 |
| adseat_list.callback_url | String | N | 奖励回调 URL | 最长 2000 |
| adseat_list.refresh_secret_key | Int | N | 刷新奖励回调密钥 | 仅编辑;1=换新密钥 |
| adseat_list.imp_is_server_callback | Int | N | 展示回调开关 | 1=开时须同时传 imp_callback_url。密钥由系统生成 |
| adseat_list.imp_callback_url | String | N | 展示回调 URL | 最长 2000 |
| adseat_list.refresh_imp_secret_key | Int | N | 刷新展示回调密钥 | 仅编辑;1=换新密钥 |
| adseat_list.imp_callback_type | Int | N | 展示回调类型 | 1 普通 2 精准。只要传了且不是 1 或 2(如 99),无论回调开或关都报「展示回调类型参数设置错误」。0 或不传不报错 |
共享广告位规则与后台一致:仅原生、插屏、开屏、激励视频支持创建共享主广告位,须有公司共享权限。同应用同类型默认一个,有多共享权限时允许多个。普通/共享属性创建后不可转换。
绑定双方须同公司、同应用、同广告类型、启用且非草稿;原生还要求模板类型一致。智能策略及其子广告位不能作为普通端绑定。普通广告位已绑定其他主广告位时须先解绑,存在未结束的 AB 测试时不能主动变更绑定关系。重复绑定同一主广告位或重复解绑不改变关系。解绑保留原广告源和中介组配置。
更新传 status=0 时:停用共享主广告位会清除所有关联普通广告位及 A/B 分组的共享引用;停用普通广告位只清除自身绑定,不修改其他普通位或 A/B 分组的共享引用。停用联动与后台一致,不受主动解绑的未结束 A/B 测试限制;共享主位状态操作须有公司共享权限。重复停用允许执行,重新启用不会恢复旧绑定。停用时不能同时传非空 share_adseat_uuid 建立绑定;智能策略主/子广告位不支持通过此接口修改状态。状态和关联清理在同一事务内保存,任一步失败则该项回滚。
停用示例:{"adseat_list":[{"app_uuid":"<app_uuid>","adseat_uuid":"<adseat_uuid>","status":0}]}。查询 /api/seat/seats 回读 status 和 share_adseat_uuid 确认结果。
下列请求均调用 /api/seat/store,每项独立处理,失败通过 list[].error_message 返回原因且该项原配置不变;一项失败不影响其他合法项。API Key 仍分别校验创建/更新权限及应用范围。
{"adseat_list":[{"app_uuid":"<app_uuid>","seat_name":"共享插屏","ad_type":2,"is_share":1}]}
{"adseat_list":[{"app_uuid":"<app_uuid>","adseat_uuid":"<ordinary_adseat_uuid>","share_adseat_uuid":"<shared_adseat_uuid>"}]}
{"adseat_list":[{"app_uuid":"<app_uuid>","adseat_uuid":"<ordinary_adseat_uuid>","share_adseat_uuid":""}]}
调用 /api/seat/seats 可按应用查询列表,或传 adseat_uuids 查询详情;绑定关系字段始终返回字符串。
打开激励视频奖励回调时只传开关和地址,创建成功后用 /api/seat/seats 读 secret_key。换钥时编辑传 refresh_secret_key=1(展示回调用 refresh_imp_secret_key=1)。
{"adseat_list":[{"app_uuid":"<app_uuid>","seat_name":"激励01","ad_type":5,"is_server_callback":1,"callback_url":"https://example.com/reward"}]}
{"adseat_list":[{"app_uuid":"<app_uuid>","adseat_uuid":"<adseat_uuid>","refresh_secret_key":1}]}
返回字段:
| 字段 | 类型 | 必传 | 说明 | 备注 |
|---|---|---|---|---|
| list | Array | Y | ||
| list.adseat_uuid | String | Y | ||
| list.seat_name | String | Y | ||
| list.error_message | String | Y | 错误信息,空字符表示成功 |
请求示例
curl --location --request POST 'https://openapi.tradplusad.com/api/seat/store?sign=5DE008C88087D8556D276A9E5B8E37E6×tamp=1629525680&nonce=5c672d4e9628d0a7' \
--header 'bear: 157E4A5D-3877-1236-DE06-457FT3F70C4' \
--header 'Content-Type: application/json' \
--data '{"adseat_list":[{"app_uuid":"BA04D9C5A5E736CCDA8003BC5D936BE5","seat_name":"API\u521b\u5efa","ad_type":"5","adseat_uuid":""}]}'
返回样例:
{
"code": 200,
"status": 0,
"data": {
"list": [
{
"adseat_uuid": "9D0A151A3B9169369CB75873FD86713E",
"seat_name": "test原生横幅",
"error_message": ""
},
{
"adseat_uuid": "",
"seat_name": "",
"error_message": "应用id必填"
}
]
}
}