guke
a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
# GET /api/v1/platform/ad-config — 客户端广告配置
|
||
|
||
> 所属:Platform 组（前缀 `/api/v1/platform`） | 鉴权:无 | [← 返回 API 索引](../README.md)
|
||
|
||
客户端启动 / 每场广告前拉取，缓存后用：穿山甲 `app_id` + 各位 ID + 各场景开关。不含验签密钥（密钥只在后端验 S2S 回调用）。
|
||
|
||
## 入参
|
||
|
||
无。
|
||
|
||
## 出参
|
||
|
||
响应 `200`:`AdConfigPublicOut`
|
||
|
||
| 字段 | 类型 | 说明 |
|
||
|---|---|---|
|
||
| `app_id` | string | 穿山甲应用 ID（改了需冷启才生效，SDK init 一次性读） |
|
||
| `reward_code_id` | string | 福利页激励视频位 |
|
||
| `compare_draw_code_id` | string | 比价 Draw 代码位 |
|
||
| `coupon_draw_code_id` | string | 领券 Draw 代码位（与比价共用同一位，靠 `feed_scene` 区分收益） |
|
||
| `reward_enabled` | bool | 福利激励视频开关 |
|
||
| `compare_ad_enabled` | bool | 比价广告开关 |
|
||
| `coupon_ad_enabled` | bool | 领券广告开关 |
|
||
| `withdrawal_ad_enabled` | bool | 提现激励视频开关（关 = 客户端直接放行提现） |
|
||
|
||
Mock 出参:
|
||
```json
|
||
{
|
||
"app_id": "5123456",
|
||
"reward_code_id": "104001",
|
||
"compare_draw_code_id": "104002",
|
||
"coupon_draw_code_id": "104002",
|
||
"reward_enabled": true,
|
||
"compare_ad_enabled": true,
|
||
"coupon_ad_enabled": true,
|
||
"withdrawal_ad_enabled": false
|
||
}
|
||
```
|
||
|
||
## 说明
|
||
- 空库回退默认值（= 客户端内置值，维持现状）
|
||
- 不含验签密钥（`m-key`），安全边界
|
||
- `coupon_draw_code_id` 与 `compare_draw_code_id` 通常同值，客户端按场景调不同端点区分
|