feat(ad-revenue): admin 广告收益报表(按用户/日期/类型/应用/代码位聚合)

- 新增 GET /admin/api/ad-revenue-report:展示条数/收益 + 复用金币审计逐条复算做发奖对账 - ad_ecpm/ad_reward/ad_feed_reward 各加 app_env + our_code_id 两列(alembic 迁移) - ecpm-report / feed-reward 接收并落库 app_env/our_code_id;激励发奖按 ad_session_id 回填 - ad_audit 抽出 audit_rows,报表与逐条审计复用同一复算口径 - 组级 matched 改「组内逐条全一致」,避免应发和==实发和的互相抵消掩盖错误 - list_feedbacks 改 offset 分页并返回 total(配合 admin 页码分页) - 反馈正文上限 _CONTENT_MAX 2000→200 - 文档:新增 admin-ad-revenue-report,更新 ecpm/feed-reward/feedback 及对应 db docs Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 21:55:34 +08:00
parent 9ec9d2389d
commit bebd694fb5
25 changed files with 670 additions and 38 deletions
@@ -104,6 +104,7 @@
 | A26 | `POST /admin/api/marquee-seeds/bulk` | operator | [详情](./admin-marquee-seeds.md) |
 | A27 | `GET /admin/api/marquee-seeds/preview` | admin | [详情](./admin-marquee-seeds.md) |
 | A28 | `GET /admin/api/ad-coin-audit` | admin | [详情](./admin-ad-coin-audit.md)(看广告金币公式复算对账,只读) |
+| A29 | `GET /admin/api/ad-revenue-report` | admin | [详情](./admin-ad-revenue-report.md)(广告收益报表:按用户/日期/类型/应用/代码位 聚合 条数/收益/金币,只读) |
 | - | `GET /admin/api/health` | 无 | admin 健康检查(无单独文档) |

 > ⚠️ 美团三个接口当前**无鉴权**,且 `referral-link` 的 `sid` 允许客户端传值覆盖默认渠道——见各接口"备注"。
@@ -7,11 +7,13 @@

 | 字段 | 类型 | 必填 | 说明 |
 |---|---|---|---|
-| `ad_type` | str | 是 | 广告类型:`reward_video`(激励视频) / `draw`(Draw 信息流) 等 |
-| `ad_session_id` | str\|null | 否 | 客户端生成的广告会话 ID;需和穿山甲 `extra.ad_session_id` 一致,用于 S2S 缺 eCPM 时匹配 |
+| `ad_type` | str | 是 | 广告类型:`reward_video`(激励视频) / `feed`(信息流) / `draw`(历史 Draw 信息流) 等 |
+| `ad_session_id` | str\|null | 否 | 客户端生成的广告会话 ID;激励视频与穿山甲 `extra.ad_session_id` 一致,用于 S2S 缺 eCPM 时匹配。**信息流轮播每条展示用各自独立 id**(不复用比价会话 id,否则 `uq_ad_ecpm_record_session` 去重只留一条) |
 | `ecpm` | str | 是 | 穿山甲 `getShowEcpm().getEcpm()` 原始字符串,单位是**分/千次展示**(非元),后端 ÷100 转元参与金币公式 |
-| `adn` | str\|null | 否 | 实际投放 ADN(`getSdkName`),如 `pangle` |
+| `adn` | str\|null | 否 | 实际投放 ADN(`getSdkName`),如 `pangle`(聚合后实际填充的子渠道) |
 | `slot_id` | str\|null | 否 | 实际展示代码位(底层 mediation rit,非客户端配置位) |
+| `app_env` | str\|null | 否 | **我们的**穿山甲应用环境:`prod`(傻瓜比价正式) / `test`(测试应用) |
+| `our_code_id` | str\|null | 否 | **我们后台配置的**代码位 ID(`AdConfig` 的 104xxx,**非** `slot_id` 的底层 rit) |

 `user_id` 不在 body 里——由 JWT 取(Bearer),防伪造。

@@ -23,7 +25,7 @@
 | `ok` | bool | 落库即 `true` |

 ## 说明
-客户端在广告**展示后**(`onAdShow` 读 `getShowEcpm()`)调用,把本次展示的 eCPM 落库做**内部收益统计/对账**。
+客户端在广告**展示后**(`onAdShow` 读 `getShowEcpm()`)调用,把本次展示的 eCPM 落库做**内部收益统计/对账**。激励视频每次展示上报一条;**信息流轮播每条展示各上报一条**(每条独立 `ad_session_id`),作为「广告收益报表」展示条数/收益的数据源(见 [admin-ad-revenue-report](./admin-ad-revenue-report.md))。`app_env` + `our_code_id` 供报表按「我们的应用 / 我们配置的代码位」聚合,与 `adn`/`slot_id`(底层填充渠道/rit)是两组不同口径。

 - 普通激励视频发奖会先用 S2S 回调自带 `ecpm`;若缺失,再按 `ad_session_id` 读取本接口上报的 eCPM;两边都没有则不发并记录异常。
 - **best-effort**:客户端 fire-and-forget,但普通激励视频若 S2S 缺 eCPM,这条上报会成为发奖依据。
@@ -14,8 +14,10 @@
 | `ad_session_id` | string\|null | 否 | 客户端生成的一次信息流广告会话 id，用于对账/排查 |
 | `ecpm` | string | 是 | 本条信息流广告 eCPM(穿山甲 getEcpm 原值)，按“分/千次展示”处理(非元) |
 | `duration_seconds` | int | 是 | 实际展示/播放秒数 |
-| `adn` | string\|null | 否 | 实际投放 ADN |
-| `slot_id` | string\|null | 否 | 实际展示代码位 |
+| `adn` | string\|null | 否 | 实际投放 ADN(聚合后实际填充的子渠道) |
+| `slot_id` | string\|null | 否 | 实际展示代码位(底层 mediation rit) |
+| `app_env` | string\|null | 否 | **我们的**应用环境:`prod`(傻瓜比价正式) / `test`(测试应用) |
+| `our_code_id` | string\|null | 否 | **我们后台配置的**代码位 ID(104xxx,非底层 rit);供广告收益报表按代码位聚合金币 |

 ## 响应

@@ -0,0 +1,108 @@
+# Admin 广告收益报表
+
+> 所属:Admin 组(前缀 `/admin/api/ad-revenue-report`) | 鉴权:Admin Bearer(任意已登录 admin,只读) | [← 返回 API 索引](./README.md)
+
+按 **用户 × 日期 × 广告类型 × 我们的应用 × 我们的代码位** 聚合,回答「每个用户某天、每类广告(激励视频 / 信息流 / 历史 Draw)分别**看了多少条**、**收益多少**、按现算法**发了多少金币**、广告来自**哪个应用的哪个代码位**」。**纯只读**,不发币、不改数据,也**不改发奖逻辑**。
+
+相关表:[ad_ecpm_record](../database/ad_ecpm_record.md)、[ad_reward_record](../database/ad_reward_record.md)、[ad_feed_reward_record](../database/ad_feed_reward_record.md)。
+
+## 数据来源(三流合并,聚合键 = user × ad_type × app_env × our_code_id)
+
+| 指标 | 来源表 | 口径 |
+|---|---|---|
+| 展示条数 `impressions` | `ad_ecpm_record` | 每行 = 客户端一次广告展示。激励视频每次展示上报一条;**信息流轮播每条展示各上报一条**(每条独立 `ad_session_id`) |
+| 收益 `revenue_yuan` | `ad_ecpm_record` | `Σ(eCPM元 ÷ 1000)`,即每条展示预估收益累加(eCPM 原值是分,÷100 转元;÷1000 是每千次→单次)。**预估口径,非结算;测试应用多为 0** |
+| 应发/实发金币 `expected_coin`/`actual_coin` | `ad_reward_record`(reward_video)+ `ad_feed_reward_record`(feed) | **复用金币审计逐条复算**(`ad_audit.audit_rows`,与正式发奖同一公式口径,不另写公式),按同维度求和;`matched = 应发==实发`。**只读复算,不改发奖** |
+| 来源应用/代码位 `app_env`/`our_code_id` | 上述各表回填 | `prod`(傻瓜比价)/`test`(测试);代码位是**我们后台配的 104xxx**,非底层 rit |
+| 底层渠道 `adns` | `ad_ecpm_record` | 实际填充的 ADN 子渠道集合(pangle/gdt/...),附加参考 |
+
+展示与金币来自不同表,做**并集**:有展示无金币(用户中途关、未达发奖)、有金币无展示(未上报 eCPM)各自成行。
+
+## GET /admin/api/ad-revenue-report — 聚合报表
+
+- 入参(均 query,可选):
+  | 参数 | 类型 | 默认 | 说明 |
+  |---|---|---|---|
+  | `date_from` | string | 今天 | 起始日 北京时间 `YYYY-MM-DD` |
+  | `date_to` | string | =`date_from` | 结束日 北京时间 `YYYY-MM-DD`,**闭区间**;单日时与 `date_from` 相同 |
+  | `user_id` | int | 全部 | 只看某用户;不传=所有用户 |
+  | `ad_type` | string | 全部 | `reward_video` / `feed` / `draw`;不传=全部类型 |
+  | `granularity` | string | `day` | `day`=按天 / `hour`=按小时(聚合键再加北京时间小时 0–23);**区间>1 天建议用 day** |
+  | `limit` | int(1~1000) | 500 | **展示**明细组数(截断;`total`/`total_*`/`daily` 按全量统计不受影响) |
+
+  约束:`date_to` 不早于 `date_from`、区间最长 **92 天**、日期须 `YYYY-MM-DD`,否则 `422`。
+
+- 出参 `200`:`AdRevenueReportOut`
+  | 字段 | 类型 | 说明 |
+  |---|---|---|
+  | `date_from` / `date_to` | string | 报表起止日期(闭区间) |
+  | `daily` | `AdRevenueDaily[]` | 按日期汇总序列(全量,供按天趋势图;不受 `limit` 影响) |
+  | `total` | int | 聚合组**总数**(全量,不受 `limit` 影响) |
+  | `truncated` | bool | 明细是否被 `limit` 截断 |
+  | `total_impressions` | int | 全量展示条数合计 |
+  | `total_revenue_yuan` | float | 全量收益合计(元) |
+  | `total_expected_coin` | int | 全量应发金币合计 |
+  | `total_actual_coin` | int | 全量实发金币合计 |
+  | `mismatch_count` | int | 应发≠实发的组数(=0 说明全部按公式发放) |
+  | `items` | `AdRevenueRow[]` | 聚合明细(按 日期→用户→类型→代码位 排序) |
+
+### AdRevenueDaily(`daily[]` — 按天趋势)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `date` | string | 北京时间 `YYYY-MM-DD` |
+| `impressions` | int | 当天展示条数合计 |
+| `revenue_yuan` | float | 当天预估收益合计(元) |
+| `expected_coin` | int | 当天应发金币合计 |
+| `actual_coin` | int | 当天实发金币合计 |
+
+### AdRevenueRow(`items[]`)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `report_date` | string | 该组所属日期 北京时间 `YYYY-MM-DD` |
+| `user_id` | int | |
+| `ad_type` | string | `reward_video` / `feed` / `draw` |
+| `app_env` | string \| null | 我们的应用:`prod`(傻瓜比价)/`test`(测试);旧数据为空 |
+| `our_code_id` | string \| null | 我们配置的代码位 104xxx;旧数据为空 |
+| `hour` | int \| null | 北京时间小时 0–23(`granularity=hour` 时有值;按天为 null) |
+| `impressions` | int | 展示条数 |
+| `revenue_yuan` | float | 收益(元),预估口径 |
+| `expected_coin` | int | 应发金币(公式复算,与金币审计同源) |
+| `actual_coin` | int | 实发金币(实际入账) |
+| `matched` | bool | 该组应发==实发(组内任一条不符则 false) |
+| `adns` | string[] | 底层填充 ADN 子渠道集合 |
+| `impression_records` | `AdRevenueImpression[]` | 该组**逐条展示明细**(前端展开下钻);只要有展示就非空 |
+| `records` | `AdRevenueRecord[]` | 该组**逐条发奖复算明细**(前端展开下钻);纯展示无发奖的组为空 |
+
+### AdRevenueImpression(`items[].impression_records[]` — 展开「展示明细」)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `id` | int | ad_ecpm_record 主键 |
+| `created_at` | datetime | |
+| `ecpm` | string | 本次展示 eCPM 原始值(分/千次展示) |
+| `revenue_yuan` | float | 本次展示预估收益(元)= eCPM元 ÷ 1000 |
+| `adn` | string \| null | 实际填充 ADN 子渠道 |
+| `slot_id` | string \| null | 底层 mediation rit(非我们配置的广告位 ID) |
+
+### AdRevenueRecord(`items[].records[]` — 展开「发奖明细」)
+还原金币审计的逐条列,与发奖同一复算口径。
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `record_id` | int | 发奖记录主键 |
+| `created_at` | datetime | |
+| `status` | string | `granted` / `capped` / `ecpm_missing` |
+| `ecpm` | string \| null | 本次采用的 eCPM 原始值 |
+| `ecpm_factor` | float \| null | 因子1(eCPM 档);非 granted 为空 |
+| `units` | int | 折算份数:激励视频恒 1;信息流 = 满 10 秒份数 |
+| `lt_index_start` / `lt_index_end` | int \| null | 占用「账号累计第几份」的起止 |
+| `lt_factor_start` / `lt_factor_end` | float \| null | 因子2(LT)起止值 |
+| `expected_coin` | int | 应发金币 |
+| `actual_coin` | int | 实发金币 |
+| `matched` | bool | 该条复算与实发是否一致 |
+
+## 说明与局限
+
+- **展示 vs 发奖分离**:信息流轮播一会话可展示多条(都计入 `impressions`),但发奖仍按现规则(一会话发一次),`coin` 不因展示条数变化——这是有意设计(用户中途关只记展示不发奖)。
+- **历史 Draw 不可拆**:迁移(Draw→普通信息流)前,Draw 发奖混在 `ad_feed_reward_record` 且无类型标记,金币侧统一记 `feed`;迁移后 Draw 不再产生新数据。展示侧 `ad_type` 由客户端上报区分,故 `draw` 桶基本为空。
+- **来源字段从上线起齐全**:`app_env`/`our_code_id` 是本期新增列,历史记录为 NULL(报表来源列留空)。
+- **收益是预估**:基于客户端上报的 eCPM,非穿山甲后台结算值;以后台报表为结算权威。
+- **对账聚合级 + 逐条下钻**:行级 `matched` 给出该组(用户×类型×应用×代码位)应发是否==实发;**展开 `records` 即可看该组逐条明细**(eCPM/因子1/份数/LT/因子2/应发/实发/一致)定位到具体记录。独立逐条审计接口 [admin-ad-coin-audit](./admin-ad-coin-audit.md) 仍保留(同一复算口径,可全局按场景/只看不符筛选)。
@@ -6,7 +6,7 @@
 **multipart/form-data**:
 | 字段 | 类型 | 必填 | 说明 |
 |---|---|---|---|
-| `content` | string | ✓ | 反馈正文,**1-2000 字**(strip 后) |
+| `content` | string | ✓ | 反馈正文,**1-200 字**(strip 后) |
 | `contact` | string | ✗ | 联系方式(微信/QQ/手机号),**≤128 字**。原型改版后客户端已不再采集、不传该字段(后端默认空串);保留字段兼容旧端 |
 | `images` | file[] | ✗ | 截图,**最多 6 张**,每张走头像同款校验(JPEG/PNG/WebP,≤ 5 MB,魔数嗅探) |

@@ -29,7 +29,7 @@
 > 不返回上传的 image URL——这是给运营后台看的,客户端通常不需要。

 ## 错误码
- `400` 内容为空 / 内容超 2000 字 / 联系方式超 128 字 / 图片超 6 张 / 单图非法(空/过大/格式不对)
+- `400` 内容为空 / 内容超 200 字 / 联系方式超 128 字 / 图片超 6 张 / 单图非法(空/过大/格式不对)
 - `401` 未带 token / token 无效或过期 / 用户被禁用
 - `422` 缺 `content` 字段