From 4f63bbe319f9a900e59743250be3b461d9eaa415 Mon Sep 17 00:00:00 2001 From: 小川 费 <449111130@qq.com> Date: Sat, 7 Sep 2019 11:11:18 +0800 Subject: [PATCH] 1 --- README.md | 14 +++----------- book.json | 4 +++- faq.md | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ images/sdk_023.png | Bin 0 -> 86969 bytes images/sdk_024.png | Bin 0 -> 37645 bytes images/sdk_025.png | Bin 0 -> 57828 bytes images/sdk_026.png | Bin 0 -> 63328 bytes inner/README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ inner/install.md | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ inner/intro.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ inner/stat_ads.md | 543 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ install.md | 27 +++++---------------------- intro.md | 16 ++++------------ modules.md | 8 -------- share.md | 184 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ stat_ads.md | 17 +---------------- stat_event.md | 4 ++-- stat_level.md | 27 +++++++++++++++++---------- styles/website.css | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 19 files changed, 1365 insertions(+), 82 deletions(-) create mode 100644 faq.md create mode 100755 images/sdk_023.png create mode 100755 images/sdk_024.png create mode 100755 images/sdk_025.png create mode 100755 images/sdk_026.png create mode 100644 inner/README.md create mode 100644 inner/install.md create mode 100644 inner/intro.md create mode 100644 inner/stat_ads.md create mode 100644 share.md create mode 100644 styles/website.css diff --git a/README.md b/README.md index 89665db..5dea247 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,9 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， # 噗嗤管理后台 噗嗤管理后台对sdk中上报的各项数据进行分析；管理sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、交叉推广位配置、用户自定义事件配置。 -方便开发者联调测试阶段不影响上线游戏运营相关数据或者配置信息，config.js的Env配置提供测试和正式环境切换。 - -> 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) - -> 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) - 噗嗤管理后台地址： -- 测试服后台，地址：http://pre-data.d3games.com/#/login - -- 正式服后台，地址：https://data.d3games.com/#/login +- https://data.d3games.com/#/login **友情提示：** @@ -52,8 +44,8 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， **后台提供配置相关功能（不能跳转请联系管理员添加权限）：** -- [分享/视频配置](http://pre-data.d3games.com/index.html#/share_list) -- [配置参数](http://pre-data.d3games.com/index.html#/config_list) +- [分享/视频配置](https://data.d3games.com/index.html#/share_list) +- [配置参数](https://data.d3games.com/index.html#/config_list) # 更多： diff --git a/book.json b/book.json index c6d66db..6201203 100644 --- a/book.json +++ b/book.json @@ -12,7 +12,6 @@ "-sharing", "-highlight", "-livereload", - "-fontsettings", "simple-page-toc@^0.1.1", "prism", "prism-themes", @@ -40,6 +39,9 @@ "structure": { "readme": "README.md" }, + "styles": { + "website": "styles/website.css" + }, "pluginsConfig": { "prism": { "css": [ diff --git a/faq.md b/faq.md new file mode 100644 index 0000000..53425fe --- /dev/null +++ b/faq.md @@ -0,0 +1,174 @@ +# FAQ + +------ + +#### **简介** + +启动注册打点上报用户注册活跃数据，噗嗤管理后台为游戏提供用户数据统计：实时获取活跃、新增用户数、打开次数、在线时长......；注册转化统计。 + + + +#### **后台使用** + +完成启动注册打点后，登录后台->头部tab切换到【游戏数据】->【产品分析】->【实时数据】即可实时查看用户活跃、新增等信息： +![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/images/sdk_023.png b/images/sdk_023.png new file mode 100755 index 0000000..7a38357 Binary files /dev/null and b/images/sdk_023.png differ diff --git a/images/sdk_024.png b/images/sdk_024.png new file mode 100755 index 0000000..efe314d Binary files /dev/null and b/images/sdk_024.png differ diff --git a/images/sdk_025.png b/images/sdk_025.png new file mode 100755 index 0000000..c482583 Binary files /dev/null and b/images/sdk_025.png differ diff --git a/images/sdk_026.png b/images/sdk_026.png new file mode 100755 index 0000000..44f4fa4 Binary files /dev/null and b/images/sdk_026.png differ diff --git a/inner/README.md b/inner/README.md new file mode 100644 index 0000000..89665db --- /dev/null +++ b/inner/README.md @@ -0,0 +1,64 @@ +# 噗嗤SDK +PCSDK（噗嗤SDK）是一款封装了微信小游戏、QQ小游戏平台常用api接口和用户行为数据上报的一款产品。 +PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，后台对数据统计分析后以多样化的方式展现数据。 + +**PCSDK提供的模块功能：** + +- [统计模块](stat.md) +- [分享视频模块](share.md) +- [配置参数模块️](online.md) +- [多平台接口模块](platform.md) +- [数据模块](data.md) +- [事件模块](event.md) + + + +# 噗嗤管理后台 +噗嗤管理后台对sdk中上报的各项数据进行分析；管理sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、交叉推广位配置、用户自定义事件配置。 + +方便开发者联调测试阶段不影响上线游戏运营相关数据或者配置信息，config.js的Env配置提供测试和正式环境切换。 + +> 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) + +> 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) + +噗嗤管理后台地址： + +- 测试服后台，地址：http://pre-data.d3games.com/#/login + +- 正式服后台，地址：https://data.d3games.com/#/login + +**友情提示：** + +- **之后文档中'后台'指的是[噗嗤管理后台]，而不是微信小程序/小游戏后台。** +- **后台登录账号获取：需提供手机信息给我方运营，运营创建后台登录账号、密码后提供反馈。** +- **登录后台即可使用后台提供的各项服务** + + + +**后台概览：** +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图") + + + +**后台提供数据分析功能（不能跳转请联系管理员添加权限）：** + +- [注册/活跃用户，在线时长实时数据分析](https://data.d3games.com/index.html#/view_chart) +- [分享数据分析](https://data.d3games.com/index.html#/share_exact) +- [用户事件行为分析](https://data.d3games.com/index.html#/dot_list) +- [渠道数据统计分析](https//data.d3games.com/index.html#/channel_stat_list) + + + +**后台提供配置相关功能（不能跳转请联系管理员添加权限）：** + +- [分享/视频配置](http://pre-data.d3games.com/index.html#/share_list) +- [配置参数](http://pre-data.d3games.com/index.html#/config_list) + + +# 更多： +- 快速接入，请详读 [安装步骤](install.md) + + + +- 遇到问题可以查看 [FAQ](faq.md) \ No newline at end of file diff --git a/inner/install.md b/inner/install.md new file mode 100644 index 0000000..37cb60f --- /dev/null +++ b/inner/install.md @@ -0,0 +1,233 @@ +# 安装步骤 + +------ + +## SDK下载 + +1. 下载最新版本的SDK [SDK下载](download.md) 。 +2. 解压下载的sdk-out-v{版本号}.zip包，解压文件夹里面的的目录结构： + +``` +├── sdk.d.ts +├── sdk/ +| ├── config.js +| └── index.js +| └── libs/ + | └── game.min.js +``` + +![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)】 +- sdk/index.js：sdk入口文件，引入了sdk所提供的模块功能 +- sdk/libs/game.min.js：sdk类库核心代码文件 + + + +## 配置合法域名 + +* ##### 管理员或开发者身份在微信小程序后台→设置→开发者设置中添加 request、download合法域名 + 测试环境 request 合法域名： + + https://pre-dataapi.d3games.com （统计平台测试服域名） + + 正式环境 request 合法域名： + + https://dataapi.d3games.com （统计平台正式服域名） + + cdn资源请求合法域名： + + https://dep.miso-lab.com （>>>request、download均要添加<<<） + + + + + +​ +## SDK配置步骤 + +* #### 将下载下来的sdk压缩包，解压后，拷贝sdk文件夹到微信开发者工具项目中。 + + 示例：将sdk放入到小游戏开发者工具项目的src文件夹中 + + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_002.png "🔍点击查看大图") + + + + + +* #### 在game.js中将sdk.js文件使用require导入。 + + 示例：将sdk放入到小游戏开发者工具项目的src文件夹中 + ![引入目录](https://dep.miso-lab.com/sdkword/sdk_003.png "🔍点击查看大图") + + + + +* #### 根据运营提供的信息修改sdk文件夹下的**config**.js文件（可横向拖动查看查看更多====>）
+ + ```javascript + export default { + IsDebug: false, // 是否debug模式，debug模式会打印log，可使用stat模块setDebug api进行修改 + 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已经判断平台） + } +}; + ``` + + + 参数详解： + +
+1. **Env ( number )：**SDK执行环境，建议开发者测试联调阶段设为110。 + + > 提审阶段一定要设为100 + + > 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) + + > 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) + + 100：正式环境，请求api域名地址为：https://dataapi.d3games.com + + 110：测试环境，请求api域名地址为：https://pre-dataapi.d3games.com + +2. **IsDebug ( boolean )：**是否debug模式，debug模式会打印sdk中的console.log/error/warn log。 + + false：关闭log打印，提审前建议设置为false，不打印log信息 + + true：开启log打印，如遇到联调问题，可设置为true，发体验版本或者查看log发给相关人员进行查看解决问题 + + 也可在代码中动态设置：PCSDK.stat.setDebug( boolean ) + +3. **AdCacheDuration（number）：**表示获取广告位列表的缓存时间，例如：配置30，SDK中拉取交叉推广位列表后缓存30秒。此参数对接入交叉推广位模块后有效，没有接入可不修改，使用默认值。 + +4. **IsUseShareModule( boolean )：**是否启用sdk分享/视频功能（sdk把分享和视频封装为share模块，登录后台->【游戏数据】->【配置相关】->【分享/视频配置】后可对分享视频进行动态配置） + + false：SDK启动时不拉取分享/视频列表，不接入分享/视频模块功能 + + true：SDK启动时拉取后台配置的分享/视频列表，运营或者开发者登录后台后，配置分享/视频，开发者请详看分享视频模块接入。 + +5. **IsOnlineAutoUse( boolean )：**是否启用在线配置参数模块功能 + + false：两种处理 1）不启用在线配置参数模块功能; 2）启用在线配置参数功能，但是SDK启动时不自动调用updateOnlineConfig拉取后台配置参数列表，开发者在代码主动调用拉取在线配置参数：PCSDK.online.updateOnlineConfig(); + + 示例：开发者代码中主动拉取在线配置参数。 + + ```javascript + // 后台 ->【游戏数据】->【配置参数】栏配置了：是否显示微信插屏广告、交叉推广位是否展示动态开关 + PCSDK.online.updateOnlineConfig().then(() => { + // 获取是否后台动态配置开启插屏广告，1为开启，0为关闭 + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1; + // isInterstitialAd && '显示插屏广告'; + // 获取动态多个广告位开启的配置 + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 }); + // pcGameOpenMap.Drawer === 1 && '显示抽屉推广位'; + // pcGameOpenMap.GuessLike === 1 && '显示猜你喜欢推广位'; + // pcGameOpenMap.Cross === 1 && '显示交叉推广位'; + }); + ``` + true：sdk启动时自动调用updateOnlineConfig拉取后台在线配置参数列表，开发者可通过 + + PCSDK.online.getParamsObj、PCSDK.online.getParamsInt、PCSDK.online.getParamsString、PCSDK.online.getParams api传递后台配置参数key获取在线配置参数。 + + 示例：IsOnlineAutoUse: true，开发者可使用下面api获取在线配置参数配置的值 + + ```javascript + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1; + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 }); + ``` + +6. **IsOnlineDebug( boolean )：**是否启用online模块（在线配置参数）debug模式，建议设置为true。 + + false：不启动debug模式，开发者主动调用updateOnlineConfig或者SDK启动时调用updateOnlineConfig都会把在线配置参数列表设置10分钟缓存，不用每次都去服务器请求，参照了友盟在线参数功能的设计 + + true: 开启debug模式，只要是请求updateOnlineConfig api都会立即发起请求，而不是去检测读取缓存 + +7. **ShareRightKey( string )：**右上角分享的shareKey，shareKey请阅读分享视频模块，默认为forward，为空字符串则不使用右上角分享，此配置在配置【IsUseShareModule: true】情况下生效。 + + 示例： + + 在后台的【分享/视频配置】栏目配置了一条分享key为：forward的分享配置 + + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_004.png "🔍点击查看大图") + +8. **ShareData( object )：**此配置在【IsUseShareModule: true】起效，开发者如果接入了分享视频模块，>>> 请务必配置一条 <<<。 + + > IsUseShareModule设置true sdk启动拉取分享视频配置列表，如果分享视频列表拉取请求失败，或此shareKey不在分享视频配置列表中（登录后台 ->【游戏数据】->【分享/视频配置】栏没有配置分享key）就会使用此条设置的数据。 + + 示例：可从后台【游戏数据】->【分享/视频配置】中选取一条：复制文案，点击分享素材icon -> 查看大图 -> 右键查看分享图片的html源码复制src图片地址： + + ```json + { + // 分享文案内容 + share_desc: ' 半夜传来啪啪啪！竟是隔壁老王偷偷打气球', + // 可选，视频广告uid，配置此参数，拉取不到对应的shareKey，推送看视频，不配置或者配置的uid无效则推送分享 + share_wxad_id: 'adunit-6958dcfc3f0bed31', + // 分享图 + share_icon: 'https://dep.miso-lab.com/data_analysis/games/res/5D57D4A3Yx.png' + } + ``` + + 操作步骤： + + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_005.png "🔍点击查看大图") + +9. **GameId：必填，游戏id，请联系运营人员提供** + +10. **ChannelId：必填，游戏渠道id，请联系运营人员提供** + +11. **Secret：必填，游戏 Secret Key，请联系运营人员提供** + +12. **MidasPay( object )：**米大水虚拟支付配置，没有接入微信的米大师支付，请注意下面规则 + + OfferId：在米大师申请的应用id，没有接入米大师，默认为"0" + + ZoneId：分区ID，默认："1" + + Mode：支付的类型，不同的支付类型有各自额外要传的附加参数，默认："game" + + CurrencyType：币种，默认："CNY" + + Platform：申请接入时的平台，platform与应用id有关。 + + 1）接入了米大师，填写"android"（ios暂时没有开放） + + 2）未接入米大师，使用其他支付，如果只支持android，则填写"android"； + + 3）未接入米大师，使用其他支付，如果只支持ios，则填写"ios"； + + 4）未接入米大师，使用其他支付，如果支持ios和android，则填写为""，sdk会根据手机识别android还是ios + + + +* #### 如果项目使用Typescript语言开发，请引入解压文件夹下的sdk.d.ts文件到项目中。 + + 示例：项目采用的是Laya Typescript版本进行开发，将该文件复制到libs目录下面 + + ![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/inner/intro.md b/inner/intro.md new file mode 100644 index 0000000..89665db --- /dev/null +++ b/inner/intro.md @@ -0,0 +1,64 @@ +# 噗嗤SDK +PCSDK（噗嗤SDK）是一款封装了微信小游戏、QQ小游戏平台常用api接口和用户行为数据上报的一款产品。 +PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台，后台对数据统计分析后以多样化的方式展现数据。 + +**PCSDK提供的模块功能：** + +- [统计模块](stat.md) +- [分享视频模块](share.md) +- [配置参数模块️](online.md) +- [多平台接口模块](platform.md) +- [数据模块](data.md) +- [事件模块](event.md) + + + +# 噗嗤管理后台 +噗嗤管理后台对sdk中上报的各项数据进行分析；管理sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、交叉推广位配置、用户自定义事件配置。 + +方便开发者联调测试阶段不影响上线游戏运营相关数据或者配置信息，config.js的Env配置提供测试和正式环境切换。 + +> 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) + +> 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) + +噗嗤管理后台地址： + +- 测试服后台，地址：http://pre-data.d3games.com/#/login + +- 正式服后台，地址：https://data.d3games.com/#/login + +**友情提示：** + +- **之后文档中'后台'指的是[噗嗤管理后台]，而不是微信小程序/小游戏后台。** +- **后台登录账号获取：需提供手机信息给我方运营，运营创建后台登录账号、密码后提供反馈。** +- **登录后台即可使用后台提供的各项服务** + + + +**后台概览：** +## ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_006.png "🔍点击查看大图") + + + +**后台提供数据分析功能（不能跳转请联系管理员添加权限）：** + +- [注册/活跃用户，在线时长实时数据分析](https://data.d3games.com/index.html#/view_chart) +- [分享数据分析](https://data.d3games.com/index.html#/share_exact) +- [用户事件行为分析](https://data.d3games.com/index.html#/dot_list) +- [渠道数据统计分析](https//data.d3games.com/index.html#/channel_stat_list) + + + +**后台提供配置相关功能（不能跳转请联系管理员添加权限）：** + +- [分享/视频配置](http://pre-data.d3games.com/index.html#/share_list) +- [配置参数](http://pre-data.d3games.com/index.html#/config_list) + + +# 更多： +- 快速接入，请详读 [安装步骤](install.md) + + + +- 遇到问题可以查看 [FAQ](faq.md) \ No newline at end of file diff --git a/inner/stat_ads.md b/inner/stat_ads.md new file mode 100644 index 0000000..e07e60d --- /dev/null +++ b/inner/stat_ads.md @@ -0,0 +1,543 @@ +# 交叉推广位 + +------ + +#### **简介** + +交叉推广位是在游戏中展示其他游戏，用户点击某个游戏跳转进入游戏，达到共享用户的目的。 + +噗嗤游戏提供了3种类型的交叉推广位，后台可对交叉推广位进行配置管理，对交叉推广位各项指标分析阅览。 + +**3种广告类型：交叉悬浮广告框、交叉抽屉式广告位、交叉猜你喜欢广告位** + +1. 交叉悬浮广告框，放置到首页、结算页 + + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_013.png "🔍点击查看大图") + +2. 交叉抽屉式广告位，放置到首页、结算页 + + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_014.png "🔍点击查看大图") + +3. 交叉猜你喜欢广告位，推荐放置到结算页 + + ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_015.png "🔍点击查看大图") + + + + + +#### **后台使用** + +完成接入交叉推广位后，登录后台->头部tab切换到【游戏数据】->【流量分析】->【广告导出】即可查看推广位的各项数据信息（需要后台管理人员添加权限）： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_012.png "🔍点击查看大图") + + + +#### **接入必读** + +- 由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的其它游戏需要在小游戏根目录下的全局配置文件game.json中进行添加配置：navigateToMiniProgramAppIdList，该参数定义请详读[小程序全局配置](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)。 + +- 噗嗤游戏为了方便开发者接入调试交叉推广位，【后台测试服】已经配置测试使用的不同类型推广位，并提供以下10个测试服广告位appid： + + 水果爆破 ："wx26822126b4d99eda", + + 球球涂涂涂："wxac0750884d5bed0c", + + 狂野漂移3D："wx019a09df638e6683", + + 星星爱消消："wx9ff47d13a88e5511", + + 土耳其方块消消乐："wx89efb2282d65a2d0", + + 成语小才子："wxd4d478c7d331ce80", + + 球球蹦蹦蹦："wxabee9afe62d0b114", + + 俄罗斯方块连连消："wx4cd087f19f4cb7c3", + + 球球爆爆爆："wxae33d68413f40641", + + 疯狂水果一刀切："wxdf26a04c53d6f1e9" + + ```javascript + "navigateToMiniProgramAppIdList": [ + "wx26822126b4d99eda", + "wxac0750884d5bed0c", + "wx019a09df638e6683", + "wx9ff47d13a88e5511", + "wx89efb2282d65a2d0", + "wxd4d478c7d331ce80", + "wxabee9afe62d0b114", + "wx4cd087f19f4cb7c3", + "wxae33d68413f40641", + "wxdf26a04c53d6f1e9" + ] + ``` + + + +- 完成下面的操作步骤，即可拉取交叉推广位： + + 1、开发者复制上面的10个其他游戏的appid，配置到game.json的navigateToMiniProgramAppIdList参数： + + ![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 "🔍点击查看大图") + + + +#### **接入API：** + +| **名称** | **功能说明** | +| --------------------------- | ------------------------------------------------------------ | +| PCSDK.stat.bannerList | 根据类型获取对应类型交叉广告列表，目前SDK支持3种类型：40（交叉悬浮广告框）、70（交叉抽屉式广告位）、50（交叉猜你喜欢广告位） | +| PCSDK.stat.bannerNavigateTo | 交叉推广位点击跳转到对应appid的游戏，该接口封装了小游戏的跳转功能（navigateToMiniProgram） | +| PCSDK.stat.addExposure | 交叉推广位一条或者多条广告展示，添加曝光数据，SDK在onHide时候上报数据到后台 | + + + + + + + +1. ##### **bannerList** + + ```javascript + PCSDK.stat.loadingFinish(banner_type): Promise + ``` + + 定义：根据类型获取对应类型交叉广告列表，目前SDK支持3种类型 + + 参数： + + ``` + banner_type: number 必填 目前支持三种广告类型：40、50、70 + ``` + + 返回值：Promise + + 返回的是Promise类型，Promise resolve成功回调数据结构为： + + ```json + { + "banner_list": [ + { + "banner_id": "3568", + "banner_name": "土耳其方块", + "banner_type": "40", + "banner_location": "100", + "banner_ad_id": "50", + "banner_launch_appid": "", + "banner_launch_path": "", + "banner_appid": "wx89efb2282d65a2d0", + "banner_path": "?channel_id=20361", + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CB97RK.png", + "banner_user_num": "0", + "banner_exposure_num": "0", + "banner_sort": "1", + "banner_game_id": "1000053", + "banner_qqgame": "0", + "banner_qqgame_id": "0", + "banner_game_type": 0, + "banner_bone": "0", + "banner_system": "0", + "banner_online": "1", + "banner_reddot": "0", + "banner_gender": "0", + "banner_resident": "0", + "banner_qrcode": "0", + "banner_qrcode_img": "", + "banner_bone_info": false, + "banner_img_info": { + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CB97RK.png" + } + }, + { + "banner_id": "3571", + "banner_name": "水果一刀切", + "banner_type": "40", + "banner_location": "100", + "banner_ad_id": "99", + "banner_launch_appid": "", + "banner_launch_path": "", + "banner_appid": "wxdf26a04c53d6f1e9", + "banner_path": "?channel_id=20361", + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CBACTt.png", + "banner_user_num": "0", + "banner_exposure_num": "0", + "banner_sort": "1", + "banner_game_id": "1000053", + "banner_qqgame": "0", + "banner_qqgame_id": "0", + "banner_game_type": 0, + "banner_bone": "0", + "banner_system": "0", + "banner_online": "1", + "banner_reddot": "0", + "banner_gender": "0", + "banner_resident": "0", + "banner_qrcode": "0", + "banner_qrcode_img": "", + "banner_bone_info": false, + "banner_img_info": { + "banner_icon": "https://dep.miso-lab.com/data_analysis/games/res/5D42CBACTt.png" + } + } + ] + } + + ``` + + > **返回的数据banner_list列表解析为 Array< BannerData >，BannerData是banner_list每一项数据实体，下面的bannerNavigateTo与addExposure接口api参数banner_data属于此BannerData结构**。 + + 示例： + + ```javascript + /** + * 演示交叉推广位使用示例 + */ + export default class TestBannerSample { + constructor() { + // 示例：加载交叉悬浮广告框 + this.loadBannerList(BannerType.TYPE_CROSS) + .then((dataList: Array) => { + // 渲染广告位数据 + this.renderAdCrossList(dataList); + }).catch(err => { + // bannerList不存在获取请求拉取失败 + }); + } + + /** + * 渲染广告位列表 + * @param dataList 广告位列表 + */ + private renderAdCrossList(dataList: Array) { + // ... + } + + /** + * 根据类型获取交叉推广位列表 + * @param banner_type 广告位类型 + */ + private loadBannerList(banner_type: BannerType): Promise { + return new Promise((resolve, reject) => { + PCSDK.stat.bannerList(banner_type) + .then(data => { + let bannerList: Array = data.banner_list || []; + if (bannerList.length) { + // 处理bannerList数据列表 + resolve(bannerList); + } else { + // 处理数据为空情况 + reject(null); + } + }).catch(err => { + // 请求接口报错情况 + reject(err); + }); + }); + } + } + + // 广告位类型的枚举 + enum BannerType { + TYPE_CROSS = 40, // 交叉悬浮广告框 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位 + TYPE_LIST = 70, // 交叉抽屉广告位 + } + + /* + * banner数据实体结构 + */ + class BannerData { + public banner_id: string; + public banner_appid: string; + public banner_diamond: number; + public banner_type: string; + public banner_icon: string; + public banner_name: string; + public banner_resident: string; // 是否常驻 + } + ``` + +2. ##### **bannerNavigateTo** + + ```javascript + PCSDK.stat.bannerNavigateTo( location:number, banner_data: any, opts?: { extraData?: string; envVersion?: string }): Promise + ``` + + 定义：交叉推广位点击游戏跳转到对应appid的游戏，该接口封装了小游戏的跳转功能（navigateToMiniProgram）, 第三个参数配置可参考[wx.navigateToMiniProgram extraData、envVersion配置信息](https://developers.weixin.qq.com/minigame/dev/api/open-api/miniprogram-navigate/wx.navigateToMiniProgram.html) + + 参数： + + ```javascript + location: number 必传，统一传递为：100 + + banner_data：any 必传，点击跳转项对应数据，该数据的结构为BannerData，为bannerList获取的Array的单元实体项 + + opts: object 选传，调试阶段可参照[wx.navigateToMiniProgram(Object object) extraData配置信息]进行裴旭 + { + extraData: string 选传, 需要传递给目标小程序的数据，目标小程序可在 App.onLaunch，App.onShow 中获取到这份数据 + envVersion: string 选传，要打开的小程序版本，合法值：develop、trial、release + } + ``` + + 示例：获取猜你喜欢推广位，以列表的形式显示在界面上，点击任意一项游戏跳转其他游戏 + + ```javascript + // 发起登录请求，得到登录数据信息，调用setLogind设置SDK用户信息 + /** + * 演示交叉推广位使用示例 + */ + export default class TestBannerSample extends ui.shop.ShopPopwinUI { + private list: Laya.List; + + constructor() { + super(); + + // 创建List ui + this.list = new Laya.List(); + this.list.itemRender = AdItem; + this.list.vScrollBarSkin = ""; + this.list.scrollBar.elasticBackTime = 500; + this.list.scrollBar.elasticDistance = 350; + this.list.x = 0; + this.list.y = 0; + this.list.spaceY = 10; + this.list.height = 1000; + this.list.renderHandler = new Laya.Handler(this, this.renderAdItem); + this.boxList.addChild(this.list); + + // 示例：加载猜你喜欢广告位数据列表 + this.loadBannerList(BannerType.TYPE_LIKE) + .then((dataList: Array) => { + this.renderAdLikeList(dataList); + }).catch(err => { + // bannerList不存在获取请求拉取失败 + }); + } + + /** + * 渲染单个广告位ui + * @param cell + */ + private renderAdItem(cell: AdItem) { + cell.init(); + } + + /** + * 渲染广告位列表 + * @param dataList 广告位列表 + */ + private renderAdLikeList(dataList: Array) { + this.list.array = dataList; + } + + /** + * 根据类型获取交叉推广位列表 + * @param banner_type 广告位类型 + */ + private loadBannerList(banner_type: BannerType): Promise { + return new Promise((resolve, reject) => { + PCSDK.stat.bannerList(banner_type) + .then(data => { + let bannerList: Array = data.banner_list || []; + if (bannerList.length) { + // 处理bannerList数据列表 + resolve(bannerList); + } else { + // 处理数据为空情况 + reject(null); + } + }).catch(err => { + // 请求接口报错情况 + reject(err); + }); + }); + } + } + + class AdItem extends ui.ads.GameIconUI { + constructor() { + super(); + this.on(Laya.Event.CLICK, this, this.onJumpGame); + } + + init() { + let { banner_icon, banner_name, banner_reddot } = this.dataSource; + this.iconTex.skin = banner_icon; + this.nametxt.text = banner_name; + this.hot.visible = banner_reddot + '' === '1'; + } + + private onJumpGame(ev: Laya.Event) { + PCSDK.stat.bannerNavigateTo(100, { ...this.dataSource }).catch(err => { + // 跳转游戏微信弹出二次确认框，点击取消执行此处 + }); + } + } + + // 广告位类型的枚举 + enum BannerType { + TYPE_CROSS = 40, // 交叉悬浮广告框 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位 + TYPE_LIST = 70, // 交叉抽屉广告位 + } + + /* + * banner数据实体结构 + */ + class BannerData { + public banner_id: string; + public banner_appid: string; + public banner_diamond: number; + public banner_type: string; + public banner_icon: string; + public banner_name: string; + public banner_resident: string; // 是否常驻 + } + ``` + + +3. ##### **addExposure** + + ```javascript + PCSDK.stat.addExposure( location: number, banner_data: Array< any > | any ): void + ``` + + 定义：对一个或者多个展示的推广位添加曝光，SDK在onHide时候上报曝光数据到后台，后台进行统计查阅 + + 参数： + + ```javascript + location: number 必传，统一传递为：100 + + banner_data：any 必传，添加展推广位曝光数据，可添加一个或者多个曝光数据，banner_data参数数据结构为上面bannerList api返回的列表数据的项BannerData实体结构：Array | BannerData + + ``` + + > 提示： + > + > 展示猜你喜欢/抽屉推广位：获取到9个推广位数据，展示了其中5个，调用曝光接口传入推广位数据为展示的5个，剩余的4个需在其展示的时候再调用曝光api接口传入。 + > + > 展示交叉悬浮框推广位：展示一个，将此推广位传入曝光接口，点击展示下一个，则把这个最新的数据传入曝光api + + 示例：根据交叉悬浮框类型调用PCSDK.stat.bannnerList接口获取交叉悬浮框推广位列表，显示第一个，每隔4秒切换到下一个，点击一个切换下一个展示。此示例没有使用定时器方式，采用的是监听动画帧实现。 + ```javascript + /** + * 演示交叉推广位使用示例 + */ +export default class TestBannerSample extends ui.ads.ADbtnUI { + private data; + private count: number; + private adList: Array; + + constructor() { + super(); + this.count = 0; + this.adList = []; + this.on(Laya.Event.CLICK, this, this.onJumpGame); + } + + // 初始化显示交叉悬浮框广告位 + init(isFirst: boolean) { + isFirst && (this.count = 0); + this.anim_entice.play(0, true); + this.anim_entice.addLabel('refresh', 38); + // 交叉悬浮框动画执行到第38帧，自动更新下一个，开发者可根据实际使用定时器实现切换下一个 + this.anim_entice.on(Laya.Event.LABEL, this, this.handleAutoRrefresh); + // 第一次 + this.refresh(); + } + + // 清理交叉悬浮框广告位 + clear() { + this.anim_entice.gotoAndStop(0); + this.anim_entice.removeLabel('refresh'); + this.anim_entice.off(Laya.Event.LABEL, this, this.handleAutoRrefresh); + } + + private refresh() { + let list = this.adList; + if (!list || !list.length) { + this.loadBannerList(BannerType.TYPE_CROSS).then(() => this.refresh()); + return; + } + let data = list.pop(); + this.renderAdui(data); + this.data = data; + // 添加曝光数据 + PCSDK.stat.addExposure(100, data); + // 也可以采用传递多个方式 + // PCSDK.stat.addExposure(100, [{...data}]); + } + + private renderAdui(data) { + let { banner_bone_info, banner_img_info } = data; + if (banner_bone_info) { + this.imgIcon.visible = false; + } else { + this.imgIcon.visible = true; + this.imgIcon.skin = banner_img_info.banner_icon; + } + this.imgHot.visible = data.banner_reddot + '' === '1'; + } + + private onJumpGame(ev: Laya.Event) { + this.anim_entice.gotoAndStop(39); + this.anim_entice.play(39, true); + // 切换下一个 + this.refresh(); + PCSDK.stat.bannerNavigateTo(100, { ...this.data }).catch(err => { + // 跳转游戏微信弹出二次确认框，点击取消执行此处 + }); + } + + /** + * 处理自动切换下一个 + * @param name + */ + private handleAutoRrefresh(name) { + if (name === 'refresh' && this.count !== 0) { + this.refresh(); + } + this.count++; + } + + /** + * 根据类型获取交叉推广位列表 + * @param banner_type 广告位类型 + */ + private loadBannerList(banner_type: BannerType): Promise { + return new Promise((resolve, reject) => { + PCSDK.stat.bannerList(banner_type) + .then(data => { + let bannerList: Array = data.banner_list || []; + if (bannerList.length) { + // 处理bannerList数据列表 + resolve(bannerList); + } else { + // 处理数据为空情况 + reject(null); + } + }).catch(err => { + // 请求接口报错情况 + reject(err); + }); + }); + } + } + + // 广告位类型的枚举 + enum BannerType { + TYPE_CROSS = 40, // 交叉悬浮广告框 + TYPE_LIKE = 50, // 交叉猜你喜欢广告位 + TYPE_LIST = 70, // 交叉抽屉广告位 + } + ``` \ No newline at end of file diff --git a/install.md b/install.md index 37cb60f..cb40449 100644 --- a/install.md +++ b/install.md @@ -28,10 +28,6 @@ ## 配置合法域名 * ##### 管理员或开发者身份在微信小程序后台→设置→开发者设置中添加 request、download合法域名 - 测试环境 request 合法域名： - - https://pre-dataapi.d3games.com （统计平台测试服域名） - 正式环境 request 合法域名： https://dataapi.d3games.com （统计平台正式服域名） @@ -39,7 +35,7 @@ cdn资源请求合法域名： https://dep.miso-lab.com （>>>request、download均要添加<<<） - + @@ -70,7 +66,6 @@ ```javascript export default { IsDebug: false, // 是否debug模式，debug模式会打印log，可使用stat模块setDebug api进行修改 - Env: 100, // 100表示正式环境，110表示测试环境，推荐测试联调阶段使用110，提审前切记改成100！！！ AdCacheDuration: 30, // 广告列表缓存持续时间间隔 IsUseShareModule: true, // 是否使用分享模块 IsOnlineAutoUse: true, // 是否开启sdk自动请求online模块（在线参数配置）的updateOnlineConfig，拉取在线参数配置 @@ -92,25 +87,13 @@ CurrencyType: "CNY", // 币种，默认：CNY Platform: '' // 申请接入时的平台，platform与应用id有关。默认：android（ios暂时没有开放，这里需要配置Platform，开放后，删掉此配置，sdk已经判断平台） } -}; - ``` + }; +``` - - 参数详解： - -
-1. **Env ( number )：**SDK执行环境，建议开发者测试联调阶段设为110。 - > 提审阶段一定要设为100 - - > 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) +参数详解： - > 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) - - 100：正式环境，请求api域名地址为：https://dataapi.d3games.com - - 110：测试环境，请求api域名地址为：https://pre-dataapi.d3games.com - +
2. **IsDebug ( boolean )：**是否debug模式，debug模式会打印sdk中的console.log/error/warn log。 false：关闭log打印，提审前建议设置为false，不打印log信息 diff --git a/intro.md b/intro.md index 89665db..84e8e28 100644 --- a/intro.md +++ b/intro.md @@ -14,19 +14,11 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， # 噗嗤管理后台 -噗嗤管理后台对sdk中上报的各项数据进行分析；管理sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、交叉推广位配置、用户自定义事件配置。 - -方便开发者联调测试阶段不影响上线游戏运营相关数据或者配置信息，config.js的Env配置提供测试和正式环境切换。 - -> 测试环境各种配置管理、数据分析查看，请[前往测试服后台](http://pre-data.d3games.com/#/login) - -> 正式环境各种配置管理、数据分析查看，请[前往正式服后台](https://data.d3games.com/#/login) +噗嗤管理后台对sdk中上报的各项数据进行分析，管理sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、交叉推广位配置、用户自定义事件配置。 噗嗤管理后台地址： -- 测试服后台，地址：http://pre-data.d3games.com/#/login - -- 正式服后台，地址：https://data.d3games.com/#/login +- https://data.d3games.com/#/login **友情提示：** @@ -52,8 +44,8 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， **后台提供配置相关功能（不能跳转请联系管理员添加权限）：** -- [分享/视频配置](http://pre-data.d3games.com/index.html#/share_list) -- [配置参数](http://pre-data.d3games.com/index.html#/config_list) +- [分享/视频配置](https://data.d3games.com/index.html#/share_list) +- [配置参数](https://data.d3games.com/index.html#/config_list) # 更多： diff --git a/modules.md b/modules.md index c4609c2..e48c460 100644 --- a/modules.md +++ b/modules.md @@ -15,14 +15,6 @@ PCSDK上报小游戏用户所触发的各种行为数据到噗嗤管理后台， # 噗嗤管理后台 噗嗤管理后台统计sdk中上报的各项数据进行分析；管理各种sdk中所需要的配置信息：分享/视频配置、配置参数（在线参数配置）、噗嗤游戏导出广告配置、用户事件行为配置。 -为了开发联调测试阶段不影响游戏已上线运营相关数据或者配置信息，特意对管理后台做了测试和线上服划分，噗嗤管理后台分为：测试服后台，正式服后台： - -噗嗤管理后台后台地址： - -- 正式服后台，地址：https://data.d3games.com/#/login - -- 测试服后台，地址：http://pre-data.d3games.com/#/login - **友情提示：** - **之后文案中后台指的是噗嗤管理后台，而不是微信小程序/小游戏后台。** diff --git a/share.md b/share.md new file mode 100644 index 0000000..076231b --- /dev/null +++ b/share.md @@ -0,0 +1,184 @@ + +# 分享视频模块 + +------ + +#### **简介** +小游戏生态中，大家普遍把平台提供的分享/视频接口更多用于某个奖励领取、获取n倍奖励、游戏死亡复活、转盘额外次数获得等等一种有效途径（分享：拉取新用户，视频：赚钱广告费）；噗嗤游戏在分享or视频平衡推送切换不断的探索迭代中，总结了一套分享/视频积分策略，集成在SDK中开放给开发者，开发者在后台界面化操作下能方便的对某个功能点分享文案、分享图、推送类型（分享、视频）进行添加修改： + +- 分享/视频配置可以让开发者在后台中动态修改相关功能的分享/视频配置内容。 + +- 新增某个功能的分享点配置、在线修改相关功能的分享图或文案、在线切换某个功能按钮的分享/视频功能。 + + + +#### **后台使用** + +配置分享视频配置，登录后台->头部tab切换到【游戏数据】->【配置相关】->【分享/视频配置】可新增、编辑修改分享/视频内容： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_023.png "🔍点击查看大图") + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_024.png "🔍点击查看大图") + +接入分享视频模块后，后台已经对分享和视频数据分别进行整理统计了，游戏接入方可实时阅览分享/视频的各项数据: + +查看分享分析，登录后台->头部tab切换到【游戏数据】->【产品分析】->【分享分析】可阅览游戏分享数据的各项统计： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_025.png "🔍点击查看大图") + +查看视频广告详情，登录后台->头部tab切换到【游戏数据】->【配置相关】->【视频广告详情】可阅览游戏各个功能点视频数据统计： + +![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_026.png "🔍点击查看大图") + + + +#### **接入必读** + +- 接入此模块前，请[**前往sdk/config.js文件中配置【IsUseShareModule: true 】开启share模块功能**](install.md#config_env)，此参数配置为true，SDK启动时将自动拉取后台 -> 【分享/视频配置】配置的分享/视频配置列表。 +- 微信小游戏开发者接入此模块，提审时候为了避免触犯微信平台的[滥用分享行为](https://developers.weixin.qq.com/minigame/product/#_5-1-滥用分享行为)，在后台【配置参数】中配置了一个系统级别的配置参数share_unlock，进行分享开关切换：1（开启）0（关闭），提审时候设置为0，审核通过后设置为1，SDK中读取此参数，如果推送的是分享，最终处理为无视频无分享模式。 +- 开发者如 + + +#### 接入API：** + +| **名称** | **功能说明** | +| ------------------------------- | ------------------------------------------------------------ | +| PCSDK.online.updateOnlineConfig | 拉取后台配置的配置参数数据，可代码中手动调用，也可以通过config.js中配置SDK主动拉取，注意：使用前请详细[阅读config.js的IsOnlineAutoUse和IsOnlineDebug参数详解](install.md#config_env) | +| PCSDK.online.getParamsInt | 根据在线参数key获取number类型参数值，适合配置参数为：整数、浮点数 | +| PCSDK.online.getParamsObj | 根据在线参数key获取object类型参数值，适合配置参数为：数组、json对象 | +| PCSDK.online.getParamsString | 根据在线参数key获取string类型参数值，适合配置参数为：字符串、json字符串 | + + + +1. ##### **updateOnlineConfig** + + ```javascript + PCSDK.online.updateOnlineConfig(): Promise + ``` + + 定义：拉取后台配置的配置参数数据， + + 提示： + + > [config.js中配置IsOnlineAutoUse](install.md#config_env)为true：SDK启动时自动去拉取在线配置参数，开发者不需要调用此接口，不然会导致重复拉取 + > + > [config.js中配置IsOnlineAutoUse](install.md#config_env)为false：有两种理解方式：1）不接入使用在线配置参数模块；2）接入使用在线配置参数模块，开发者自己手动调用updateOnlineConfig api处理逻辑。 + > + > 下面示例会演示两种不同配置的使用范例： + + 参数： + + ``` + 无 + ``` + + 返回值： + + ``` + Promise + ``` + +
+示例1：config.js配置IsOnlineAutoUse为false，开发者调用updateOnlineConfig api手动拉取在线配置参数数据 + +```javascript + // 后台 ->【游戏数据】->【配置参数】栏配置了：是否显示微信插屏广告、交叉推广位是否展示动态开关 + PCSDK.online.updateOnlineConfig().then(() => { + // 使用1：获取是否后台动态配置开启插屏广告，1为开启，0为关闭 + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1; + // isInterstitialAd && '显示插屏广告'; + + // 使用2：获取动态多个广告位开启的配置 + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 }); + // pcGameOpenMap.Drawer === 1 && '显示抽屉推广位'; + // pcGameOpenMap.GuessLike === 1 && '显示猜你喜欢推广位'; + // pcGameOpenMap.Cross === 1 && '显示交叉推广位'; + + // 使用3：获取签到配置 + let signRewardCfg = PCSDK.online.getParamsObj('sign_reward_cfg', [100, 300, 500, 700, 900, 2000, 3000]); + + // 使用4：获取动态bannerUid + let bannerUid = PCSDK.online.getParamsString('banner_common_uid', 'adunit-fe38438f074c717f'); + // bannerUid && '显示banner'; + }); +``` + +示例2：config.js配置IsOnlineAutoUse为true，SDK启动时会自动调用 updateOnlineConfig api拉取在线配置参数数据 + +```javascript + let isInterstitialAd = PCSDK.online.getParamsInt('interstitial_ad_open', 0) === 1; + let pcGameOpenMap = PCSDK.online.getParamsObj('pc_games_open', { "Drawer": 0, "GuessLike": 0, "Cross": 0 }); +``` + + + +2. ##### **getParamsInt** + + ```javascript + PCSDK.online.getParamsInt( key: string, defaultVal?: number ): number + ``` + + 定义：根据在线参数key获取number类型参数值，适合配置参数为：整数、浮点数 + + 参数： + + ```javascript + key: string 必传 后台 ->【配置参数】配置的key + defaultVal: number 选传 默认值 后台没有配置此key，或在线配置参数数据拉取失败，则返回此值 + ``` + + 返回值： + + ``` + number + ``` + + 示例：[查看上面的示例代码](online.md#sample) + +3. **getParamsObj** + + ```javascript + PCSDK.online.getParamsObj( key: string, defaultVal?: any ): any + ``` + + 定义：根据在线参数key获取object类型参数值，适合配置参数为：数组、json对象 + + 参数： + + ```javascript + key: string 必传 后台 ->【配置参数】配置的key + defaultVal: any 选传 默认值 后台没有配置此key，或在线配置参数数据拉取失败，则返回此值 + ``` + + 返回值： + + ``` + object | array | null + ``` + + 示例：[查看上面的示例代码](online.md#sample) + +1. **getParamsString** + + ```javascript + PCSDK.online.getParamsString( key: string, defaultVal?: string ): string + ``` + + 定义：根据在线参数key获取string类型参数值，适合配置参数为：字符串、json字符串 + + 参数： + + ```javascript + key: string 必传 后台 ->【配置参数】配置的key + defaultVal: string 选传 默认值 后台没有配置此key，或在线配置参数数据拉取失败，则返回此值 + ``` + + 返回值： + + ``` + string + ``` + + 示例：[查看上面的示例代码](online.md#sample) + + \ No newline at end of file diff --git a/stat_ads.md b/stat_ads.md index e07e60d..acabbf3 100644 --- a/stat_ads.md +++ b/stat_ads.md @@ -38,7 +38,7 @@ - 由于微信对每个游戏可跳转其他游戏有10个限制，可跳转的其它游戏需要在小游戏根目录下的全局配置文件game.json中进行添加配置：navigateToMiniProgramAppIdList，该参数定义请详读[小程序全局配置](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)。 -- 噗嗤游戏为了方便开发者接入调试交叉推广位，【后台测试服】已经配置测试使用的不同类型推广位，并提供以下10个测试服广告位appid： +- 噗嗤游戏为了方便开发者接入调试交叉推广位，后台已经配置测试使用的3种类型推广位，提供以下10个推广位appid，开发者复制下面的navigateToMiniProgramAppIdList json数据，配置到game.json的navigateToMiniProgramAppIdList参数： 水果爆破 ："wx26822126b4d99eda", @@ -75,20 +75,9 @@ ] ``` - - -- 完成下面的操作步骤，即可拉取交叉推广位： - - 1、开发者复制上面的10个其他游戏的appid，配置到game.json的navigateToMiniProgramAppIdList参数： - ![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 "🔍点击查看大图") - #### **接入API：** @@ -101,10 +90,6 @@ - - - - 1. ##### **bannerList** ```javascript diff --git a/stat_event.md b/stat_event.md index 796ef9b..9a20d9a 100644 --- a/stat_event.md +++ b/stat_event.md @@ -16,7 +16,7 @@ #### **接入必读** -接入自定义事件打点前，请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件的key：登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】->点击【新增】添加自定义事件（事件key可语义化的自定义，推荐_连接）。 +接入自定义事件打点前，请[前往后台](https://data.d3games.com/index.html#/login)进行添加自定义事件的key：登录后台->头部tab切换到【游戏数据】->【产品分析】->【事件分析】->点击【新增】添加自定义事件（事件key可语义化的自定义，推荐_连接）。 ![sdk文件目录结构](https://dep.miso-lab.com/sdkword/sdk_016.png "🔍点击查看大图") @@ -91,7 +91,7 @@ enum EventKeys { | **名称** | **功能说明** | | ---------------- | ------------------------------------------------------------ | -| PCSDK.stat.event | 自定义事件打点，使用前请[前往后台](http://pre-data.d3games.com/index.html#/login)进行添加自定义事件key | +| PCSDK.stat.event | 自定义事件打点，使用前请[前往后台](https://data.d3games.com/index.html#/login)进行添加自定义事件key | diff --git a/stat_level.md b/stat_level.md index 03bbafe..00afe8a 100644 --- a/stat_level.md +++ b/stat_level.md @@ -52,9 +52,18 @@ ```javascript PCSDK.stat.logLevelHide(levelId: string | number , opts?: { attr: number } ): void ``` + 定义：监听游戏战斗界面onHide时上报关卡的数据。什么是界面onHide？[请详读微信小游戏wx.onHide](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onHide.html) + 注意事项： - > 定义：游戏中onHide时（设置wx.onHide回调监听事件）关卡onHide数据上报。 - > 需要屏蔽掉复活、失败、成功状态 + > 1）游戏战斗界面监听平台的onHide事件，使用此api上报关卡onHide打点。 + > + > + + > 2）游戏战斗界面退出后，要移除onHide事件监听，避免在其他界面下，onHide时候执行此次上报。 + > + > + + > 3）一定要屏蔽游戏复活中、游戏失败、游戏通过成功状态，这三种状态下避免上报此打点，详看下面示例。 参数： @@ -66,7 +75,6 @@ attr: number 战斗属性（例如:关卡战斗中所使用的枪支等级） } ``` - [点此查看完整示例](stat_level.md#sample)如何添加关卡onHide打点代码 3. #### **logLevelFail** @@ -112,8 +120,7 @@ } ```
完整示例，以上四个接口使用场景： -> 游戏监听wx.onHide回调中上报关卡onHide隐藏打点（需要屏蔽掉复活、失败、成功状态）。 -> SDK中监听了wx.onHide事件，当游戏onHide时，SDK会发送事件名为'app.hide'的自定义事件，开发者可在代码中使用PCSDK.event.bindEvent监听该事件，使用PCSDK.event.removeEvent移除对应监听事件，[详细文档event模块文档请阅读event事件模块](evennt.md)。 +> SDK中监听了onHide事件，当游戏onHide时，SDK会发送事件名为'app.hide'的自定义事件，开发者可在代码中使用PCSDK.event.bindEvent监听该事件，使用PCSDK.event.removeEvent移除对应监听事件，[详细文档event模块文档请阅读event事件模块](evennt.md)。 ```javascript /** @@ -161,7 +168,7 @@ EventCenter.I.remove('level.relive', this, this.handleLevelRelive); } - // 游戏复活 + // 游戏复活中 private doGameRelive(){ this.setState(GameState.Relive); } @@ -178,14 +185,14 @@ // SDK发出的app.hide事件监听 private handleHide() { - // 关卡onHide上报（成功、失败、复活不进行logLevelHide上报） + // 战斗界面onHide上报logLevelHide（游戏通关成功、游戏通关失败、游戏复活中不进行上报logLevelHide打点） if(!(this.isState(GameState.Win) || this.isState(GameState.Fail) || this.isState(GameState.Relive))) PCSDK.stat.logLevelHide(this.missionId, { attr: this.currSelectGun }); } - // 监听关卡复活消息 + // 监听关卡复活成功消息 private handleLevelRelive(){ // 关卡复活成功上报 PCSDK.stat.logLevelRelive(this.missionId, { @@ -227,7 +234,7 @@ }); break; - case GameState.Relive:// 处理复活 + case GameState.Relive:// 处理复活中 // 弹出复活操作界面 PopWinManager.I.openPopwin(RelivePopwinn); break; @@ -242,7 +249,7 @@ // 复活界面关闭 close(){ super.close(); - // 关闭模拟复活成功，发送消息 + // 关闭模拟:复活成功，发送复活成功消息 EventCenter.I.emit('level.relive'); } } diff --git a/styles/website.css b/styles/website.css new file mode 100644 index 0000000..7d92dfd --- /dev/null +++ b/styles/website.css @@ -0,0 +1,68 @@ +/* CSS for website */ +h1 , h2{ + border-bottom: 1px solid #EFEAEA; + padding-bottom: 3px; +} +.markdown-section>:first-child { + margin-top: 0!important; +} +.page-wrapper { + margin-top: -1.275em; +} +.book .book-body .page-wrapper .page-inner section.normal { + min-height:350px; + margin-bottom: 30px; +} + +.book .book-body .page-wrapper .page-inner section.normal hr { + height: 0px; + padding: 0; + margin: 1.7em 0; + overflow: hidden; + background-color: #e7e7e7; + border-bottom: 1px dotted #e7e7e7; +} + +.video-js { + width:100%; + height: 100%; +} + +pre[class*="language-"] { + border: none; + background-color: #f7f7f7; + /* font-size: 1em; */ + line-height: 1.2em; +} + +.book .book-body .page-wrapper .page-inner section.normal { + font-size: 16px; + font-family: "ubuntu", "Tahoma", "Microsoft YaHei", arial, sans-serif; +} + +.aceCode { + font-size: 14px !important; +} + +input[type=checkbox]{ + margin-left: -2em; +} + +.page-footer span{ + font-size: 12px; +} + +.page-footer .copyright { + float: left; +} + +.body, html { + overflow-y: hidden; +} + +.versions-select select { + height: 2em; + line-height: 2em; + border-radius: 4px; + background: #efefef; +} -- libgit2 0.21.0