12/12/2024 11:37:55
配置 MSDK 环境
一、概述
MSDKConfig.ini 包含了 MSDK 的环境配置，和各个渠道的应用信息配置。这些配置在 飞鹰系统 上申请应用的时候，就已一次性生成，填入这个 ini 文件即可。
在 Unity Editor 环境中，点击菜单 MSDK -> MSDKConfig.ini Settings，可以编辑配置信息，编辑后会自动同步到 Android 和 iOS 的文件中。
1）MSDKConfig.ini 文件在 Unity 工程中的位置
- Android 在 Assets/Plugins/Android/assets/ 目录下
- iOS 在 Assets/Plugins/iOS/GCloudSDK/MSDKCore/MSDKAppSetting.bundle/ 中
2）MSDKConfig.ini 文件在 UnrealEngine 工程中的位置
- Android在 Plugins/xxx/MSDKCore/Source/MSDKCore/lib/Android/assets 目录下
- iOS 在 Plugins/xxx/MSDKCore/Source/MSDKCore/lib/iOS/MSDKCore/MSDKCore.embeddedframework.zip/MSDKAppSetting.bundle 中
配置文件为 Key-Value 形式，使用 # 注释，使用 [] 表示不同模块。这些配置都可以通过 MSDK 后台控制下发。
- 一般配置项，拉取配置的顺序是： 云控 > MSDKConfig.ini
- 特别地，
MSDK_DEBUG配置项的拉取顺序是：云控 > MSDKConfig.ini
[info] 特别提醒
- bool 类型的 true 为 1， false 为 0；
- MSDK 相关的开关，都在前面加 MSDK_ 前缀；
- 渠道相关的字段没有要求；
二、配置环境
2.1 MSDK DEBUG 模式配置
MSDK_DEBUG 开关控制全局调试，将 MSDK_DEBUG 设置为0，则关闭所有插件的 DEBUG 模式
MSDK_DEBUG 与 MSDK_DEBUG_CHANNEL 配合使用。仅当打开 MSDK_DEBUG 开关后，通过配置 MSDK_DEBUG_CHANNEL 来控制渠道插件的调试信息，渠道间使用逗号隔开
1）配置示例
MSDK_DEBUG = 1
MSDK_DEBUG_CHANNEL = Beacon,Bugly,TDM,Adjust,AppsFlyer,XG,QQ
2）说明
当前 MSDK_DEBUG 开启，表示全局调试开启。MSDK_DEBUG_CHANNEL 设置对应渠道名，表示当前开启了这些渠道插件的调试功能。
MSDK_DEBUG 设置为 0 时，MSDK_DEBUG_CHANNEL 的配置失效。
[info] 特别提醒
正式上线前，建议关闭 DEBUG 模式，将 MSDK_DEBUG 设置为 0。
2.2 MSDK_DISABLE_LOG 模式配置
MSDK 从 5.30.001 版本开始，新增完全关闭 MSDK 日志配置，默认该字段为注释状态。
1）配置示例
MSDK_DISABLE_LOG = 1
2）说明
当 MSDK_DISABLE_LOG = 1 时完全不输出 MSDK 日志，对所有渠道生效，优先级大于 MSDK_DEBUG 配置字段
2.3 MSDK 环境配置
[info] 特别提醒
为了减少 MSDKConfig.ini 文件的配置项，删除了 SDK 中不常改动的配置，但会有默认值；游戏如果需要变更的话，可以直接添加到 MSDKConfig.ini 文件中。
| 字段 | 名词解析 | 备注 |
|---|---|---|
| MSDK_URL | MSDK 后台服务域名，根据 后台环境说明 进行填写 | 必填 |
| MSDK_GAME_ID | MSDK 用来标记游戏的唯一标识符，由 飞鹰系统 分配 | 必填 |
| MSDK_SDK_KEY | 与后台通讯的加密 key | 必填 |
| MSDK_POP_URL | MSDKPopup 通用弹窗后台服务域名 测试域名: pop-test.itop.qq.com 业务联调域名: pop-hktest.itop.qq.com 国内正式域名: pop-release.itop.qq.com 新加坡正式域名: pop-sg.itopsdk.com |
可选 |
| MSDK_DEBUG | 是否启用调试，全局开关，1- 打开，0 - 关闭 | 必填，上线建议关闭 |
| MSDK_DEBUG_CHANNEL | 第三方渠道调试，可选值：Beacon,Bugly,Bugly2,TDM,Adjust,AppsFlyer,XG,Twitter,Garena,Firebase,QQ | 配合 MSDK_DEBUG 使用，当 MSDK_DEBUG 值为 1 时，MSDK_DEBUG_CHANNEL 设置才生效 |
| MSDK_DISABLE_LOG | 完全关闭 MSDK 日志 | |
| MSDK_LIFECYCLE_OBSERVERS | 安卓生命周期监控渠道，多个渠道用逗号隔开，比如“QQ,WeChat” | Android 必填 |
| MSDK_HTTP_TIMEOUT | 后台请求超时时长，单位秒，默认为 15s | - |
| MSDK_HTTPDNS_ENABLE | 是否开启 DNS 解析，网络优化，默认为 1 打开 | - |
| MSDK_IPV6_ENABLE | IPV6 开关，默认 0 关闭 | - |
| MSDK_LOGIN_OVERTIME | 登录超时时长，单位秒，默认为 30s。 和 MSDK_HTTP_TIMEOUT 加起来的时间就是整个登录超时的时间 | - |
| MSDK_REFRESH_INTERVAL | 登录渠道 token 自动刷新的时间间隔，单位秒，默认半小时 60*30s | - |
| MSDK_LIFECYCLE_SCHEME | 是否启用第三方 app 拉起传递数据功能，默认 0 不启用 | 仅当接入第三方启动功能时，Android+iOS 需要配置启动协议和该配置项 |
| MSDK_KEYCHAIN_ENABLE | 是否开启 keychain ，是为了保障 Guest ID 找回，默认 1 开启 | 仅 iOS 可选配置 |
| MSDK_ENCRYPT_STORAGE | 文件加密开关，默认 0 关闭 | 为符合GDPR规范，此配置项用于开启或关闭文件加密。为保持现有线上业务场景，默认为关闭状态。只有新接入业务需要符合GDPR规范才需要开启此配置，现有接入业务不需要开启此配置。一旦配置开启且项目上线，则此配置无法再关闭。 |
| MSDK_DEVICE_INFO | 获取设备信息，默认 1 开启 | 为符合GDPR规范，此配置项用于开启或者关闭获取设备信息。为保持现有线上业务场景，默认为开启状态。此配置项一旦关闭，则 MSDKUtils::GetDeviceInfoWrapper() 方法不再返回设备信息。 |
| MSDK_V2_SIGN_ENABLE | V2 签名开关，默认 1 开启 | 仅 Android 可选配置。MSDK 对 V1、V2 签名都支持。飞鹰管理工具的渠道号打包，支持 Android V2 签名包写入读取逻辑，启用 V2 签名的包一定要打开这个开关（不开会导致使用飞鹰渠道打包工具时渠道号读取错误）。 备注：5.5.000 版本配置文件已删除 MSDK_V2_SIGN_ENABLE 字段，默认开启 V2 签名，如果使用 V1 签名，则需要手动配置这个字段并设为0。 |
| MSDK_LBS_GPS_TIMEOUT | LBS 功能 GPS 定位超时时长，单位毫秒，默认 4000ms 即 4s | Android 平台选填 |
| MSDK_AUTOLOGIN_NOT_PLUGIN_CHANNEL | 自动登录不调用插件配置项，不配置默认调用插件 | 当前仅 Google, Garena 渠道的自动登录会调用到插件，可配置渠道名到该选项不调用到插件，多个渠道以逗号隔开 |
| MSDK_MIGRA_GUEST_FROMV3_ENABLE | 是否开启V3的Guest的数据迁移，1:开启 0:不开启 ,默认是0 注意：确保MSDK_KEYCHAIN_ENABLE是开启的， | 当业务从MSDKV3版本升级到MSDKV5的版本，确保V3的游客登录在升级到V5之后，游客不丢失。 |
[info] V3游客迁移特别提醒
- 原有工程的QQ-AppId和微信的AppId参数不要更改
- 原有的iOS的XCode工程的 Keychain Sharing参数配置不要更改
2.4 Crash 上报配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| CRASH_REPORT_ENABLE | 是否上报 Crash，默认为 0 不开启上报功能 | - |
| CRASH_REPORT_CHANNEL | 需要进行初始化的统计渠道列表，逗号分隔 | - |
| CRASH_UPDATE_USER_ID | 用于控制是否在登录登出回调中调用 setUserId 更新 Bugly2、Bugly 或 Firebase 信息，默认 1 开启 | 可选，默认开启，如果有特殊调试需求，可以配置为 0 - 关闭 后单独使用 setUserId 接口设置用户 ID |
2.5 GameCenter 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| MSDK_GAMECENTER_KEEPLOGIN_ENABLE | GameCenter 渠道是否开启持续登录。默认 0 不开启 | 仅 iOS 平台可选配置，1: GameCenter 首次登录失败之后，每次后台切前台继续尝试登录。 0：后台切前台，不再询问 GameCenter 登录 |
2.6 WeChat 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| WECHAT_APP_ID | WeChat 渠道的 APP ID | - |
| WECHAT_AUTO_REFRESH_ENABLE | WeChat 渠道是否刷新 token，默认 1 刷新 | - |
2.7 QQ 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| QQ_APP_ID | QQ 渠道的 APP ID | - |
2.8 Facebook 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| FACEBOOK_DISPLAYNAME | 填写应用显示名称，类似：MSDK联合测试 | - |
| FACEBOOK_APP_ID | Facebook 渠道的 APP ID | - |
2.9 TDM 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| TDM_SRC_ID | 游戏做 TDM 上报时需传入的 src_id | - |
2.10 灯塔 Beacon 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| BEACON_APP_KEY_IOS | Beacon iOS 的 App Key | - |
| BEACON_APP_KEY_ANDROID | Beacon Android 的 App Key | - |
2.11 Adjust 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| ADJUST_OPEN_DEEPLINK_ENABLE | 是否开启 deeplink 功能，默认 0 不开启 | - |
| ADJUST_COPPA_COMPLIANT_ENABLE | 是否开启 CoppaCompliant 功能，默认 0 不开启 | 选填 |
| ADJUST_PLAYSTORE_KIDS_APP_ENABLE | 是否开启 PlayStoreKidsApp 功能，默认 0 不开启 | 选填，Android 独有 |
| ADJUST_APP_TOKEN_ANDROID | Android App token | - |
| ADJUST_INFO1_ANDROID | 可选的安卓客户端特性值 | 选填 |
| ADJUST_INFO2_ANDROID | 可选的安卓客户端特性值 | 选填 |
| ADJUST_INFO3_ANDROID | 可选的安卓客户端特性值 | 选填 |
| ADJUST_INFO4_ANDROID | 可选的安卓客户端特性值 | 选填 |
| ADJUST_APPSECRET_ANDROID | Android 应用秘钥开关，默认为空 | 要设置 Android 应用秘钥，该选项必须设置数值 |
| ADJUST_APP_TOKEN_IOS | iOS App token | - |
| ADJUST_INFO1_IOS | 可选的 iOS 客户端特性值 | 选填 |
| ADJUST_INFO2_IOS | 可选的 iOS 客户端特性值 | 选填 |
| ADJUST_INFO3_IOS | 可选的 iOS 客户端特性值 | 选填 |
| ADJUST_INFO4_IOS | 可选的 iOS 客户端特性值 | 选填 |
| ADJUST_APPSECRET_IOS | iOS 应用秘钥开关，默认为 -1 | 要设置 iOS 应用秘钥，该选项必须设置非 -1 数值 |
2.12 AppsFlyer 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| APPSFLYER_APP_ID_IOS | AppsFlyer 的 iOS APP ID | - |
| APPSFLYER_APP_KEY_IOS | AppsFlyer 的 iOS APP KEY | - |
| APPSFLYER_APP_KEY_ANDROID | AppsFlyer 的 Android APP KEY | - |
| FIREBASE_SENDER_ID | FireBase Sender ID | - |
2.13 XG（TPNS-腾讯云版）配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| XG_ACCESS_ID_IOS | XG 渠道的 Access ID，iOS 端使用 | - |
| XG_ACCESS_KEY_IOS | XG 渠道的 Access KEY，iOS 端使用 | - |
| XG_ACCESS_ID_ANDROID | XG 渠道的 Access ID，Android 端使用 | - |
| XG_ACCESS_KEY_ANDROID | XG 渠道的 Access KEY，Android 端使用 | - |
| XG_SHOW_FOREGROUND_ALERT | XG iOS 前台推送开关，默认关闭 | - |
| XG_OTHER_ENABLE | XG 是否支持其他厂商渠道，默认不支持 | - |
| XG_XIAOMI_ENABLE | XG 是否支持小米渠道，默认支持 | - |
| XG_XIAOMI_APP_ID | XG 小米渠道的 APP ID | - |
| XG_XIAOMI_APP_KEY | XG 小米渠道的 APP Key | - |
| XG_HUAWEI_ENABLE | XG 是否支持华为渠道，默认支持 | - |
| XG_FLYME_ENABLE | XG 是否支持魅族 Flyme 渠道，默认支持 | - |
| XG_FLYME_APP_ID | XG 魅族 Flyme 渠道的 APP ID | - |
| XG_FLYME_APP_KEY | XG 魅族 Flyeme 渠道的 APP Key | - |
| XG_HOST | XG 接入点域名 | - |
| XG_PORT | XG 接入点端口 | - |
| XG_FREE_ACCESS_ID_IOS | XG 免费版 access_id，配置后用于避免在【旧版信鸽】和【腾讯移动推送】两个平台上同时推送时，可能会出现重复消息的问题 | - |
2.14 Bugly 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| BUGLY_APP_ID_ANDROID | Bugly 渠道的 Android APP ID | - |
| BUGLY_APP_ID_IOS | Bugly 渠道的 iOS APP ID | - |
| BUGLY_UNEXPECTED_TERMINATE_DETECTION_ENABLE_IOS | 非正常退出事件记录开关，默认关闭，此配置只在 iOS 有 | 可选，默认关闭。开启时会捕获类似这样的异常SIGKILL，指的是非正常退出事件。"SIGKILL"一般不是用户或者开发者的问题，而是程序已经进入suspend状态、applicationDidEnterBackground已经回调的时候，由系统发出"SIGKILL"强制程序直接结束。比如用户双击home键自己杀掉。 |
| BUGLY_CLOSE_ERROR_CALLBACK_ANDROID | 屏蔽 error 类型的回调，默认关闭，此配置只在 Android 有 | 可选，默认关闭。开启时会屏蔽 error 类型的回调，其他类型的回调正常触发上报。5.10 及以上版本 |
2.15 WebView 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| WEBVIEW_SHARE_CHANNEL | JS 的分享渠道，支持QQ、WeChat、Facebook，当设置为 NONE 时，不显示分享按钮 | - |
| WEBVIEW_IS_FULLSCREEN | 是否全屏，默认关闭 | - |
| WEBVIEW_PORTRAIT_BAR_HIDEABLE | 当竖屏时，是否隐藏菜单栏，默认隐藏 | - |
| WEBVIEW_LANDSCAPE_BAR_HIDEABLE | 当横屏时，是否隐藏菜单栏，默认隐藏 | - |
| WEBVIEW_X5_CLOSE_ANDROID | WebView Android 是否关闭 x5 内核，默认 1 关闭 x5 内核 | - |
| WEBVIEW_X5_UPLOAD_ANDROID | WebView Android 在 x5 内核下可以上传文件，默认 1 可上传 | - |
| WEBVIEW_URL_KEY_FILTER | 自定义敏感字段过滤 | - |
2.16 Google 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| GOOGLE_APP_ID | Google 渠道的 APP ID | - |
| GOOGLE_CLIENT_KEY | Google 渠道的 client key | - |
| GOOGLE_EVERY_LOGIN_CHOICE_USER | 登录前是否执行插件登出，默认 0 不登出。 | 登录前插件登出，即每次登录都有一个用户选择界面 |
| MSDK_GOOGLE_LOGOUT_NEED_CONNECT | Google 非 connect 状态登出时，配置是否执行 connect 后再登出。默认 0 不执行 | - |
2.17 Twitter 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| TWITTER_KEY | Twitter 渠道的 key | - |
| TWITTER_SECRET | Twitter 渠道的 secret | - |
2.18 MSDK 自建账号配置
包含Email，SMS渠道。
| 字段 | 名词解析 | 备注 |
|---|---|---|
| MSDK_ACCOUNT_URL | 自建账号的后台环境 | 联调服: https://cotest.msdkpass.com 正式服: https://us.msdkpass.com |
| MSDK_ACCOUNT_SDK_KEY | 自建账号的 key | - |
| MSDK_ACCOUNT_APP_ID | 自建账号的 appid | - |
2.19 Garena 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| GARENA_APP_SDK_ASSIGN_ID | Garena 渠道的 assignId | Android 必填 |
| GARENA_APP_SDK_KEY | Garena 渠道的 appKey | 必填 |
| GARENA_LOGIN_TITLE | 对于 Garena Web 登录，用户可以设置自定义标题。默认为空 | Android 选填 |
2.20 LINE 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| LINE_CHANNEL_ID | Line 渠道的 channelID 配置 | 必填 |
| LINE_CHECK_SDK_VERSION_ENABLE | 是否校验 Android 设备运行的 SDK 版本, line sdk 至少需要系统版本 4.2 以上支持。默认 1 校验 | Android 选填 |
2.21 公告配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| NOTICE_INTERVAL_REQUEST | 时间间隔，单位秒。默认300s（5min） | 在时间间隔内使用相同参数调用获取公告接口，会直接返回上次客户端缓存的数据，不会去后台拉取 |
2.22 Bugly2 配置
| 字段 | 名词解析 | 备注 |
|---|---|---|
| BUGLY2_APP_ID_ANDROID | Bugly2 渠道的 Android APP ID | - |
| BUGLY2_APP_KEY_ANDROID | Bugly2 渠道的 Android APP KEY | - |
| BUGLY2_APP_ID_IOS | Bugly2 渠道的 iOS APP ID | - |
| BUGLY2_APPKEY_IOS | Bugly2 渠道的 iOS APP KEY | - |
Copyright © 2024 MSDK.
All rights reserved.
All rights reserved.