04/29/2024 11:54:52
Beacon 渠道说明
二、开发者平台配置
如果业务已在灯塔官网注册应用并获得 App Key 参数，可直接使用官网生成的参数，无需在飞鹰进行额外配置。
如果业务未在灯塔官网注册应用，同时无灯塔官网注册应用需求，则可直接使用飞鹰系统注册应用后，自动生成的灯塔 Key 参数（参数获取路径：飞鹰系统>游戏管理列表页>游戏详情页>SDK参数>灯塔Key）。
注意：灯塔官网生成的参数和飞鹰系统生成的参数不可混用。灯塔迁移到新管理端后，使用灯塔和飞鹰生成的参数，都需要将 appkey 绑定到所属业务，具体参考 2.1 注册账号。
2.1 注册账号
灯塔应用统计已迁移到新管理端 http://analytics.beacon.tencent.com/，新管理端应用注册和绑定到所属业务的方式，参考灯塔文档指引：http://tapd.oa.com/beacon_wiki/markdown_wikis/show/#1220412912001667727，如有疑问，可咨询：灯塔小秘。
[info] 灯塔旧版本管理端 https://beacon.tencent.com/ 。
三、 Android工程配置
3.1 权限配置
1）必选权限列表
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
2）可选权限列表
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
[info]
READ_PHONE_STATE为敏感权限，主要用于设备获取标识；
WRITE_EXTERNAL_STORAGE为敏感权限，主要用于写 SD 卡文件；
3.2 灯塔 App Key 配置
在工程文件 assets/MSDKConfig.ini 中添加配置
[灯塔 Beacon 配置]
BEACON_APP_KEY_ANDROID = {YOUR_BEACON_APP_KEY}
[info]
{YOUR_BEACON_APP_KEY}灯塔 App Key，需要换成业务需要的真实值，可以从灯塔管理端获取。如果业务已在灯塔官网注册应用并获得 App Key 参数，可直接使用官网生成的参数，无需在飞鹰进行额外配置。
3.3 调试模式
在工程文件 assets/MSDKConfig.ini 中添加配置
[灯塔 Beacon 配置]
MSDK_DEBUG = 1
MSDK_DEBUG_CHANNEL = Beacon
[info]
{MSDK_DEBUG}1 表示打开调试模式，0 表示关闭调试模式
{MSDK_DEBUG_CHANNEL}此开关设置为 Beacon，表示开启 Beacon 调试，仅当{MSDK_DEBUG}为1时，此开关生效，在同一配置文件中 开启以上配置可以进行实时联调。实时联调功能只允许在测试环境下使用，项目上线必须关闭以上配置, 具体参考 5.2 实时联调指引
四、 iOS工程配置
4.1 MSDKConfig 配置文件
在工程中找到 MSDKAppSetting.bundle/MSDKConfig.ini 文件，增加如下配置
[灯塔 Beacon 配置]
BEACON_APP_KEY_IOS = {YOUR_BEACON_APP_KEY}
[info]
{YOUR_BEACON_APP_KEY}灯塔 App Key，需要换成业务需要的真实值，可以从灯塔管理端获取。如果业务已在灯塔官网注册应用并获得 App Key 参数，可直接使用官网生成的参数，无需在飞鹰进行额外配置。
4.2 系统库依赖
+ SystemConfiguration.framework
+ libz.dylib
+ libstdc++.dylib(或libc++.dylib)
+ libsqlite3.dylib
+ CoreTelephoney.framework
+ Security.framework
4.3 实时联调
在工程中找到 MSDKAppSetting.bundle/MSDKConfig.ini 文件，增加如下配置
[灯塔 Beacon 配置]
MSDK_DEBUG = 1
MSDK_DEBUG_CHANNEL = Beacon
[info]
{MSDK_DEBUG}1 表示打开调试模式，0 表示关闭调试模式
{MSDK_DEBUG_CHANNEL}此开关设置为 Beacon，表示开启 Beacon 调试，仅当{MSDK_DEBUG}为1时，此开关生效，在同一配置文件中 开启以上配置可以进行实时联调。实时联调功能只允许在测试环境下使用，项目上线必须关闭以上配置, 具体参考 5.2 实时联调指引;
五、常见问题
5.1 确认数据上报是否上报
1）日志查询
打开灯塔日志，在日志中搜索关键字 “beacon”，查看是否有相关逻辑处理。
2）管理端查询
[info] 该功能仅对腾讯内部开发
灯塔应用统计已迁移到新管理端 http://analytics.beacon.tencent.com/，详细查看方式咨询：灯塔小秘。
如果需要查询日志是否正常上报，可以通过实时联调确认，具体参考 5.2 实时联调指引
[info] 灯塔旧版本管理端 https://beacon.tencent.com/ 。
5.2 实时联调
实时联调功能的配置开启参考 iOS 和 Andorid 的配置项目， 该功能仅能用于联调测试，线上环境使用实时联调模式会严重影响性能并存在崩溃风险，产品上线前请务必关闭 实时联调模式
灯塔旧版的实时联调功能已经下线，新版的实时联调已经迁移到了 datahub
新版实时联调的使用方法
新版实时联调有什么优点
- 界面更友好，功能更丰富
- 与旧版实时联调不同，新版走的是正式环境，也就是说，实时联调2.0能看到数据，那就100%已经成功上报了。（当然，因为改了appKey，所以数据会入库到联调专用的appKey里）
使用指引
1、直接访问地址: http://datahub.tencent.com/common/view_debug
2、获取实时联调 Appkey
3、获取联调 AppKey ，联调的 key 可能会发生变化，尽量不要关闭这个页面
4、联调专用 AppKey ， 仅用于测试环境，正式环境必须替换回正式的 Appkey
- iOS
在工程中找到 MSDKAppSetting.bundle/MSDKConfig.ini 文件，增加如下配置
[灯塔 Beacon 配置]
BEACON_APP_KEY = {联调专用 AppKey}
MSDK_DEBUG = 1
MSDK_DEBUG_CHANNEL = Beacon
- Android
在工程文件 assets/MSDKConfig.ini 中添加配置
[灯塔 Beacon 配置]
BEACON_APP_KEY = {联调专用AppKey}
MSDK_DEBUG = 1
//5.11及之前的版本，实时联调时，必须删除 MSDK_DEBUG_CHANNEL 的 Beacon，但是此时会没有灯塔的客户端联调日志
MSDK_DEBUG_CHANNEL = {删除 Beacon}
//5.12及之后的版本
MSDK_DEBUG_CHANNEL = Beacon
5、获取手机的 QIMEI
更换 Appkey 后，重新出包后，安装游戏安装包到手机
iOS 查找日志如下：
2020-07-20 17:45:21.110401 MSDKDemo[1750:389421] [2020-07-20 17:45:21 110] | Debug | [MSDK] |0x1ad0abc40| MSDKReportBeacon.mm:53|-[MSDKReportBeacon initStat]_block_invoke| Beacon getQIMEI e8475612-7b80-4f50-ab36-e67c57a13bc7
Android 查找日志如下：
2020-03-04 12:30:15.053 31489-31546/com.tencent.beacon.beacondemo D/beacon_step_upload: (QimeiModule.java:202)updateQimei [qimei] update Qimei:2727da60efd8d334 imsi: aid:2727da60efd8d334 mac:42:12:f1:e9:32:f2 by server.
6、获取 QIMEI 后，并开始实施联调，查看实时查看的 App 上报记录
5.3 Qimei36 说明
Qimei36 上报功能，iOS 从 MSDK5.15/Android 从 MSDK5.16 版本开始支持。默认为空，需要业务联系灯塔开通权限，开通指引参考：https://iwiki.woa.com/pages/viewpage.action?pageId=417707553
- 对于 appKey，Android 端一般为 QQ 号，iOS 端为 i+QQ 号，可参考飞鹰系统---SDK 参数---灯塔 Key 字段或咨询 “灯塔小秘”。
- Qimei36 每隔 24 小时刷新一次。
All rights reserved.