Files
shaguabijia-app-server/docs/api/ad/ad-reward-result.md
T
2026-07-22 10:53:21 +08:00

3.2 KiB
Raw Blame History

GET /api/v1/ad/reward-result/{ad_session_id} — 查本次广告的权威发奖结果 + 本轮累计

客户端看完激励视频后轮询本接口,拿本次实发金币本轮累计用于「恭喜累计获得奖励」弹窗。不再用余额差 / coin_per_ad 估算。

纯只读:发奖仍只由验签过的 S2S 回调完成,本接口不写库、不产生任何奖励。按 user_id 收窄,被刷也只能查到自己的记录。

鉴权

需要 Bearer token。

路径参数

参数 类型 约束 说明
ad_session_id string 长度 8~64 本次广告会话 id,客户端生成,与 mediaExtra / ecpm-report 同值

响应

字段 类型 说明
ad_session_id string 回显请求值
status string pending(S2S 未到账,继续轮询) / granted / capped(当日超限) / ecpm_missing / closed_early(提前关闭)
coin int | null 本条实发金币。granted 为真实到账额;未发奖的状态为 0;pending 为 null
round_coin int | null 本轮累计已发金币(含本条) ← 弹窗显示的就是它
{ "ad_session_id": "3f2a9c1b7e4d8a60", "status": "granted", "coin": 20, "round_coin": 60 }

round_coin 的口径

「轮」= 用户点「去膨胀」到点「放弃赚钱」之间连看的若干条广告,边界由客户端的 boost_round_id 定(见 ad-pangle-callback)。

SELECT COALESCE(SUM(coin), 0) FROM ad_reward_record
WHERE user_id = :user_id                        -- 恒带,轮 id 是客户端生成的不可跨用户信任
  AND boost_round_id = :该会话记录的 boost_round_id
  AND status = 'granted'

由服务端求和而非客户端自己累加:客户端进程被杀 / 低内存重建后本地累计会丢,发奖记录不会。

要守住的不变量:弹窗数字 == 本轮实际到账之和 == 用户看到的余额涨幅。 三者对不上,用户就会认为少发了钱。

情形 round_coin
本条 granted 本轮累计(含本条)
本条 capped / closed_early / ecpm_missing 仍返本轮累计,该条按 0 计(撞上限那下的 toast 要能显示前几条的总额,不能是空)
status=pending(没记录) null —— 连属于哪一轮都不知道。不是 00 会被读成「本轮没赚到」
该记录没有 boost_round_id(老客户端 / extra 丢失) null,客户端退回只显示单条 coin

错误

  • 401: 未登录
  • 422: ad_session_id 长度不在 8~64

查不到记录不返 404,而是 200 + status="pending"。404 只应表示路由不存在;两者混在一起客户端没法区分「后端没部署」和「再等等」。

实现注意

同一 ad_session_id 可能有多条记录,取值时显式优先 granted,不能只取最近一条:

  • 客户端先报 closed_early、S2S 随后姗姗来迟 → 两条,granted 反而是后写的
  • 本地联调重复调 test-grant → 同 session 多条 grantedtrans_id 各不相同)

都没有 granted 才取最近一条,让客户端知道没发的原因。