From 6ef851672173740d4b1ac176814af3d3ab917b44 Mon Sep 17 00:00:00 2001 From: 小川 费 <449111130@qq.com> Date: Wed, 4 Sep 2019 11:14:05 +0800 Subject: [PATCH] 加入其它模块功能 --- SUMMARY.md | 15 ++++++++------- book.json | 5 ----- download.md | 14 ++++++++++++-- install.md | 56 ++++++++++++++++++++++++++++++++------------------------ modules.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ stat_active.md | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ stat_ads.md | 179 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 464 insertions(+), 38 deletions(-) create mode 100644 modules.md create mode 100644 stat_active.md create mode 100644 stat_ads.md diff --git a/SUMMARY.md b/SUMMARY.md index 0ec0ad7..fbfbf8c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,12 +1,13 @@ # Summary -## 基本使用 +## SDK入门 * [SDK简介](README.md) * [SDK下载](download.md) * [安装步骤](install.md) -* [命令](commands.md) -* [目录结构](structure.md) -* [配置](settings.md) -## 扩展 -* [插件](plugins.md) -* [主题](themes.md) +## SDK手册 +* [SDK模块功能](modules.md) + +* [统计模块](stat_active.md) + * [启动注册打点](stat_active.md) + * [交叉推广位](stat_ads.md) + * [Gitbook命令行速览](installation/gitbook-cli.md) \ No newline at end of file diff --git a/book.json b/book.json index 09c11f4..8922a6c 100644 --- a/book.json +++ b/book.json @@ -14,13 +14,8 @@ "-livereload", "-fontsettings", "simple-page-toc@^0.1.1", - "prism@^2.1.0", - "prism-themes@^0.0.2", - "anchors@^0.7.1", "include-codeblock@^3.0.2", - "ace@^0.3.2", - "emphasize@^1.1.0", "katex@^1.1.3", "splitter@^0.0.8", "mermaid-gb3@2.1.0", diff --git a/download.md b/download.md index ed3de49..1e62ac4 100644 --- a/download.md +++ b/download.md @@ -2,7 +2,17 @@ ------ -## [v1.0.0.0 下载]() +## [v1.0.0.1 下载](https://dep.miso-lab.com/sdkword/versions/sdk-out-v1.0.0.1.zip) + +> *发布时间*：2019.09.04 + +**新增：** + +1. config.js配置ShareData新增share_wxad_id参数:视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享 + + + +## [v1.0.0.0 下载](https://dep.miso-lab.com/sdkword/versions/sdk-out-v1.0.0.0.zip) > *发布时间*：2019.08.31 @@ -14,7 +24,7 @@ **新增：** -1. config.js新增IsOnlineAutoUse、IsOnlineDebug、ShareRightKey配置参数 +1. config.js配置新增IsOnlineAutoUse、IsOnlineDebug、ShareRightKey配置参数 在线参数获取通过配置决定是否启动拉取，右上角分享配置进行读取shareKey diff --git a/install.md b/install.md index 352866c..6648d92 100644 --- a/install.md +++ b/install.md @@ -4,15 +4,14 @@ ## SDK下载 -下载最新版本的SDK [SDK下载](download.md) . - -解压下载的SDK.rar包的目录结构： +1. 下载最新版本的SDK [SDK下载](download.md) 。 +2. 解压下载的sdk-out-v{版本号}.zip包，解压文件夹里面的的目录结构： ``` ├── sdk.d.ts ├── sdk/ | ├── config.js -| └── sdk.js +| └── index.js | └── libs/ | └── game.min.js ``` @@ -21,7 +20,7 @@ - **sdk.d.ts：sdk的ts声明文件，开发者项目采用Typescript开发，请复制该文件到项目中。** - sdk/config.js：sdk配置文件，【[详细请阅读下方config.js参数说明](install.md#config)】 -- sdk/sdk.js：sdk入口文件，引入了sdk所提供的模块功能 +- sdk/index.js：sdk入口文件，引入了sdk所提供的模块功能 - sdk/libs/game.min.js：sdk类库核心代码文件 @@ -70,27 +69,28 @@ ```javaScript export default { - Env: 100, // 100表示正式环境，110表示测试环境，测试开发阶段使用110，提审前切记改成100！！！ - IsDebug: false, // 是否debug模式，debug模式会打印log，也可以通过stat模块setDebug进行修改 - AdCacheDuration: 30, // 广告列表缓存持续时间间隔 - IsUseShareModule: true, // 是否使用分享模块 - IsOnlineAutoUse: true, // 是否开启sdk自动请求online模块（在线参数配置）的updateOnlineConfig，拉取在线参数配置 - IsOnlineDebug: true, // 是否开启online模块（在线参数配置）debug模式 - ShareRightKey: 'forward', // 右上角分享的shareKey，shareKey请阅读share模块说明，默认为forward，为空字符串则不使用右上角分享 - - ShareData: { // 必填，默认分享数据（拉取不到分享配置后使用，默认分享，SDK自动分配share_id为99999） + IsDebug: false, // 是否debug模式，debug模式会打印log，也可以通过stat模块setDebug进行修改 + Env: 100, // 100表示正式环境，110表示测试环境，测试开发阶段使用110，提审前切记改成100！！！ + AdCacheDuration: 30, // 广告列表缓存持续时间间隔 + IsUseShareModule: true, // 是否使用分享模块 + IsOnlineAutoUse: true, // 是否开启sdk自动请求online模块（在线参数配置）的updateOnlineConfig，拉取在线参数配置 + IsOnlineDebug: true, // 是否开启online模块（在线参数配置）debug模式 + ShareRightKey: 'forward', // 右上角分享的shareKey，shareKey请阅读share模块说明，默认为forward，为空字符串则不使用右上角分享 + + ShareData: { // 必填，默认分享数据（拉取不到分享配置后使用，默认分享，SDK自动分配share_id为99999） share_desc: 'xxx', + share_wxad_id: '', // 可选，视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享 share_icon: 'xxx' }, - GameId: 0, // 必填，游戏ID，运营提供； - ChannelId: 0, // 必填，游戏渠道ID，运营提供； - Secret: '***请配置你的Secret***', // 必填，游戏的secret key - MidasPay: { // 米大师虚拟支付配置 - OfferId: "0", // 在米大师申请的应用id - ZoneId: "1", // 分区ID，默认：1 - Mode: "game", // 支付的类型，不同的支付类型有各自额外要传的附加参数，默认：game - CurrencyType: "CNY", // 币种，默认：CNY - Platform: '' // 申请接入时的平台，platform与应用id有关。默认：android（ios暂时没有开放，这里需要配置Platform，开放后，删掉此配置，sdk已经判断平台） + GameId: 0, // 必填，游戏ID，运营提供； + ChannelId: 0, // 必填，游戏渠道ID，运营提供； + Secret: '***请配置你的Secret***', // 必填，游戏的secret key + MidasPay: { // 米大师虚拟支付配置 + OfferId: "0", // 在米大师申请的应用id + ZoneId: "1", // 分区ID，默认：1 + Mode: "game", // 支付的类型，不同的支付类型有各自额外要传的附加参数，默认：game + CurrencyType: "CNY", // 币种，默认：CNY + Platform: '' // 申请接入时的平台，platform与应用id有关。默认：android（ios暂时没有开放，这里需要配置Platform，开放后，删掉此配置，sdk已经判断平台） } }; ``` @@ -166,6 +166,8 @@ 示例：可以从噗嗤管理后台【游戏数据】=>【分享/视频配置】中选取一条：复制文案，点击分享素材icon->查看大图->右键查看分享图片的html源码复制src图片地址：**{** ​ **share_desc: ' 半夜传来啪啪啪！竟是隔壁老王偷偷打气球',** + + ​ **share_wxad_id: 'adunit-6958dcfc3f0bed31',** ​ **share_icon: 'https://dep.miso-lab.com/data_analysis/games/res/5D57D4A3Yx.png'** @@ -207,4 +209,10 @@ 示例：项目采用的是Laya Typescript版本进行开发，将该文件复制到libs目录下面 - ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png) \ No newline at end of file + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_007.png) + +* #### 到此，SDK的准备工作已经配置完毕，运行起来： + + 运行中碰到问题，[[请查看FAQ](faq.md)]，或者微信群联系相关人员。 + + 正常运行，阅读SDK手册，开始[[SDK模块功能](modules.md)]接入。 \ No newline at end of file diff --git a/modules.md b/modules.md new file mode 100644 index 0000000..336b4b4 --- /dev/null +++ b/modules.md @@ -0,0 +1,59 @@ +# 噗嗤SDK +PCSDK（噗嗤SDK）是一款封装了微信小游戏、QQ小游戏平台常用api接口和用户行为数据上报的一款产品。 +PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，后台对数据进行统计分析后多样化的展示数据统计。 + +**PCSDK提供的模块功能：** + +- 统计模块 +- 数据模块 +- 分享视频模块 +- 在线参数模块 +- 跨平台功能模块 + + + +# 噗嗤管理后台 +噗嗤管理后台统计sdk中上报的各项数据进行分析；管理各种sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、噗嗤游戏导出广告配置、用户事件行为配置。 + +为了开发联调测试阶段不影响游戏已上线运营相关数据或者配置信息，特意对管理后台做了测试和线上服划分，噗嗤管理后台分为：测试服后台，正式服后台： + +噗嗤管理后台后台地址： + +- 正式服后台，地址：https://data.d3games.com/#/login + +- 测试服后台，地址：http://pre-data.d3games.com/#/login + +**友情提示：** + +- **之后文案中后台指的是噗嗤管理后台，而不是微信小程序/小游戏后台。** +- **后台登录账号获取，需提供手机信息给我方运营，运营创建后台登录账号、密码后反馈；登录后台即可使用后台提供的各项服务** + + + +**噗嗤后台概览：** +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png) + + + +**后台提供数据分析功能：** + +- 注册/活跃用户，在线时长实时数据分享。 +- 分享数据分析 +- 用户事件行为分析 +- 渠道数据统计分析 + + + +**后台提供配置相关功能：** + +- 分享视频配置 +- 动态配置参数 + + + +# 更多： +- 快速接入，请详读 [安装步骤](install.md) + + + +- 遇到问题可以查看 [FAQ](faq.md) \ No newline at end of file diff --git a/stat_active.md b/stat_active.md new file mode 100644 index 0000000..0b8dc80 --- /dev/null +++ b/stat_active.md @@ -0,0 +1,174 @@ +# 启动注册打点 + +------ + +#### **简介** + +启动注册打点上报用户注册活跃数据，噗嗤管理后台为游戏提供用户数据统计：实时获取活跃、新增用户数、打开次数、在线时长......；注册转化统计。 + + + +#### **查看数据** + +完成启动注册打点后，登录后台->头部切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) + +点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png) + + + + + +#### **接入API：** + +| **名称** | **功能说明** | +| ------------------------ | ------------------------------------------------------------ | +| PCSDK.stat.loadingFinish | 加载游戏资源完成时打点，不是微信代码包白屏加载完成，游戏loading自身cdn资源加载完成调用 | +| PCSDK.stat.setLogind | 设置sdk必须要使用的用户id、第一次创建角色的注册时间，游戏接入方登录游戏服务器后调用 | +| PCSDK.stat.active | 用户活跃/新增注册上报，切记在setLogind设置需要的信息过后使用（不限于使用位置），不然会导致新增注册数据统计异常 | + + + + + + + +1. **loadingFinish** + + ```javascript + PCSDK.stat.loadingFinish(): void + ``` + + 定义：加载游戏加载资源完成时打点 + + 参数： + + ``` + 无 + ``` + + 示例：加载完成游戏主界面图片、json资源打点 + + ```javascript + private async initEnv() { + await SDKTools.env(Const.VERSION); + this.loadRes(); + this.loadLogin(); + } + + // 开始加载资源 + private loadRes() { + LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain(); + } + + // 资源加载完成 + private onLoadedMain() { + PCSDK.stat.loadingFinish() + } + + // 更新资源加载进度条 + private onProgressMain(ret) { + let progress = ret.data; + this.skin.txtProgress.text = Math.floor(progress * 100) + '%'; + } + ``` + +2. **setLogind** + + ```javascript + PCSDK.stat.setLogind( data: object ): void + ``` + + 定义：游戏登录完成，得到登录用户的用户id和用户第一次注册时间，设置SDK必需的用户信息 + + 参数： + + ```javascript + data: object +{ + userId: string | number 必传, 用户唯一标识id + regTime: number 必传，用户第一次创建角色的注册时间戳 + } + ``` + + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟使用环境） + + ```javascript + // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息 + Api.login().then( data => { + let { user_id, user_reg_time } = data; + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + }); + ``` + +3. **active** + + ```javascript + PCSDK.stat.active(): void + ``` + + 定义：用户活跃/新增注册上报，切记在使用setLogind设置用户信息过后调用此接口，不然会导致新增注册数据统计异常 + + 参数： + + ```javascript + 无 + ``` + + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟该接口使用环境） + + ```javascript + // 使用场景1：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息后立即调用active + Api.login().then( data => { + let { user_id, user_reg_time } = data; + // 设置用户信息 + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + // 用户活跃注册打点 + PCSDK.stat.active(); + }); + + // 使用场景2：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息。在其他界面调用active + // 资源加载loading界面 + class LoadingScene(){ + constructor(){ + this.login(); + } + + private login(){ + // 登录 + Api.login().then( data => { + let { user_id, user_reg_time } = data; + // 设置用户信息 + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + // 进入home主页场景 + SceneManager.I.switchScene(HomeScene); + }); + } + } + + // Home页面 + class HomeScene(){ + constructor(){ + this.btnStarGame.on('click', this.onGame, this); + } + + private onGame(){ + // 用户活跃注册打点 + PCSDK.stat.active(); + // 进入游戏页面 + SceneManager.I.switchScene(GameScene); + } + } + + ``` \ No newline at end of file diff --git a/stat_ads.md b/stat_ads.md new file mode 100644 index 0000000..e452904 --- /dev/null +++ b/stat_ads.md @@ -0,0 +1,179 @@ +# 交叉推广位 + +------ + +#### **简介** + +交叉推广位是在游戏中放置其他游戏icon，用户点击跳转到导出的游戏，达到共享用户的目的，噗嗤游戏对开发者提供了不同类型的广告导出。 + +噗嗤管理后台可对交叉推广位进行配置管理，对广告导出各项指标进行计算分析。 + + + +#### **接入准备** + +由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的游戏需要配置微信开发者工具项目的 + +完成启动注册打点后，登录后台->头部切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_008.png) + +点击【注册转化】可查看列表式显示新增、注册、加载完成等详细信息： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_009.png) + + + + + +#### **接入API：** + +| **名称** | **功能说明** | +| ------------------------ | ------------------------------------------------------------ | +| PCSDK.stat.loadingFinish | 加载游戏资源完成时打点，不是微信代码包白屏加载完成 | +| PCSDK.stat.setLogind | 游戏登录成功后，获取用户信息用户userId、第一次创建角色的注册时间regTime，调用此接口设置SDK统计上报需要的用户信息 | +| PCSDK.stat.active | 用户活跃/新增注册上报，切记在setLogind设置需要的信息过后使用，不然会导致新增注册数据统计异常。setLogind后，此接口不限使用位置。 | + + + + + + + +1. **loadingFinish** + + ```javascript + PCSDK.stat.loadingFinish(): void + ``` + + 定义：加载游戏资源完成（不是微信白屏加载完成）时打点 + + 参数： + + ``` + 无 + ``` + + 示例：加载完成游戏主界面图片、json资源打点 + + ```javascript + private async initEnv() { + await SDKTools.env(Const.VERSION); + this.loadRes(); + this.loadLogin(); + } + + // 开始加载资源 + private loadRes() { + LoaderManager.I.setCallback(this.onLoadedMain, this.onProgressMain, null, this).loadMain(); + } + + // 资源加载完成 + private onLoadedMain() { + PCSDK.stat.loadingFinish() + } + + // 更新资源加载进度条 + private onProgressMain(ret) { + let progress = ret.data; + this.skin.txtProgress.text = Math.floor(progress * 100) + '%'; + } + ``` + +2. **setLogind** + + ```javascript + PCSDK.stat.setLogind( data: object ): void + ``` + + 定义：游戏登录完成，得到登录用户的用户id和用户第一次注册时间，设置SDK必需的用户信息 + + 参数： + + ```javascript + data: object +{ + userId: string | number 必传, 用户唯一标识id + regTime: number 必传，用户第一次创建角色的注册时间戳 + } + ``` + + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟使用环境） + + ```javascript + // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息 + Api.login().then( data => { + let { user_id, user_reg_time } = data; + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + }); + ``` + + +3. **active** + + ```javascript + PCSDK.stat.active(): void + ``` + + 定义：用户活跃/新增注册上报，切记在使用setLogind设置用户信息过后调用此接口，不然会导致新增注册数据统计异常 + + 参数： + + ```javascript + 无 + ``` + + 示例：游戏登录完成后，获取用户信息后进行打点（该示例，只是模拟该接口使用环境） + + ```javascript + // 使用场景1：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息后立即调用active + Api.login().then( data => { + let { user_id, user_reg_time } = data; + // 设置用户信息 + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + // 用户活跃注册打点 + PCSDK.stat.active(); + }); + + // 使用场景2：发起登录请求，得到用户数据信息，调用setLogind设置SDK用户信息。在其他界面调用active + // 资源加载loading界面 + class LoadingScene(){ + constructor(){ + this.login(); + } + + private login(){ + // 登录 + Api.login().then( data => { + let { user_id, user_reg_time } = data; + // 设置用户信息 + PCSDK.stat.setLogind({ + userId: data.user_id, + regTime: data.user_reg_time + }); + // 进入home主页场景 + SceneManager.I.switchScene(HomeScene); + }); + } + } + + // Home页面 + class HomeScene(){ + constructor(){ + this.btnStarGame.on('click', this.onGame, this); + } + + private onGame(){ + // 用户活跃注册打点 + PCSDK.stat.active(); + // 进入游戏页面 + SceneManager.I.switchScene(GameScene); + } + } + + ``` \ No newline at end of file -- libgit2 0.21.0