小川 / SdkGitbook

Download as
Browse Code »

Commit a0124730b305f41818924a29cdaa533ab9b02783

Authored by 小川 费
0 parents
Exists in master

初始化

Showing 5 changed files with 382 additions and 0 deletions   Show diff stats
.gitignore 0 → 100644
  Diff comments   View file @a012473
  1 +++ a/.gitignore
... ... @@ -0,0 +1,64 @@
  1 +# Node rules:
  2 +## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
  3 +.grunt
  4 +
  5 +## Dependency directory
  6 +## Commenting this out is preferred by some people, see
  7 +## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
  8 +node_modules
  9 +node_modules/
  10 +node_modules/**/*
  11 +
  12 +# Book build output
  13 +_book
  14 +
  15 +# eBook build output
  16 +*.epub
  17 +*.mobi
  18 +*.pdf
  19 +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion
  20 +
  21 +*.iml
  22 +
  23 +## Directory-based project format:
  24 +.idea/
  25 +# if you remove the above rule, at least ignore the following:
  26 +
  27 +# User-specific stuff:
  28 +# .idea/workspace.xml
  29 +# .idea/tasks.xml
  30 +# .idea/dictionaries
  31 +
  32 +# Sensitive or high-churn files:
  33 +# .idea/dataSources.ids
  34 +# .idea/dataSources.xml
  35 +# .idea/sqlDataSources.xml
  36 +# .idea/dynamic.xml
  37 +# .idea/uiDesigner.xml
  38 +
  39 +# Gradle:
  40 +# .idea/gradle.xml
  41 +# .idea/libraries
  42 +
  43 +# Mongo Explorer plugin:
  44 +# .idea/mongoSettings.xml
  45 +
  46 +## File-based project format:
  47 +*.ipr
  48 +*.iws
  49 +
  50 +## Plugin-specific files:
  51 +
  52 +# IntelliJ
  53 +/out/
  54 +
  55 +# mpeltonen/sbt-idea plugin
  56 +.idea_modules/
  57 +
  58 +# JIRA plugin
  59 +atlassian-ide-plugin.xml
  60 +
  61 +# Crashlytics plugin (for Android Studio and IntelliJ)
  62 +com_crashlytics_export_strings.xml
  63 +crashlytics.properties
  64 +crashlytics-build.properties
... ...
README.md 0 → 100644
  Diff comments   View file @a012473
  1 +++ a/README.md
... ... @@ -0,0 +1,59 @@
  1 +# 噗嗤SDK
  2 +PCSDK（噗嗤SDK）是一款封装了微信小游戏、QQ小游戏平台常用api接口和用户行为数据上报的一款产品。
  3 +PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，后台对数据进行统计分析后多样化的展示数据统计。
  4 +
  5 +**PCSDK提供的模块功能：**
  6 +
  7 +- 统计模块
  8 +- 数据模块
  9 +- 分享视频模块
  10 +- 在线参数模块
  11 +- 跨平台功能模块
  12 +
  13 +
  14 +
  15 +# 噗嗤管理后台
  16 +噗嗤管理后台统计sdk上报的各项数据进行分析；管理sdk所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、噗嗤游戏导出广告配置、用户事件行为配置。
  17 +
  18 +为了开发联调测试阶段不影响游戏已上线运营相关数据或者配置信息，特意对管理后台做了测试和线上服划分，噗嗤管理后台分为：测试服后台，正式服后台：
  19 +
  20 +噗嗤管理后台后台地址：
  21 +
  22 +- 正式服后台，地址：https://data.d3games.com/#/login
  23 +
  24 +- 测试服后台，地址：http://pre-data.d3games.com/#/login
  25 +
  26 +**友情提示：**
  27 +
  28 +- **之后文案中后台指的是噗嗤管理后台，而不是微信小程序/小游戏后台。**
  29 +- **后台登录账号获取，需提供手机信息给我方运营，运营创建后台登录账号、密码后反馈；登录后台即可使用后台提供的各项服务**
  30 +
  31 +
  32 +
  33 +**噗嗤后台概览：**
  34 +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png)
  35 +
  36 +
  37 +
  38 +**后台提供数据分析功能：**
  39 +
  40 +- 注册/活跃用户，在线时长实时数据分享。
  41 +- 分享数据分析
  42 +- 用户事件行为分析
  43 +- 渠道数据统计分析
  44 +
  45 +
  46 +
  47 +**后台提供配置相关功能：**
  48 +
  49 +- 分享视频配置
  50 +- 动态配置参数
  51 +
  52 +
  53 +
  54 +# 更多：
  55 +- 快速接入，请详读 [安装步骤](install.md)
  56 +
  57 +
  58 +
  59 +- 遇到问题可以查看 [FAQ](faq.md)
0 60 \ No newline at end of file
... ...
SUMMARY.md 0 → 100644
  Diff comments   View file @a012473
  1 +++ a/SUMMARY.md
... ... @@ -0,0 +1,12 @@
  1 +# Summary
  2 +## 基本使用
  3 +* [SDK简介](README.md)
  4 +* [SDK下载](download.md)
  5 +* [安装步骤](install.md)
  6 +* [命令](commands.md)
  7 +* [目录结构](structure.md)
  8 +* [配置](settings.md)
  9 +
  10 +## 扩展
  11 +* [插件](plugins.md)
  12 +* [主题](themes.md)
... ...
book.json 0 → 100644
  Diff comments   View file @a012473
  1 +++ a/book.json
... ... @@ -0,0 +1,46 @@
  1 +{
  2 + "title": "噗嗤游戏使用文档",
  3 + "description": "记录 GitBook 的配置和一些插件的使用",
  4 + "author": "zhangjikai",
  5 + "output.name": "site",
  6 + "language": "zh-hans",
  7 + "gitbook": "3.2.3",
  8 + "root": ".",
  9 + "plugins": [
  10 + "-lunr",
  11 + "-search",
  12 + "-sharing",
  13 + "-highlight",
  14 + "-livereload",
  15 + "-fontsettings",
  16 + "search-plus@^0.0.11",
  17 + "simple-page-toc@^0.1.1",
  18 + "prism@^2.1.0",
  19 + "prism-themes@^0.0.2",
  20 +
  21 + "anchors@^0.7.1",
  22 + "include-codeblock@^3.0.2",
  23 + "ace@^0.3.2",
  24 + "emphasize@^1.1.0",
  25 + "katex@^1.1.3",
  26 + "splitter@^0.0.8",
  27 + "mermaid-gb3@2.1.0",
  28 + "tbfed-pagefooter@^0.0.1",
  29 + "expandable-chapters-small@^0.1.7",
  30 +
  31 + "sectionx@^3.1.0",
  32 + "local-video@^1.0.1",
  33 + "favicon@^0.0.2",
  34 + "todo@^0.1.3",
  35 + "terminal@^0.3.2",
  36 + "alerts@^0.2.0",
  37 +
  38 + "include-csv@^0.1.0",
  39 + "puml@^1.0.1",
  40 + "musicxml@^1.0.2",
  41 + "klipse@^1.2.0",
  42 + "versions-select@^0.1.1",
  43 + "graph@^0.1.0",
  44 + "chart@^0.2.0"
  45 + ]
  46 +}
... ...
install.md 0 → 100644
  Diff comments   View file @a012473
  1 +++ a/install.md
... ... @@ -0,0 +1,201 @@
  1 +# 安装步骤
  2 +
  3 +------
  4 +
  5 +## SDK下载
  6 +
  7 +下载最新版本的SDK [在线的示例](http://doc.zhangjikai.com/#/) .
  8 +
  9 +解压下载的SDK.rar包的目录结构：
  10 +
  11 +```
  12 +├── sdk.d.ts
  13 +├── sdk/
  14 +| ├── config.js
  15 +| └── sdk.js
  16 +| └── libs/
  17 + | ├── gmae.min.js
  18 +```
  19 +
  20 +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_001.png)
  21 +
  22 +
  23 +
  24 +
  25 +
  26 +## 配置合法域名
  27 +
  28 +* ##### 管理员或开发者身份在微信小程序后台→设置→开发者设置中添加 request、download合法域名
  29 + 测试环境 request 合法域名：
  30 +
  31 + https://pre-dataapi.d3games.com （统计平台测试服域名）
  32 +
  33 + 正式环境 request 合法域名：
  34 +
  35 + https://dataapi.d3games.com （统计平台正式服域名）
  36 +
  37 + cdn资源请求合法域名：
  38 +
  39 + https://dep.miso-lab.com （>>>request、download均要添加<<<）
  40 +
  41 +
  42 +
  43 +
  44 +
  45 +​
  46 +## SDK配置步骤
  47 +
  48 +* #### 将下载下来的sdk压缩包，解压后，拷贝sdk文件夹到微信开发者工具项目中。
  49 +
  50 + 示例：将sdk放入到小游戏开发者工具项目的src文件夹中
  51 +
  52 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png)
  53 +
  54 +
  55 +
  56 +
  57 +
  58 +* #### 在game.js中将sdk.js文件使用require导入。
  59 +
  60 + 示例：将sdk放入到小游戏开发者工具项目的src文件夹中
  61 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png)
  62 +
  63 +
  64 +
  65 +
  66 +* #### 根据运营提供的信息修改sdk文件夹下的**config**.js文件（可横向拖动查看查看更多==========>）
  67 +
  68 + ```c#
  69 + export default {
  70 + Env: 100, // 100表示正式环境，110表示测试环境，测试开发阶段使用110，提审前切记改成100！！！
  71 + IsDebug: false, // 是否debug模式，debug模式会打印log，也可以通过stat模块setDebug进行修改
  72 + AdCacheDuration: 30, // 广告列表缓存持续时间间隔
  73 + IsUseShareModule: true, // 是否使用分享模块
  74 + IsOnlineAutoUse: true, // 是否开启sdk自动请求online模块（在线参数配置）的updateOnlineConfig，拉取在线参数配置
  75 + IsOnlineDebug: true, // 是否开启online模块（在线参数配置）debug模式
  76 + ShareRightKey: 'forward', // 右上角分享的shareKey，shareKey请阅读share模块说明，默认为forward，为空字符串则不使用右上角分享
  77 +
  78 + ShareData: { // 必填，默认分享数据（拉取不到分享配置后使用，默认分享，SDK自动分配share_id为99999）
  79 + share_desc: 'xxx',
  80 + share_icon: 'xxx'
  81 + },
  82 + GameId: 0, // 必填，游戏ID，运营提供；
  83 + ChannelId: 0, // 必填，游戏渠道ID，运营提供；
  84 + Secret: '***请配置你的Secret***', // 必填，游戏的secret key
  85 + MidasPay: { // 米大师虚拟支付配置
  86 + OfferId: "0", // 在米大师申请的应用id
  87 + ZoneId: "1", // 分区ID，默认：1
  88 + Mode: "game", // 支付的类型，不同的支付类型有各自额外要传的附加参数，默认：game
  89 + CurrencyType: "CNY", // 币种，默认：CNY
  90 + Platform: '' // 申请接入时的平台，platform与应用id有关。默认：android（ios暂时没有开放，这里需要配置Platform，开放后，删掉此配置，sdk已经判断平台）
  91 + }
  92 +};
  93 + ```
  94 +
  95 +
  96 + 参数详解：
  97 +
  98 + 1. **Env ( number )：**SDK统计执行环境，建议开发者调试测试阶段设置为110，提审阶段一定要设置为100。
  99 +
  100 + 100：正式环境，请求api域名地址为：https://dataapi.d3games.com
  101 +
  102 + 110：测试环境，请求api域名地址为：https://pre-dataapi.d3games.com
  103 +
  104 + 2. **IsDebug ( boolean )：**是否debug模式，debug模式会打印sdk中的console.log/error/warn log。
  105 +
  106 + false：关闭log打印，提审前建议设置为false，不打印log信息
  107 +
  108 + true：开启log打印，如遇到联调问题，可设置为true，查看log发给相关人员进行查看解决问题
  109 +
  110 + 此设置可在代码中通过动态设置：PCSDK.stat.setDebug( boolean )进行动态切换控制
  111 +
  112 + 3. **AdCacheDuration（number）：**表示获取广告位列表的缓存时间，例如30秒，sdk会对广告列表拉取后缓存30秒。此参数对接入噗嗤广告导出功能后有效，没有接入可不修改，使用默认值。
  113 +
  114 + 4. **IsUseShareModule( boolean )：**是否启用sdk分享视频功能（sdk把分享和视频封装为share模块，可以通过噗嗤后台配置分享还是视频类型进行分发控制）
  115 +
  116 + false：SDK启动不拉取分享列表，也就是不适用噗嗤游戏的分享模块功能
  117 +
  118 + true：SDK启动拉取噗嗤管理后台配置的分享视频列表，运营或者开发者在噗嗤后台配置分享视频的配置后，开发者可以通过PCSDK.share.shareDispatch( sharekey , ...)进行视频分享分发操作，具体操作请详看SDK分享视频模块。
  119 +
  120 + 5. **IsOnlineAutoUse( boolean )：**是否启用SDK启动获取噗嗤游戏后台配置的在线配置参数列表
  121 +
  122 + false：两种处理 1）不启用噗嗤后台在线配置参数功能; 2）使用在线配置参数功能，但是启动不拉取后台在线配置参数列表，代码中调用api拉取在线参数
  123 +
  124 + 示例：代码中控制拉取在线参数，例如噗嗤后台【游戏数据】=>【配置参数】栏配置了：是否显示微信插屏广告、噗嗤游戏广告导出动态开关
  125 +
  126 + ```javascript
  127 + PCSDK.online.updateOnlineConfig().then(() => {
  128 + // 获取是否后台动态配置开启插屏广告，1为开启，0为关闭
  129 + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1;
  130 + // isInterstitialAd && '显示插屏广告';
  131 + // 获取动态多个广告位开启的配置
  132 + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 });
  133 + // pcGameOpenMap.Drawer === 1 && '显示抽屉推广位';
  134 + // pcGameOpenMap.GuessLike === 1 && '显示猜你喜欢推广位';
  135 + // pcGameOpenMap.Cross === 1 && '显示交叉推广位';
  136 + });
  137 + ```
  138 +
  139 + true：sdk启动会自动拉取噗嗤后台在线配置参数列表，开发者可通过PCSDK.online.getParamsObj、PCSDK.online.getParamsInt、PCSDK.online.getParamsString、PCSDK.online.getParams api传递后台配置在线参数key获取动态数据配置。
  140 +
  141 + 示例：配置自动拉取后，项目中可直接使用
  142 +
  143 + ```JavaScript
  144 + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1;
  145 + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 });
  146 + ```
  147 + 6. **IsOnlineDebug( boolean )：**是否启用online模块（在线参数配置）debug模式，建议设置为true。
  148 +
  149 + false：不启动debug模式，代码控制或者sdk自动调用updateOnlineConfig api都会有十分钟的缓存，参照了友盟在线参数功能的设计
  150 +
  151 + true: 开启debug模式，只要是请求updateOnlineConfig api都会实时请求获取最新在线参数配置
  152 +
  153 + 7. **ShareRightKey( string )：**右上角分享的shareKey，shareKey请阅读share模块说明，默认为forward，为空字符串则不使用右上角分享，此配置在参数【IsUseShareModule】设置为true的情况下生效。
  154 +
  155 + 示例：
  156 +
  157 + 在噗嗤管理后台的分享视频栏目配置了一条分享key为：forward的分享配置
  158 +
  159 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png)
  160 +
  161 + 8. **ShareData( object )：**此配置在【IsUseShareModule】设置为true起效，IsUseShareModule设置true sdk启动拉取分享列表，如果分享列表拉取失败，或调用的shareKey不在分享列表中（噗嗤后台【游戏数据】=>【分享/视频配置】栏没有配置此分享key）就会使用此条设置的数据，>>> 请务必配置一条 <<<。
  162 +
  163 + 示例：可以从噗嗤管理后台【游戏数据】=>【分享/视频配置】中选取一条：复制文案，点击分享素材icon->查看大图->右键查看分享图片的html源码复制src图片地址：**{**
  164 +
  165 + ​ **share_desc: ' 半夜传来啪啪啪！竟是隔壁老王偷偷打气球',**
  166 +
  167 + ​ **share_icon: 'https://dep.miso-lab.com/data_analysis/games/res/5D57D4A3Yx.png'**
  168 +
  169 + **}**。
  170 +
  171 + 操作示图：
  172 +
  173 + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png)
  174 +
  175 + 9. **GameId：必填，游戏id，请联系运营人员提供**
  176 +
  177 + 10. **ChannelId：必填，游戏渠道id，请联系运营人员提供**
  178 +
  179 + 11. **Secret：必填，游戏 Secret Key，请联系运营人员提供**
  180 +
  181 + 12. **MidasPay( object )：**米大水虚拟支付配置，没有接入微信的米大师支付，请注意下面规则
  182 +
  183 + OfferId：在米大师申请的应用id，没有接入米大师，默认为"0"
  184 +
  185 + ZoneId：分区ID，默认："1"
  186 +
  187 + Mode：支付的类型，不同的支付类型有各自额外要传的附加参数，默认："game"
  188 +
  189 + CurrencyType：币种，默认："CNY"
  190 +
  191 + Platform：申请接入时的平台，platform与应用id有关。
  192 +
  193 + 1）接入了米大师，填写"android"（ios暂时没有开放）
  194 +
  195 + 2）未接入米大师，使用其他支付，如果只支持android，则填写"android"；
  196 +
  197 + 3）未接入米大师，使用其他支付，如果只支持ios，则填写"ios"；
  198 +
  199 + 4）未接入米大师，使用其他支付，如果支持ios和android，则填写为""，sdk会根据手机识别android还是ios
  200 +
  201 +
... ...