@ (#111)

docs/api目录文档分类和补全

---------

Co-authored-by: guke <guke@autohome.com.cn>
Reviewed-on: #111

docs/api/admin/ad/admin-ad-coin-audit.md

@@ -0,0 +1,71 @@
+# Admin 看广告金币审计
+
+> 所属:Admin 组(前缀 `/admin/api/ad-coin-audit`) | 鉴权:Admin Bearer(任意已登录 admin,只读) | [← 返回 API 索引](../../README.md)
+
+把「看视频赚金币」(`ad_reward_record`)和「比价信息流广告」(`ad_feed_reward_record`)两类发奖记录,用与**正式发奖完全相同**的公式 [`app/core/rewards.py` `calculate_ad_reward_coin`](../../app/core/rewards.py) 复算一遍 `expected_coin`,与实际入账的 `actual_coin` 对比,核对金币公式是否生效。**纯只读对账**,不发币、不改任何数据。
+
+相关表:[ad_reward_record](../database/ad_reward_record.md)、[ad_feed_reward_record](../database/ad_feed_reward_record.md)。
+
+## 金币公式(展示参照)
+
+```
+eCPM元 = getEcpm分 ÷ 100
+单份金币 = round( eCPM元 ÷ 1000 × 因子1 × 因子2 × coin_per_yuan )   # coin_per_yuan=10000
+```
+- **eCPM 口径**:`getEcpm()` 原值单位是分/千次展示;先 ÷100 转元,**因子判档与收益换算都用元**。
+- **因子1(eCPM 档,阈值单位=元/千次)**:≤100→0.1,101–200→0.3,201–400→0.4,>400→0.6(即 ¥100/¥200/¥400 CPM 分界。**真实 eCPM 多 <¥100 CPM,故常落最低档 0.1,高档基本不触发——产品有意取舍**)。
+- **因子2(LT,当日第 N 份)**:第1→2.0,第2→1.5,第3→1.3,第4–10→1.1,≥11→1.0。
+- **第 N 份的计数**:看视频每条 granted 记 1 份;信息流每满 10 秒记 1 份。**两个点位各自独立计数**(看视频的份数不影响信息流的份数,反之亦然)。
+
+## GET /admin/api/ad-coin-audit — 复算对比
+
+- 入参(均 query,可选):
+  | 参数 | 类型 | 默认 | 说明 |
+  |---|---|---|---|
+  | `date` | string | 今天 | 北京时间 `YYYY-MM-DD`,审计某天 |
+  | `user_id` | int | 全部 | 只看某用户;不传=所有用户 |
+  | `scene` | string | 两类 | `reward_video` / `feed`;不传=两类都返回 |
+  | `limit` | int(1~500) | 100 | **展示**明细条数(按时间倒序截断;**份序号在截断前已按全天数据算好**,不影响复算正确性) |
+  | `only_mismatch` | bool | false | 只展示不一致(✗)行;统计数仍按全量,不受影响 |
+
+- 出参 `200`:`AdCoinAuditOut`
+  | 字段 | 类型 | 说明 |
+  |---|---|---|
+  | `date` | string | 审计日期 |
+  | `formula` | object | 当前公式参数快照(见下) |
+  | `total` | int | 该筛选下复算**总条数**(全量,不受 `limit`/`only_mismatch` 影响) |
+  | `mismatch_count` | int | **全量**不一致条数(截断前统计,可信);**=0 说明全部按公式发放** |
+  | `truncated` | bool | 展示集是否被 `limit` 截断(true=还有未返回的明细,请缩小范围或调大 `limit`) |
+  | `items` | `AdCoinAuditRow[]` | 展示明细(见下);`only_mismatch=true` 时只含 ✗ 行 |
+
+### AdCoinFormulaOut(`formula`)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `description` | string | 公式文字说明 |
+| `coin_per_yuan` | int | 金币:元 汇率(10000) |
+| `ecpm_unit` | string | eCPM 口径(分/千次展示,SDK getEcpm 原值) |
+| `feed_unit_seconds` | int | 信息流每多少秒折 1 份(10) |
+| `ecpm_factor_tiers` | `[因子, 下限, 上限\|null][]` | 因子1 档位表(直接读发奖常量,与发奖同源) |
+| `lt_factor_tiers` | `[因子, 下限, 上限\|null][]` | 因子2 LT 档位表 |
+
+### AdCoinAuditRow(`items[]`)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `scene` | string | `reward_video` / `feed` |
+| `record_id` | int | 对应记录表主键 |
+| `user_id` | int | |
+| `created_at` | datetime | |
+| `status` | string | `granted` / `capped`(超每日上限未发) / `ecpm_missing`(缺 eCPM 未发) |
+| `ecpm` | string \| null | 本次采用的 eCPM 原始值 |
+| `ecpm_factor` | float \| null | 因子1;非 granted 为 null |
+| `units` | int | 折算份数:看视频恒 1;信息流 = 满 10 秒份数 |
+| `lt_index_start` / `lt_index_end` | int \| null | 本条占用「当日第几份」的起止(看视频起=止;信息流一条可跨多份) |
+| `lt_factor_start` / `lt_factor_end` | float \| null | 因子2 的起止值(信息流跨份时会衰减,故给区间) |
+| `expected_coin` | int | 按公式复算应发金币(非 granted 恒 0) |
+| `actual_coin` | int | 实际入账金币 |
+| `matched` | bool | 复算与实发是否一致;非 granted 校验实发是否确为 0 |
+
+## 说明
+- **非 granted 行**(capped/ecpm_missing)不占用份序号、应发恒 0,`matched` 用于校验「该不发的确实没发」。
+- 用法建议:**按 `user_id`+`date` 定位某次具体核对**最直观;不带 `user_id` 是全用户当天概览。
+- 本地联调造数:debug 包看完激励视频会调 [`/api/v1/ad/test-grant`](./ad-test-grant.md),它会用客户端按 `ad_session_id` 上报的真实 eCPM 发奖(取不到兜底 200),所以本审计能看到真实 eCPM 对应的金币。

docs/api/admin/ad/admin-ad-revenue-report.md

@@ -0,0 +1,135 @@
+# 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`;不传=全部类型 |
+  | `feed_scene` | string | 全部 | `comparison`(比价)/ `coupon`(领券)/ `welfare`(福利);**全局筛选**,同时作用于明细 / 合计 / `daily`·`hourly` 趋势;不传=全部场景 |
+  | `granularity` | string | `day` | `day`=按天 / `hour`=按小时(聚合键再加北京时间小时 0–23);**区间>1 天建议用 day** |
+  | `limit` | int(1~1000) | 500 | **每页条数**(分页大小);`total`/`total_*`/`daily`/`hourly` 按全量统计不受分页影响 |
+  | `offset` | int(≥0) | 0 | 分页偏移(已跳过条数)=(页码−1)×`limit` |
+  | `sort` | string | `time` | 明细排序:`time`=按时间倒序(新→旧) / `ecpm`=按 eCPM 数值倒序 |
+
+  约束:`date_to` 不早于 `date_from`、区间最长 **92 天**、日期须 `YYYY-MM-DD`,否则 `422`。
+
+- 出参 `200`:`AdRevenueReportOut`
+  | 字段 | 类型 | 说明 |
+  |---|---|---|
+  | `date_from` / `date_to` | string | 报表起止日期(闭区间) |
+  | `daily` | `AdRevenueDaily[]` | 按日期汇总序列(全量,供按天趋势图;不受分页影响) |
+  | `hourly` | `AdRevenueHourly[]` | 按小时汇总序列(全量,供按小时趋势图;**仅 `granularity=hour` 时非空**;不受分页影响) |
+  | `type_stats` | `{[ad_type]: AdRevenueTypeStat}` | 按广告类型(`ad_type`)小计(全量);前端取 `draw` / `reward_video` 做分类大盘 |
+  | `dau` | int \| null | 今日活跃用户数(复用大盘口径 `last_login_at`,今日登录过);**仅查询=今日单天时有值**,历史/多天为 `null` |
+  | `total` | int | 当前筛选下的**分页总条数**(全量,不受分页影响;= 前端分页器 total) |
+  | `truncated` | bool | 当前页之后是否还有更多事件(`len(events) > offset + limit`) |
+  | `total_impressions` | int | 全量展示条数合计 |
+  | `total_revenue_yuan` | float | 全量**客户端预估**收益合计(元;eCPM 折算) |
+  | `total_pangle_revenue_yuan` | float \| null | 全量**穿山甲后台预估**收益合计(元;GroMore `revenue`)。穿山甲无用户/类型/场景维度,**仅全量视图**(未按 `user_id`/`ad_type`/`feed_scene` 过滤)有值,否则 `null` |
+  | `total_pangle_api_revenue_yuan` | float \| null | 全量**穿山甲收益Api**合计(元;GroMore `api_revenue`,各 ADN 回传更接近结算);未配 Reporting / 查当天 / 非全量视图为 `null` |
+  | `pangle_revenue_available` | bool | 本次是否带穿山甲后台收益(=全量视图且对应日期已同步到 `ad_pangle_daily_revenue`) |
+  | `total_expected_coin` | int | 全量应发金币合计 |
+  | `total_actual_coin` | int | 全量实发金币合计 |
+  | `mismatch_count` | int | 应发≠实发的组数(=0 说明全部按公式发放) |
+  | `items` | `AdRevenueRow[]` | 逐条广告事件(**按时间倒序:新→旧**);`limit`/`offset` 对全量做分页切片,返回当前页 |
+
+### AdRevenueDaily(`daily[]` — 按天趋势)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `date` | string | 北京时间 `YYYY-MM-DD` |
+| `impressions` | int | 当天展示条数合计 |
+| `revenue_yuan` | float | 当天客户端预估收益合计(元;eCPM 折算) |
+| `pangle_revenue_yuan` | float \| null | 当天穿山甲后台预估收益(元;GroMore `revenue`);非全量视图 / 无数据为 `null` |
+| `pangle_api_revenue_yuan` | float \| null | 当天穿山甲收益Api(元;GroMore `api_revenue`);未配 / 当天 / 无数据为 `null` |
+| `expected_coin` | int | 当天应发金币合计 |
+| `actual_coin` | int | 当天实发金币合计 |
+
+### AdRevenueHourly(`hourly[]` — 按小时趋势,仅 `granularity=hour` 时非空)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `hour` | int | 北京时间小时 0–23 |
+| `impressions` | int | 该小时展示条数合计 |
+| `revenue_yuan` | float | 该小时预估收益合计(元) |
+| `expected_coin` | int | 该小时应发金币合计 |
+| `actual_coin` | int | 该小时实发金币合计 |
+
+### AdRevenueTypeStat(`type_stats[ad_type]` — 分广告类型小计,供大盘第二行)
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `impressions` | int | 该类型展示条数合计 |
+| `revenue_yuan` | float | 该类型预估收益合计(元);eCPM 由前端用 收益÷展示×1000 算 |
+
+### 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(报表来源列留空)。
+- **逐条/明细的收益是预估**:`items[].revenue_yuan` 基于客户端上报的 eCPM 折算,非穿山甲后台结算值。
+- **穿山甲后台收益(汇总/趋势级)**:`total_pangle_revenue_yuan`(预估 `revenue`)与 `total_pangle_api_revenue_yuan`(收益Api `api_revenue`,更接近结算)来自穿山甲 **GroMore 数据 API**(`integrations/pangle_report` + `scripts/sync_pangle_revenue` 按天 T+1 拉取入 [ad_pangle_daily_revenue](../database/ad_pangle_daily_revenue.md))。穿山甲**不提供分用户/设备/类型/场景维度**(官方明确),最细到 日期×应用×代码位,故只用于汇总与按天趋势的对照,**不挂到逐条事件行**;且仅在全量视图(未按 user/类型/场景过滤)展示。配置见 `.env` 的 `PANGLE_REPORT_*`。
+- **对账聚合级 + 逐条下钻**:行级 `matched` 给出该组(用户×类型×应用×代码位)应发是否==实发;**展开 `records` 即可看该组逐条明细**(eCPM/因子1/份数/LT/因子2/应发/实发/一致)定位到具体记录。独立逐条审计接口 [admin-ad-coin-audit](./admin-ad-coin-audit.md) 仍保留(同一复算口径,可全局按场景/只看不符筛选)。