MobPush Android For Unity

集成准备

注册账号使用MobSDK之前,需要先在MobTech官网注册开发者账号,并获取MobTech提供的AppKey和AppSecret,详情可以点击查看注册流程

下载MobPush对应的.unitypackage包

打开 Github 下载 MobPush-For-Unity 项目,下载完成后直接双击或者在Unity里面选择打开 MobPush.unitypackage,导入相关资源和脚本到您的 Unity项目即可使用。

集成
注:MobPush For Unity项目对应的Android插件部分,使用的是gradle编译方式,由于gradle编译方式在Unity2017及以上版本才能很好地支持并且兼容,强烈建议广大开发者使用Unity2017及以上的版本进行开发,Unity2017以下版本集成稍微麻烦一丢丢;
所以集成核心部分分成:
(1)新版Unity集成方式(Unity2017及以上的版本)
(2)旧版Unity集成方式注意事项(使用Unity2017版本以下开发的必看)

Unity集成方式(建议)
MobPush Android For Unity_第1张图片
关键文件:mainTemplate.gradle和proguard-user.txt
1、Unity2017及以上版本,在Build Settings > Player Settings下面,有两个开关,新建项目的话打开这两个开关就可以在Plugins>Android生成对应的两个文件;由于这两个文件MobPush都有直接提供,只需导入.unitypackage就好,Unity检测到已经存在这两个文件,自动会更新为勾选状态;
2、Build的时候有一个Build System选项,此选项默认选择的Internal,切记要改成选择里面的gradle选项(重要
3、图中所示的mainTemplate.gradle文件,即为集成的核心文件,使用编辑器打开此文件,要点内容如下:
此处为区分Unity5.6和Unity2017 gradle插件版本的地方,开发时用到哪个版本就使用哪个,若使用到其他Unity版本,请随意选择一个,然后build,编译的时候会报错的,Console控制台信息报错时会提示插件版本是多少,根据提示修改成需要的版本就好(只修改后面的数字,比如:2.3.0或者2.1.0)

buildscript {
    repositories {
          // 配置Mob Maven库
        maven {
           url "https://mvn.mob.com/android"
        }
      // 配置HMS Core SDK的Maven仓地址。(集成华为厂商需要添加)
        maven {
           url 'https://developer.huawei.com/repo/'}
        }
        ...
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'//Unity2017
        //classpath 'com.android.tools.build:gradle:2.1.0'//Unity5.6
        // 注册MobSDK
        classpath "com.mob.sdk:MobSDK:2018.0319.1724"
    }
}

此处为集成MobPush需要配置的信息

// 添加插件
apply plugin: 'com.mob.sdk'

// 在MobSDK的扩展中注册MobPush的相关信息
MobSDK {
appKey "替换为MobTech官方申请的appkey"
appSecret "替换为MobTech官方申请的appkey对应的appSecret"

MobPush {
    //集成其他推送通道(可选)
    devInfo {
        //华为推送配置信息
        HUAWEI{
            appId "华为的appid"
        }

        //魅族推送配置信息
        MEIZU{
            appId "魅族的appid"
            appKey "魅族的appkey"
        }

        //小米推送配置信息
        XIAOMI{
            appId "小米的appid"
            appKey "小米的appkey"
        }
        //FCM推送通道配置 
        FCM{ 
            //设置默认推送通知显示图标 
            iconRes "@mipmap/ic_launcher" 
        }
    }
}

此处为配置签名文件和签名文件的别名和密码(正式发布apk需要的签名文件),可以写绝对路径,也可以写相对路径,相对路径使用”…\”跳出一层目录,跳出多层则连续拼接

signingConfigs {
        release {
            keyAlias 'demokey.keystore'
            keyPassword '123456'
            storeFile file('F:\\Unitydemo(CJY)\\MobPushForUnity\\Assets\\Plugins\\Android\\demokey.keystore')
            storePassword '123456'
        }
}

此处为混淆文件的配置,也就是MobPush提供的proguard-user.txt文件,此文件内容不需要更改,按照提供的即可, 如自己代码需要额外增加混淆逻辑,可自行增加混淆规则,如果是Unity2017以下版本,请把注释的代码调换一下即可; (minifyEnabled属性为是否开启代码混淆:true为开启混淆,false为关闭)

buildTypes {
        release {
            minifyEnabled true// 是否混淆
            //shrinkResources false// 是否去除无效的资源文件
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-user.txt' //Unity2017及以上
            //proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-unity.txt'  //Unity2017以下
            signingConfig signingConfigs.release
        }

        debug {
            minifyEnabled false
            signingConfig signingConfigs.release
        }
}

4、挂载MobPush.cs脚本到需要使用的场景上,此时便可以调用推送的各个接口;

旧版Unity集成方式注意事项
1、由于Unity2017以下的版本在setting下面并不支持直接生成mainTemplate.gradle和proguard-user.txt,但是可以读取到mainTemplate.gradle文件,所以mainTemplate.gradle文件可以直接使用MobPush提供的;
2、然后混淆文件需要去Unity的安装目录下面的Editor\Data\PlaybackEngines\AndroidPlayer\Tools (Windows)路径下面,找到UnityProGuardTemplate.txt文件,这个文件就是Unity在编译gardle的时候自动替换的混淆文件;
3、把MobPush提供的proguard-user.txt文件里面的内容复制到UnityProGuardTemplate.txt文件里面,就可以了
注:
UnityProGuardTemplate.txt是在每个用到gradle编译的Unity项目都会去寻找的混淆文件,谨慎修改注意:集成FCM除了在MobSDK.gradle中配置之外,还需要如下操作:(如果不集成FCM的配置可以跳过此步骤)
1、到官网去下载json,如下所示:https://firebase.google.com/docs/cloud-messaging/?hl=zh-cn
MobPush Android For Unity_第2张图片
2、登录进入后,跳转到如下截图:
MobPush Android For Unity_第3张图片
https://github.com/MobClub/MobPush-For-Unity
MobPush Android For Unity_第4张图片
下载后,包里面如下图所示,有一个exe的工具,将下载的json放到app文件夹下,点击exe工具生成,会发现生成了一个res文件夹;
MobPush Android For Unity_第5张图片
3、将生成的res文件夹放到自己的项目中去,如demo中所示:
MobPush Android For Unity_第6张图片

设置隐私授权回调

为保证您的App在集成MobSDK之后能够满足工信部相关合规要求,您应确保App安装首次冷启动且取得用户阅读您《隐私政策》授权之后,调用Mob提交到的隐私协议回传函数uploadPrivacyPermissionStatus回传隐私协议授权结果。 反之,如果用户不同意您App《隐私政策》授权,则不能调用uploadPrivacyPermissionStatus回传隐私协议授权结果。 详情参考:合规指南

//隐私授权接口调用
mobPush.updatePrivacyPermissionStatus(true);

推送接口

初始化和绑定监听 public MobPush mobPush;

void Start ()
    {
        mobPush = gameObject.GetComponent();//初始化MobPush
        mobPush.onNotifyCallback = OnNitifyHandler;//消息回调监听
        mobPush.onTagsCallback = OnTagsHandler;//标签处理回调监听
        mobPush.onAliasCallback = OnAliasHandler;//别名处理回调监听
        mobPush.onDemoReqCallback = OnDemoReqHandler;//demo请求接口回调(为了方便测试,提供在客户端发送通知的接口,仅供测试时使用)
        mobPush.onRegIdCallback = OnRegIdHandler;//获取注册ID异步监听回调接口
    }
        void OnNitifyHandler (int action, Hashtable resulte)
    {
        Debug.Log ("OnNitifyHandler");
        if (action == ResponseState.CoutomMessage)
        {
            Debug.Log ("CoutomMessage:" + MiniJSON.jsonEncode(resulte));
        }
        else if (action == ResponseState.MessageRecvice)
        {
            Debug.Log ("MessageRecvice:" + MiniJSON.jsonEncode(resulte));
        }
        else if (action == ResponseState.MessageOpened) 
        {
            Debug.Log ("MessageOpened:" + MiniJSON.jsonEncode(resulte));
        }
    }

    void OnTagsHandler (int action, string[] tags, int operation, int errorCode)
    {

        Debug.Log ("OnTagsHandler  action:" + action + " tags:" + String.Join (",", tags) + " operation:" + operation + "errorCode:" + errorCode);
    }

    void OnAliasHandler (int action, string alias, int operation, int errorCode)
    {
        Debug.Log ("OnAliasHandler action:" + action + " alias:" + alias + " operation:" + operation + "errorCode:" + errorCode);
    }

    void OnRegIdHandler (string regId)
    {
        Debug.Log ("OnRegIdHandler-regId:" + regId);
    }

    void OnDemoReqHandler (bool isSuccess)
    {
        Debug.Log ("OnDemoReqHandler:" + isSuccess);
    }

其它各种接口说明: 发送本地通知,自定义本地通知样式

LocalNotifyStyle style = new 

LocalNotifyStyle ();
style.setContent ("Text");
style.setTitle ("title");

#if UNITY_ANDROID
    Hashtable extras = new Hashtable ();
    extras["key1"] = "value1";
    extras["key2"] = "value1";
    style.setExtras (extras);
#endif
mobPush.setMobPushLocalNotification (style);

自定义通知栏样式

CustomNotifyStyle style = new CustomNotifyStyle ();

        #if UNITY_IPHONE

            style.setType(CustomNotifyStyle.AuthorizationType.Badge | CustomNotifyStyle.AuthorizationType.Sound | CustomNotifyStyle.AuthorizationType.Alert);

        #elif UNITY_ANDROID

            style.setContent ("Content");
            style.setTitle ("Title");
            style.setTickerText ("TickerText");

        #endif

            mobPush.setCustomNotification(style);

获取注册ID (getRegistrationId)
mobPush.getRegistrationId();

添加标签 (addTags)

String[] tags = { "tags1", "tags2", "tags3" };
mobPush.addTags(tags);

获取标签 (getTags)
mobPush.getTags();

删除标签 (deleteTags)

String[] tags = { "tags1", "tags2", "tags3" };
mobPush.deleteTags(tags);

清除全部标签 (cleanAllTags )
mobPush.cleanAllTags();

添加别名 (addAlias)
mobPush.addAlias("alias");

获取别名 (getAlias)
mobPush.getAlias();

清除全部别名 (cleanAllAlias)
mobPush.cleanAllAlias();
停止通知服务 (stopPush)
mobPush.stopPush();

重启通知服务 (restartPush)
mobPush.restartPush();

判断通知是否被停止,返回值:bool类型(isPushStopped)
mobPush.isPushStopped();

点击通知后是否打开应用首页,默认为打开

mobPush.setClickNotificationToLaunchPage(false);

**添加混淆配置

为了防止二次混淆MobPush,需要在项目混淆文件中添加:
`-keep class com.mob.{*;}

-dontwarn com.mob.**`

如果同时集成了华为、小米、魅族等渠道推送,同时也需要在项目中添加防二次混淆配置:

-keep class com.huawei.**{*;}

-keep class com.meizu.**{*;}

-keep class com.xiaomi.**{*;}

-keep class android.os.SystemProperties

你可能感兴趣的:(android,unity)