MobPush 集成指南
集成准备
注册账号
使用 PushSDK 之前,需要先在 MobTech 官网注册开发者账号,并获取 MobTech 提供的 AppKey 和 AppSecret,详情可以点击查看注册流程
MobPush 后台配置
注册 MobTech 账号后,需要在 MobTech 后台进行相关信息的配置,详情可以点击查看具体配置信息
MobPush 流程图
集成配置
MobPushSDK 提供了两种集成方式,您可根据需要进行选择。需要注意的是,两种集成方式在功能上无任何区别,仅为集成方式不同,选取其中一种即可。
Gradle 集成
配置 SDK 地址
Android Studio 的代码库配置方式随 Gradle 插件的不同版本有所不同。请根据您当前 Gradle 插件的版本,选择相应的配置方式。
【7.0 及以上版本】
打开项目级“settings.gradle”文件,配置 Maven 仓地址,注意修改
repositoriesMode
为RepositoriesMode.PREFER_SETTINGS
。
打开 Android Studio 项目级 build.gradle 文件,配置 MobSDK 插件地址
【7.0 以下版本】
打开 Android Studio 项目级 build.gradle 文件。
在 allprojects ->repositories 里面配置 maven 仓地址
在 buildscript->repositories 中配置 maven 仓地址。
在 buildscript->dependencies 中配置 AppGallery Connect 插件地址
添加依赖
打开应用级的 build.gradle 文件。
添加 mob 插件配置。请根据实际情况选择:方式一:在“com.android.application”
插件下一行添加如下配置
方式二:在“plugins”中添加如下配置
在文件末尾添加 mob 配置代码
配置标识
在 gradle.properties 中添加代码
Google Play 版本
如果您的应用需要上架 Google 商店,请务必使用 Google Play 版本。
在 gradle.properties 中添加代码,如已添加 MobSDK.spEdition
相关配置,则修改值为 GPP
即可
至此,Gradle 集成方式已经完成。
离线集成
获取 SDK
在进行离线集成之前,请先联系在线客服获取离线 SDK。
添加 SDK
把获取到的离线 SDK 包放入项目中的 libs 文件夹内。
引入 SDK
通过上一步添加 SDK 至项目中后,SDK 包还未进行引用,需要添加下方所示引入代码后才可使用。
配置清单文件
复制下方提供的清单文件代码至您的项目 AndroidManifest.xml 文件中。
至此,离线集成方式已经完成。
配置混淆代码
在项目中添加如下混淆代码
隐私授权启动业务
为保证您的 App 在集成 MobSDK 之后能够满足工信部相关合规要求,您应确保 App 安装首次冷启动且取得用户阅读您《隐私政策》授权之后,调用 MobSDK.submitPolicyGrantResult 回传隐私协议授权结果。
反之,如果用户不同意您 App《隐私政策》授权,则不能调用 MobSDK.submitPolicyGrantResult 回传隐私协议授权结果。 请参考MobPush隐私政策
通用方案
增加 App 数据采集主动控制器方案
示例代码
注:submitPolicyGrantResult 是 MobSDK 的业务起点。调用位置开发者可以自己指定,只需在使用 SDK 功能之前调用即可,强烈建议开发者在终端用户点击应用隐私协议弹窗同意按钮后调用。
App 数据采集主动控制器用来限制 MobSDK 采集并提供可选的数据维度和扩展功能。因相关信息的不收集将会对其对应的功能造成影响,请开发者结合业务实际需要进行合理配置。MobPush 扩展业务功能设置可参考: https://www.mob.com/wiki/detailed?wiki=534&id=136 ,其它 App 数据采集主动控制器的配置方法可参考:https://www.mob.com/wiki/detailed?wiki=664&id=714
日志调试
请在 AndroidManifest.xml 文件中 <application>
下添加上面配置,在日志控制台即可查看到 TAG 为 MobPushLog 的相关日志:
测试确认
确认通过 gradle 已拉取到资源包,包名为:"com.mob:MobSupportV1:xxxxxxxxx";"com.mob:MobCoreULT:xxxxxxxxx";"com.mob:MobGUIULT:xxxxxxxxx@aar";"com.mob:PushSDK:xxx@aar"
确认 AppKey 已经正确的写入 Androidmanifest.xml(可在 app-debug.apk 中的 Androidmanifest 查看确认)
确认测试手机已经调用隐私协议接口,并上传 true : MobSDK.submitPolicyGrantResult(true);
确认测试手机(或者模拟器)已成功连入网络 + 客户端调用,不要使用网络代理和 VPN,如果一切正常,启动项目后应有 MobPushLog 的日志信息,参考 tag 如下
功能进阶
Registration ID 使用说明
获取: 关于获取 Registration ID,请点击查看MobPushSDK API 使用
使用说明: 由于 MobPush 推送所有形式的推送最后都会转化为对 Registration ID 推送,因此 Registration ID 是推送和关联用户信息必备的标识。同时为了方便线上客户准确提供信息,减少沟通成本,我们建议您完成 SDK 集成后,将 Registration ID 进行存储和记录,排查问题时可将 Registration ID 和任务 ID 一起反馈,可加速排查进度
评论