diff --git a/README.md b/README.md index 336b4b4..c4609c2 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， **噗嗤后台概览：** -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png) +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图") diff --git a/SUMMARY.md b/SUMMARY.md index b27ea18..729afc7 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -21,6 +21,6 @@ * [打开客服消息](platform_common.md#service) * [震动接口](platform_common.md#vibrate) * [其他接口](platform_common.md#other) -* [数据模块](data.md) +* [数据模块✔️](data.md) * [事件模块](event.md) * [FAQ](faq.md) \ No newline at end of file diff --git a/book.json b/book.json index 8922a6c..642a5e0 100644 --- a/book.json +++ b/book.json @@ -35,6 +35,7 @@ "klipse@^1.2.0", "versions-select@^0.1.1", "graph@^0.1.0", - "chart@^0.2.0" + "chart@^0.2.0", + "popup" ] } diff --git a/data.md b/data.md new file mode 100644 index 0000000..7e23171 --- /dev/null +++ b/data.md @@ -0,0 +1,155 @@ + +# 数据模块 + +------ + +#### **简介** + +此模块为开发者提供游戏用到的一些数据信息，例如：config.js配置的GameId，ChannelId、从分享链接进入query携带的参数（share_id/share_key/invite_user_uid/channel_id）、setLogind设置的用户ID(userId)和用户注册时间(regTime)等等，详细请阅读下面的api。 + + + +#### **API：** + +| **名称** | **功能说明** | +| ------------------------------- | ------------------------------------------------------------ | +| PCSDK.data.GameId | 获取游戏的GameId | +| PCSDK.data.ChannelId| 获取游戏渠道ID | +| PCSDK.data.UserId | 获取用户ID| +| PCSDK.data.RegTime | 获取用户注册时间 | +| PCSDK.data.ShareId | 获取进入游戏的分享会话ID，不是从分享会话进入ShareId为0 | +| PCSDK.data.ShareKey | 接入SDK的分享视频模块后，从分享会话进去游戏，获取到分享会话的分享key | +| PCSDK.data.Platform | 获取游戏运行平台环境：devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备） | +| PCSDK.data.QueryUserInviteUid | 获取此次分享会话进入游戏，分享来源者用户ID | + + + +1. ##### **GameId** + + ```javascript + PCSDK.data.GameId: number + ``` + + 定义：获取游戏的GameId，该值来源于congfig.js中的【GameId】配置。详细[阅读config.js的GameId参数详解](install.md#config_env) + + 示例： + + ```javascript + let gameId = PCSDK.data.GameId; + ``` +2. ##### **ChannelId** + + ```javascript + PCSDK.data.ChannelId: number + ``` + + 定义：获取游戏的渠道Id，该值来源于congfig.js中的【ChannelId】配置。详细[阅读config.js的ChannelId参数详解](install.md#config_env) + + 示例： + + ```javascript + let channelId = PCSDK.data.ChannelId; + ``` +3. ##### **UserId** + + ```javascript + PCSDK.data.UserId: number | string + ``` + + 定义：获取用户ID，该值来源于[启动打点setLogind](stat_active.md#stat_login)设置的userId + + 示例： + + ```javascript + let userId = PCSDK.data.UserId; + ``` +4. ##### **RegTime** + + ```javascript + PCSDK.data.RegTime: number + ``` + + 定义：获取用户第一次创角的时间戳，该值来源于[启动打点setLogind](stat_active.md#stat_login)设置的regTime + + 示例： + + ```javascript + let regTime = PCSDK.data.RegTime; + ``` +5. ##### **ShareId** + + ```javascript + PCSDK.data.ShareId: number + ``` + + 定义：接入SDK的分享视频模块，分享出去的链接query会携带share_id参数，从分享会话点入游戏，获取此次分享会话的shareId，不是从分享会话点入游戏ShareId为0 + + 示例：成功结算奖励双倍分享，后台配置的信息：shareId: 680 shareKey: success_double，其他用户从此条分享进入 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_022.png "点击查看大图🔍") + + ```javascript + // shareId的值为：680 + let shareId = PCSDK.data.ShareId; + ``` +6. ##### **ShareKey** + + ```javascript + PCSDK.data.ShareKey: string + ``` + + 定义：接入SDK的分享视频模块，分享出去的链接query会携带share_key参数，从分享会话点入游戏，获取此次分享会话的shareKey，不是从分享会话点入游戏ShareKey为'' + + 示例：成功结算奖励双倍分享，后台配置的信息：shareId: 680 shareKey: success_double，其他用户从此条分享进入 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_022.png "点击查看大图🔍") + + ```javascript + // shareKey的值为：success_double + let shareKey = PCSDK.data.ShareKey; + ``` +7. ##### **Platform** + + ```javascript + PCSDK.data.Platform: string + ``` + + 定义：获取游戏运行平台环境：devtools（开发者调试工具）、ios(苹果设备)、android（安卓设备） + + 示例： + + ```javascript + let platform = PCSDK.data.Platform; + switch (platform) { + case 'devtools': // 开发者工具 + + break; + + case 'ios': // 苹果设备 + + break; + + case 'android': // 安卓设备 + + break; + } + ``` +8. ##### **QueryUserInviteUid** + + ```javascript + PCSDK.data.QueryUserInviteUid: any + ``` + + 定义：获取此次分享会话进入游戏，分享来源者用户userId + + 接入SDK的分享视频模块，分享出去的链接query会携带invite_user_uid参数，从分享会话点入游戏，获取此次分享会话的邀请者id: invite_user_uid，不是从分享会话点入游戏QueryUserInviteUid为0。 + >>>开发者不接入SDK分享视频模块，游戏分享url的query参数必须要加入以下两个参数channel_id与user_invite_uid：channel_id的值通过ChannelId api获取，user_invite_uid的值可通过UserId api获取，也可以开发者从游戏中得到。 + >>>每次分享query请携带： + ```javascript + `channel_id=${ PCSDK.data.ChannelId }&user_invite_uid=${ PCSDK.data.UserId }` + ``` + + 示例： + + ```javascript + // 从分享会话邀请链接进入，获得的值为邀请者用户id，不是分享会话邀请进入获取值为0 + let inviteUid = PCSDK.data.QueryUserInviteUid; + ``` \ No newline at end of file diff --git a/install.md b/install.md index 1204179..6a573cf 100644 --- a/install.md +++ b/install.md @@ -16,7 +16,7 @@ | └── game.min.js ``` -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_001.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_001.png "🔍点击查看大图") - **sdk.d.ts：sdk的ts声明文件，开发者项目采用Typescript开发，请复制该文件到项目中。** - sdk/config.js：sdk配置文件，【[详细请阅读下方config.js参数说明](install.md#config)】 @@ -51,7 +51,7 @@ 示例：将sdk放入到小游戏开发者工具项目的src文件夹中 - ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png) + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png "🔍点击查看大图") @@ -60,7 +60,7 @@ * #### 在game.js中将sdk.js文件使用require导入。 示例：将sdk放入到小游戏开发者工具项目的src文件夹中 - ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png) + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png "🔍点击查看大图") @@ -169,7 +169,7 @@ 在后台的【分享/视频配置】栏目配置了一条分享key为：forward的分享配置 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png "🔍点击查看大图") 8. **ShareData( object )：**此配置在【IsUseShareModule: true】起效，开发者如果接入了分享视频模块，>>> 请务必配置一条 <<<。 @@ -190,7 +190,7 @@ 操作步骤： - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png "🔍点击查看大图") 9. **GameId：必填，游戏id，请联系运营人员提供** @@ -224,7 +224,7 @@ 示例：项目采用的是Laya Typescript版本进行开发，将该文件复制到libs目录下面 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png "🔍点击查看大图") * #### 到此，SDK的准备工作已经配置完毕，运行起来： diff --git a/intro.md b/intro.md index 7f51951..019b69a 100644 --- a/intro.md +++ b/intro.md @@ -36,7 +36,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， **后台概览：** -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png) +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图") diff --git a/modules.md b/modules.md index 336b4b4..c4609c2 100644 --- a/modules.md +++ b/modules.md @@ -31,7 +31,7 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， **噗嗤后台概览：** -## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png) +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图") diff --git a/online.md b/online.md index 93019a6..12ba025 100644 --- a/online.md +++ b/online.md @@ -15,7 +15,7 @@ 设置在线配置参数，登录后台->头部tab切换到【游戏数据】->【配置相关】->【配置参数】可新增、编辑修改参数值，配置完毕后，通过online模块相关的api使用： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_021.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_021.png "🔍点击查看大图") diff --git a/platform.md b/platform.md index 3114470..4601fcf 100644 --- a/platform.md +++ b/platform.md @@ -11,11 +11,11 @@ #### **后台使用** 完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png "🔍点击查看大图") 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png "🔍点击查看大图") diff --git a/stat.md b/stat.md index 3114470..1a0e4f4 100644 --- a/stat.md +++ b/stat.md @@ -11,11 +11,11 @@ #### **后台使用** 完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.pn "🔍点击查看大图") 点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png "🔍点击查看大图") diff --git a/stat_active.md b/stat_active.md index 97bd966..dd696cb 100644 --- a/stat_active.md +++ b/stat_active.md @@ -77,7 +77,7 @@ ``` 2. **setLogind** - +
```javascript PCSDK.stat.setLogind( data: object ): void ``` diff --git a/stat_ads.md b/stat_ads.md index 5329a72..e07e60d 100644 --- a/stat_ads.md +++ b/stat_ads.md @@ -12,15 +12,15 @@ 1. 交叉悬浮广告框，放置到首页、结算页 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png "🔍点击查看大图") 2. 交叉抽屉式广告位，放置到首页、结算页 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png "🔍点击查看大图") 3. 交叉猜你喜欢广告位，推荐放置到结算页 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png "🔍点击查看大图") @@ -30,7 +30,7 @@ 完成接入交叉推广位后，登录后台->头部tab切换到【游戏数据】->【流量分析】->【广告导出】即可查看推广位的各项数据信息（需要后台管理人员添加权限）： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png "🔍点击查看大图") @@ -81,13 +81,13 @@ 1、开发者复制上面的10个其他游戏的appid，配置到game.json的navigateToMiniProgramAppIdList参数： - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_010.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_010.png "🔍点击查看大图") 2、修改[config.js的Env配置](install.md#config_env)为110，开发者测试联调阶段，走测试环境 > 提示：广告位接入完毕测试通过，提交审核前，修改Env为100。 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_011.png) + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_011.png "🔍点击查看大图") diff --git a/stat_event.md b/stat_event.md index f4e2eaf..809a8e8 100644 --- a/stat_event.md +++ b/stat_event.md @@ -10,7 +10,7 @@ 接入自定义事件打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】可查看自定义事件次数、去重人数等详细信息（此功能需要管理员添加权限）： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_018.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_018.png "🔍点击查看大图") @@ -18,9 +18,9 @@ 接入自定义事件打点前，请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件的key：登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】->点击【新增】添加自定义事件（事件key可语义化的自定义，推荐_连接）。 -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png "🔍点击查看大图") -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_017.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_017.png "🔍点击查看大图") > 提示：游戏新增自定义事件如果很多，一个个复制可能比较繁琐，进入噗嗤后台【事件列表】后，chrome浏览器打开【开发者工具】，在console栏下方输入下面的命令后，可自动生成自定义事件key的枚举（如果事件很多出现翻页，则每一页都执行后，手动合并为一个枚举），复制到项目中使用，枚举key生成规则为事件key转换为大驼峰式，枚举value为事件key： @@ -32,7 +32,7 @@ PCPlugins.transform('EventKeys', 1 , 2 , { any: false}); ``` -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_019.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_019.png "🔍点击查看大图") diff --git a/stat_level.md b/stat_level.md index 3c6141b..03bbafe 100644 --- a/stat_level.md +++ b/stat_level.md @@ -10,7 +10,7 @@ 接入关卡分析接口后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【关卡分析】可查看关卡进入用户数据、失败次数、失败率、平均完成时间等）： -![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_020.png) +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_020.png "🔍点击查看大图") -- libgit2 0.21.0