小川 / SdkGitbook

Download as
Browse Code »

Commit 900685008af24058a2cb1f92c3f6f358bf6984ae

Authored by 小川 费
1 parent 84a193fb
Exists in master

图片支持点击查看大图

Showing 14 changed files with 184 additions and 28 deletions   Show diff stats
README.md
  Diff comments   View file @9006850
... ... @@ -31,7 +31,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，
31 31  
32 32  
33 33 **噗嗤后台概览：**
34   -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png)
  34 +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图")
35 35  
36 36  
37 37  
... ...
SUMMARY.md
  Diff comments   View file @9006850
... ... @@ -21,6 +21,6 @@
21 21 * [打开客服消息](platform_common.md#service)
22 22 * [震动接口](platform_common.md#vibrate)
23 23 * [其他接口](platform_common.md#other)
24   -* [数据模块](data.md)
  24 +* [数据模块✔️](data.md)
25 25 * [事件模块](event.md)
26 26 * [FAQ](faq.md)
27 27 \ No newline at end of file
... ...
book.json
  Diff comments   View file @9006850
... ... @@ -35,6 +35,7 @@
35 35 "klipse@^1.2.0",
36 36 "versions-select@^0.1.1",
37 37 "graph@^0.1.0",
38   - "chart@^0.2.0"
  38 + "chart@^0.2.0",
  39 + "popup"
39 40 ]
40 41 }
... ...
data.md 0 → 100644
  Diff comments   View file @9006850
... ... @@ -0,0 +1,155 @@
  1 +
  2 +# 数据模块
  3 +
  4 +------
  5 +
  6 +#### **简介**
  7 +
  8 +此模块为开发者提供游戏用到的一些数据信息，例如：config.js配置的GameId，ChannelId、从分享链接进入query携带的参数（share_id/share_key/invite_user_uid/channel_id）、setLogind设置的用户ID(userId)和用户注册时间(regTime)等等，详细请阅读下面的api。
  9 +
  10 +
  11 +
  12 +#### **API：**
  13 +
  14 +| **名称** | **功能说明** |
  15 +| ------------------------------- | ------------------------------------------------------------ |
  16 +| PCSDK.data.GameId | 获取游戏的GameId |
  17 +| PCSDK.data.ChannelId| 获取游戏渠道ID |
  18 +| PCSDK.data.UserId | 获取用户ID|
  19 +| PCSDK.data.RegTime | 获取用户注册时间 |
  20 +| PCSDK.data.ShareId | 获取进入游戏的分享会话ID，不是从分享会话进入ShareId为0 |
  21 +| PCSDK.data.ShareKey | 接入SDK的分享视频模块后，从分享会话进去游戏，获取到分享会话的分享key |
  22 +| PCSDK.data.Platform | 获取游戏运行平台环境：devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备） |
  23 +| PCSDK.data.QueryUserInviteUid | 获取此次分享会话进入游戏，分享来源者用户ID |
  24 +
  25 +
  26 +
  27 +1. ##### **GameId**
  28 +
  29 + ```javascript
  30 + PCSDK.data.GameId: number
  31 + ```
  32 +
  33 + 定义：获取游戏的GameId，该值来源于congfig.js中的【GameId】配置。详细[阅读config.js的GameId参数详解](install.md#config_env)
  34 +
  35 + 示例：
  36 +
  37 + ```javascript
  38 + let gameId = PCSDK.data.GameId;
  39 + ```
  40 +2. ##### **ChannelId**
  41 +
  42 + ```javascript
  43 + PCSDK.data.ChannelId: number
  44 + ```
  45 +
  46 + 定义：获取游戏的渠道Id，该值来源于congfig.js中的【ChannelId】配置。详细[阅读config.js的ChannelId参数详解](install.md#config_env)
  47 +
  48 + 示例：
  49 +
  50 + ```javascript
  51 + let channelId = PCSDK.data.ChannelId;
  52 + ```
  53 +3. ##### **UserId**
  54 +
  55 + ```javascript
  56 + PCSDK.data.UserId: number | string
  57 + ```
  58 +
  59 + 定义：获取用户ID，该值来源于[启动打点setLogind](stat_active.md#stat_login)设置的userId
  60 +
  61 + 示例：
  62 +
  63 + ```javascript
  64 + let userId = PCSDK.data.UserId;
  65 + ```
  66 +4. ##### **RegTime**
  67 +
  68 + ```javascript
  69 + PCSDK.data.RegTime: number
  70 + ```
  71 +
  72 + 定义：获取用户第一次创角的时间戳，该值来源于[启动打点setLogind](stat_active.md#stat_login)设置的regTime
  73 +
  74 + 示例：
  75 +
  76 + ```javascript
  77 + let regTime = PCSDK.data.RegTime;
  78 + ```
  79 +5. ##### **ShareId**
  80 +
  81 + ```javascript
  82 + PCSDK.data.ShareId: number
  83 + ```
  84 +
  85 + 定义：接入SDK的分享视频模块，分享出去的链接query会携带share_id参数，从分享会话点入游戏，获取此次分享会话的shareId，不是从分享会话点入游戏ShareId为0
  86 +
  87 + 示例：成功结算奖励双倍分享，后台配置的信息：shareId: 680 shareKey: success_double，其他用户从此条分享进入
  88 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_022.png "点击查看大图🔍")
  89 +
  90 + ```javascript
  91 + // shareId的值为：680
  92 + let shareId = PCSDK.data.ShareId;
  93 + ```
  94 +6. ##### **ShareKey**
  95 +
  96 + ```javascript
  97 + PCSDK.data.ShareKey: string
  98 + ```
  99 +
  100 + 定义：接入SDK的分享视频模块，分享出去的链接query会携带share_key参数，从分享会话点入游戏，获取此次分享会话的shareKey，不是从分享会话点入游戏ShareKey为''
  101 +
  102 + 示例：成功结算奖励双倍分享，后台配置的信息：shareId: 680 shareKey: success_double，其他用户从此条分享进入
  103 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_022.png "点击查看大图🔍")
  104 +
  105 + ```javascript
  106 + // shareKey的值为：success_double
  107 + let shareKey = PCSDK.data.ShareKey;
  108 + ```
  109 +7. ##### **Platform**
  110 +
  111 + ```javascript
  112 + PCSDK.data.Platform: string
  113 + ```
  114 +
  115 + 定义：获取游戏运行平台环境：devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备）
  116 +
  117 + 示例：
  118 +
  119 + ```javascript
  120 + let platform = PCSDK.data.Platform;
  121 + switch (platform) {
  122 + case 'devtools': // 开发者工具
  123 +
  124 + break;
  125 +
  126 + case 'ios': // 苹果设备
  127 +
  128 + break;
  129 +
  130 + case 'android': // 安卓设备
  131 +
  132 + break;
  133 + }
  134 + ```
  135 +8. ##### **QueryUserInviteUid**
  136 +
  137 + ```javascript
  138 + PCSDK.data.QueryUserInviteUid: any
  139 + ```
  140 +
  141 + 定义：获取此次分享会话进入游戏，分享来源者用户userId
  142 +
  143 + 接入SDK的分享视频模块，分享出去的链接query会携带invite_user_uid参数，从分享会话点入游戏，获取此次分享会话的邀请者id: invite_user_uid，不是从分享会话点入游戏QueryUserInviteUid为0。
  144 + >>>开发者不接入SDK分享视频模块，游戏分享url的query参数必须要加入以下两个参数channel_id与user_invite_uid：channel_id的值通过ChannelId api获取，user_invite_uid的值可通过UserId api获取，也可以开发者从游戏中得到。
  145 + >>>每次分享query请携带：
  146 + ```javascript
  147 + `channel_id=${ PCSDK.data.ChannelId }&user_invite_uid=${ PCSDK.data.UserId }`
  148 + ```
  149 +
  150 + 示例：
  151 +
  152 + ```javascript
  153 + // 从分享会话邀请链接进入，获得的值为邀请者用户id，不是分享会话邀请进入获取值为0
  154 + let inviteUid = PCSDK.data.QueryUserInviteUid;
  155 + ```
0 156 \ No newline at end of file
... ...
install.md
  Diff comments   View file @9006850
... ... @@ -16,7 +16,7 @@
16 16 | └── game.min.js
17 17 ```
18 18  
19   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_001.png)
  19 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_001.png "🔍点击查看大图")
20 20  
21 21 - **sdk.d.ts：sdk的ts声明文件，开发者项目采用Typescript开发，请复制该文件到项目中。**
22 22 - sdk/config.js：sdk配置文件，【[详细请阅读下方config.js参数说明](install.md#config)】
... ... @@ -51,7 +51,7 @@
51 51  
52 52 示例：将sdk放入到小游戏开发者工具项目的src文件夹中
53 53  
54   - ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png)
  54 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png "🔍点击查看大图")
55 55  
56 56  
57 57  
... ... @@ -60,7 +60,7 @@
60 60 * #### 在game.js中将sdk.js文件使用require导入。
61 61  
62 62 示例：将sdk放入到小游戏开发者工具项目的src文件夹中
63   - ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png)
  63 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png "🔍点击查看大图")
64 64  
65 65  
66 66  
... ... @@ -169,7 +169,7 @@
169 169  
170 170 在后台的【分享/视频配置】栏目配置了一条分享key为：forward的分享配置
171 171  
172   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png)
  172 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png "🔍点击查看大图")
173 173  
174 174 8. **ShareData( object )：**此配置在【IsUseShareModule: true】起效，开发者如果接入了分享视频模块，>>> 请务必配置一条 <<<。
175 175  
... ... @@ -190,7 +190,7 @@
190 190  
191 191 操作步骤：
192 192  
193   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png)
  193 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png "🔍点击查看大图")
194 194  
195 195 9. **GameId：必填，游戏id，请联系运营人员提供**
196 196  
... ... @@ -224,7 +224,7 @@
224 224  
225 225 示例：项目采用的是Laya Typescript版本进行开发，将该文件复制到libs目录下面
226 226  
227   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png)
  227 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png "🔍点击查看大图")
228 228  
229 229 * #### 到此，SDK的准备工作已经配置完毕，运行起来：
230 230  
... ...
intro.md
  Diff comments   View file @9006850
... ... @@ -36,7 +36,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，
36 36  
37 37  
38 38 **后台概览：**
39   -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png)
  39 +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图")
40 40  
41 41  
42 42  
... ...
modules.md
  Diff comments   View file @9006850
... ... @@ -31,7 +31,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，
31 31  
32 32  
33 33 **噗嗤后台概览：**
34   -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png)
  34 +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图")
35 35  
36 36  
37 37  
... ...
online.md
  Diff comments   View file @9006850
... ... @@ -15,7 +15,7 @@
15 15  
16 16 设置在线配置参数，登录后台->头部tab切换到【游戏数据】->【配置相关】->【配置参数】可新增、编辑修改参数值，配置完毕后，通过online模块相关的api使用：
17 17  
18   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_021.png)
  18 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_021.png "🔍点击查看大图")
19 19  
20 20  
21 21  
... ...
platform.md
  Diff comments   View file @9006850
... ... @@ -11,11 +11,11 @@
11 11 #### **后台使用**
12 12  
13 13 完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息：
14   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png)
  14 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png "🔍点击查看大图")
15 15  
16 16 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息：
17 17  
18   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png)
  18 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png "🔍点击查看大图")
19 19  
20 20  
21 21  
... ...
stat.md
  Diff comments   View file @9006850
... ... @@ -11,11 +11,11 @@
11 11 #### **后台使用**
12 12  
13 13 完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息：
14   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png)
  14 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.pn "🔍点击查看大图")
15 15  
16 16 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息：
17 17  
18   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png)
  18 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png "🔍点击查看大图")
19 19  
20 20  
21 21  
... ...
stat_active.md
  Diff comments   View file @9006850
... ... @@ -77,7 +77,7 @@
77 77 ```
78 78  
79 79 2. **setLogind**
80   -
  80 + <div id="stat_login"></div>
81 81 ```javascript
82 82 PCSDK.stat.setLogind( data: object ): void
83 83 ```
... ...
stat_ads.md
  Diff comments   View file @9006850
... ... @@ -12,15 +12,15 @@
12 12  
13 13 1. 交叉悬浮广告框，放置到首页、结算页
14 14  
15   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png)
  15 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png "🔍点击查看大图")
16 16  
17 17 2. 交叉抽屉式广告位，放置到首页、结算页
18 18  
19   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png)
  19 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png "🔍点击查看大图")
20 20  
21 21 3. 交叉猜你喜欢广告位，推荐放置到结算页
22 22  
23   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png)
  23 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png "🔍点击查看大图")
24 24  
25 25  
26 26  
... ... @@ -30,7 +30,7 @@
30 30  
31 31 完成接入交叉推广位后，登录后台->头部tab切换到【游戏数据】->【流量分析】->【广告导出】即可查看推广位的各项数据信息（需要后台管理人员添加权限）：
32 32  
33   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png)
  33 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png "🔍点击查看大图")
34 34  
35 35  
36 36  
... ... @@ -81,13 +81,13 @@
81 81  
82 82 1、开发者复制上面的10个其他游戏的appid，配置到game.json的navigateToMiniProgramAppIdList参数：
83 83  
84   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_010.png)
  84 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_010.png "🔍点击查看大图")
85 85  
86 86 2、修改[config.js的Env配置](install.md#config_env)为110，开发者测试联调阶段，走测试环境
87 87  
88 88 > 提示：广告位接入完毕测试通过，提交审核前，修改Env为100。
89 89  
90   - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_011.png)
  90 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_011.png "🔍点击查看大图")
91 91  
92 92  
93 93  
... ...
stat_event.md
  Diff comments   View file @9006850
... ... @@ -10,7 +10,7 @@
10 10  
11 11 接入自定义事件打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】可查看自定义事件次数、去重人数等详细信息（此功能需要管理员添加权限）：
12 12  
13   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_018.png)
  13 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_018.png "🔍点击查看大图")
14 14  
15 15  
16 16  
... ... @@ -18,9 +18,9 @@
18 18  
19 19 接入自定义事件打点前，请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件的key：登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】->点击【新增】添加自定义事件（事件key可语义化的自定义，推荐_连接）。
20 20  
21   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png)
  21 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png "🔍点击查看大图")
22 22  
23   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_017.png)
  23 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_017.png "🔍点击查看大图")
24 24  
25 25 > 提示：游戏新增自定义事件如果很多，一个个复制可能比较繁琐，进入噗嗤后台【事件列表】后，chrome浏览器打开【开发者工具】，在console栏下方输入下面的命令后，可自动生成自定义事件key的枚举（如果事件很多出现翻页，则每一页都执行后，手动合并为一个枚举），复制到项目中使用，枚举key生成规则为事件key转换为大驼峰式，枚举value为事件key：
26 26  
... ... @@ -32,7 +32,7 @@
32 32 PCPlugins.transform('EventKeys', 1 , 2 , { any: false});
33 33 ```
34 34  
35   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_019.png)
  35 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_019.png "🔍点击查看大图")
36 36  
37 37  
38 38  
... ...
stat_level.md
  Diff comments   View file @9006850
... ... @@ -10,7 +10,7 @@
10 10  
11 11 接入关卡分析接口后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【关卡分析】可查看关卡进入用户数据、失败次数、失败率、平均完成时间等）：
12 12  
13   -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_020.png)
  13 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_020.png "🔍点击查看大图")
14 14  
15 15  
16 16  
... ...