找物源码导读Cocos Creator 3.8 · assets/scripts
0%
已读 0 / 424
目录— 个文件
目录加载中…
…/bridge/sdk/SdkReport.ts
1import { Framework } from "../../framework/Framework";
2import { SdkReportAccess } from "../../framework/module/sdk/SdkDefine";
3import { Runtime } from "../../runtime/Runtime";
4import { GamePlayType } from "../../runtime/manager/game/base/define/GameDefine";
5import { SdkReportDefine } from "./SdkReportDefine";
6
7/** 寻物项目埋点规则;按请求读取玩法,不缓存 Runtime 状态。 */
8export const SdkReport: SdkReportAccess = {
9 GetRewardProperties(args: any): Record<string, string> {
10 let adScene = "unknown";
11 if (args != null && typeof args.ad_scene === "string" && args.ad_scene !== "") {
12 adScene = args.ad_scene;
13 }
14
15 // 按广告发起时的玩法固定类型,保证同一次广告的各阶段上报一致。
16 const isHotLevelUnlock = adScene === SdkReportDefine.RewardAd.ad_scene.hotLevelUnlock;
17 let gameType: string = SdkReportDefine.RewardAd.game_type.mainLine;
18 if (isHotLevelUnlock) {
19 // 大厅解锁热点优先按目标玩法归类,不受当前玩法影响。
20 gameType = SdkReportDefine.RewardAd.game_type.hotLevel;
21 } else if (adScene === SdkReportDefine.RewardAd.ad_scene.dailyChallengeMakeUp
22 || Runtime.GameFind.PlayType === GamePlayType.DailyChallenge) {
23 gameType = SdkReportDefine.RewardAd.game_type.dailyChallenge;
24 } else if (Runtime.GameFind.UsesHotspotConfig()) {
25 gameType = SdkReportDefine.RewardAd.game_type.hotLevel;
26 }
27
28 // 固定本次广告上下文,后续回调只更新行为及生命周期字段。
29 const rewardProps: Record<string, string> = {
30 [SdkReportDefine.RewardAd.field.ad_scene]: adScene,
31 [SdkReportDefine.RewardAd.field.game_type]: gameType,
32 };
33 if (isHotLevelUnlock) {
34 rewardProps[SdkReportDefine.RewardAd.field.level_id] = String(args.levelId);
35 }
36 return rewardProps;
37 },
38
39 /** 保留原胜负插屏映射,其他场景不单独上报。 */
40 GetInterReportScene(adScene: string): string | null {
41 switch (adScene) {
42 case "gamefind_fail_inter":
43 return SdkReportDefine.IntersAd.scene.gamefindFailInter;
44 case "gamefind_win_inter":
45 return SdkReportDefine.IntersAd.scene.gamefindWinInter;
46 default:
47 return null;
48 }
49 },
50
51 /** 非法 levelId 继续忽略并警告,不影响其他公共属性。 */
52 ValidateSuperProperty(key: string, value: any): boolean {
53 if (key === SdkReportDefine.levelId && !(typeof value === "number" && Number.isFinite(value) && value >= 1)) {
54 Framework.Log.Warn("SdkManager", "忽略非法 levelId 公共属性", value);
55 return false;
56 }
57 return true;
58 },
59
60 /** 友盟仍只缓存项目表约定的四个公共属性。 */
61 IsUmengSuperProperty(key: string): boolean {
62 return key === SdkReportDefine.ABTestGameEnter.field.test_id
63 || key === SdkReportDefine.levelId
64 || key === SdkReportDefine.tipNum
65 || key === SdkReportDefine.heartNum;
66 },
67};
讲解68 行
埋点规则人工通读

SdkReport.ts

实现框架要求的埋点策略接口,供 SDK 模块在广告、插屏与公共属性上报时回调。它按广告场景与当前玩法推断 game_type,过滤非法 levelId,并限定友盟只缓存四个公共属性。

先看 GetRewardProperties 里 game_type 的多级判断顺序,再看两个公共属性过滤方法的白名单。

特殊处理与易错点

8注释寻物项目埋点规则;按请求读取玩法,不缓存 Runtime 状态。
9方法按广告场景与当前玩法推断 game_type,热点解锁时附带目标关卡 ID,返回本次广告的固定字段表。
16注释按广告发起时的玩法固定类型,保证同一次广告的各阶段上报一致。
20注释大厅解锁热点优先按目标玩法归类,不受当前玩法影响。
29注释固定本次广告上下文,后续回调只更新行为及生命周期字段。
40方法只把 gamefind_fail_inter 与 gamefind_win_inter 映射为插屏场景常量,…
52方法检查 levelId 是否为大于等于 1 的有限数字,不合法时打印警告并返回 false。
61方法判断该键是否属于 test_id、levelId、tipNum、heartNum 四个友盟白名单属性。