文档中心 登录/注册 SDK下载 个推学堂

当前位置：个推文档 > 客户端 > Android多厂商 > 厂商SDK集成指南

厂商 SDK 集成指南

厂商 SDK 集成指南

前言

  • 本文档介绍 Android Studio 开发环境下厂商推送 SDK 的 Maven 集成步骤

  • 集成厂商 SDK 前，必须先 集成个推 SDK

  • 辅助推送：个推推送针对厂商设备管控较严的情况特意接入厂商推送作为辅助通道以提高在厂商设备上的到达率。个推推送优先选择个推通道进行消息下发，只有在个推通道断连时选择辅助通道下发消息。厂商推送在下发纯透传消息时并不保证会拉起被杀死进程，所以辅助通道在进程被杀死情况下无法保证透传消息一定到达。

  • 本文默认您已经完成了个推推送 SDK 的集成以及掌握了基本的 Android 基础知识

  • 本文假设您的工程项目结构为

    Getui_SDK_Demo_AS_manufacture/
  |- app/ （项目主模块）
  |    |- libs/ （第三方库）
  |    |- src/ （代码目录）
  |    |- build.gradle （模块级 gradle 文件）
  |- gradle/
  |- build.gradle （顶层 gradle 文件）
  |- settings.gradle
  | ......

1. 添加辅助 SDK 及相关配置

1.1 添加 Maven 库地址

在以项目名为命名的顶层 build.gradle 文件的 allprojects.repositories 中，添加个推 maven 库地址 https://mvn.getui.com/nexus/content/repositories/releases/ 如下所示：

allprojects {
    repositories {
        mavenCentral()
        //添加 Maven URL 地址
        maven {
            url "https://mvn.getui.com/nexus/content/repositories/releases/"
        }
    }
}

1.2 配置相关依赖

在 app/build.gradle 文件中的 dependencies 块中引用厂商 SDK 依赖库 ，当前为最新版本，历史版本详见 厂商更新日志。其中ups为个推与手机厂商合作通道，目前支持坚果，索尼，海信手机。如下所示：

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    // 根据所需厂商选择集成
    implementation 'com.getui.opt:hwp:3.1.1'   // 华为
    implementation 'com.getui.opt:xmp:3.3.1'   // 小米
    implementation 'com.assist-v3:oppo:3.3.0'  // oppo
    implementation 'com.assist-v3:vivo:3.1.1'  // vivo
    implementation 'com.getui.opt:mzp:3.2.3'   // 魅族
    implementation 'com.getui.opt:ups:3.0.3'   // ups，ups目前支持坚果，索尼，海信手机
    implementation 'com.getui.opt:honor:3.3.0' // 荣耀
}

1.3 配置应用参数

在 app/build.gradle 文件中的 android.defaultConfig 下添加 manifestPlaceholders，配置厂商相关的应用参数，如下 manifestPlaceholders 中的内容所示，ups无需配置对应的厂商ID，个推已经默认作出处理：

android {
    defaultConfig {
        manifestPlaceholders = [
                // 华为 相关应用参数
                HUAWEI_APP_ID  : "",

                // 小米相关应用参数
                XIAOMI_APP_ID  : "",
                XIAOMI_APP_KEY : "",

                // OPPO 相关应用参数   
                OPPO_APP_KEY   : "",
                OPPO_APP_SECRET: "",

                // VIVO 相关应用参数   
                VIVO_APP_ID    : "",
                VIVO_APP_KEY   : "",

                // 魅族相关应用参数  
                MEIZU_APP_ID   : "",
                MEIZU_APP_KEY  : "",

                // 荣耀相关应用参数
                HONOR_APP_ID   : "",
        ]
    }
}

2. 华为配置

集成华为通道还需以下步骤。若无需集成华为厂商推送，可直接跳过此节

1. 添加应用的 AppGallery Connect 配置文件

  1. 登录 AppGallery Connect，选择“我的项目”，找到应用所在的产品，点击应用名称。
  2. 选择“项目设置 > 常规”，在“应用”栏下的“agconnect-services.json”下载配置文件。

  3. 将 agconnect-services.json 文件拷贝到应用级根目录下。如下：

    Getui_SDK_Demo_AS_manufacture/
  |- app/ （项目主模块）
  |  ......
  |    |- agconnect-services.json 
  |- gradle/
  |- build.gradle （顶层 gradle 文件）
  |- settings.gradle
  | ......

    华为离线推送验证需要客户端使用签名包，否则会校验失败

2. 配置相应依赖

  1. 在以项目名为命名的顶层 build.gradle 文件的 buildscript.repositories 和 allprojects.repositories 中，添加 HMS SDK 的 maven 地址。在 buildscript.dependencies 添加 classpath 'com.huawei.agconnect:agcp:${version}' 如下所示：

    buildscript {
    repositories {
        mavenCentral()
        google()
        maven {url 'https://developer.huawei.com/repo/'}
    }
    dependencies {
        ......
        classpath 'com.huawei.agconnect:agcp:1.6.0.300'
    }
}

allprojects {
    repositories {
        ......
        maven {url 'https://developer.huawei.com/repo/'}
    }
}

  2. 在模块级别 app/build.gradle 中文件头配置 apply plugin: 'com.huawei.agconnect' 以及在 dependencies 块配置 HMS Push 依赖 implementation 'com.huawei.hms:push:${version}'，如下：

    apply plugin: 'com.android.application'
apply plugin: 'com.huawei.agconnect'
android { 
    ......
}
dependencies { 
    ......
    implementation 'com.huawei.hms:push:6.11.0.300'
}

  3. 配置签名信息：将应用签名文件拷贝到工程 app 目录下，在 app/build.gradle 文件中配置签名。如下（具体请根据您当前项目的配置修改）：

    signingConfigs {
     config {
         keyAlias 'pushdemo'
         keyPassword '123456789'
         storeFile file('pushdemo.jks')
         storePassword '123456789'
     }
 }
 buildTypes {
     debug {
         signingConfig signingConfigs.config
     }
     release {
         signingConfig signingConfigs.config
         minifyEnabled false
         proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
     }
 }

3. 荣耀配置

集成荣耀通道还需以下步骤。若无需集成荣耀厂商推送，可直接跳过此节

3.1. 开发环境：

  1. 环境信息
    JDK 1.8及以上版本
    Android Studio 3.X及以上版本

    minSdkVersion 19及以上
targetSdkVersion 29（推荐）
compileSdkVersion 30（推荐）
Gradle 4.6及以上（推荐）
  2. 支持的设备类型
    国内Magic UI4.0及以上
    海外Magic UI4.2及以上

3.2. 配置签名信息：将应用签名文件拷贝到工程 app 目录下，在 app/build.gradle 文件中配置签名。如下（具体请根据您当前项目的配置修改）：

android {
    signingConfigs {
         config {
             keyAlias 'pushdemo'
             keyPassword '123456789'
             storeFile file('pushdemo.jks')
             storePassword '123456789'
         }
     }
     buildTypes {
         debug {
             signingConfig signingConfigs.config
         }
         release {
             signingConfig signingConfigs.config
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }
     }
     ...
}

repositories {
    maven {
         url 'https://developer.hihonor.com/repo/' 
    }
}

4. OPPO配置

集成OPPO厂商SDK：3.1.0及以上版本还需以下步骤。若无需集成OPPO厂商或者版本低于3.1.0版本，可直接跳过此节

1. 项目同时需要引入以下库

  1. 在模块级别 app/build.gradle 的 dependencies 配置中务必添加以下依赖，如下：

    dependencies { 
    ......
    //以下依赖都需要添加
    implementation 'com.google.code.gson:gson:2.6.2'
    implementation 'commons-codec:commons-codec:1.6'
    implementation 'com.android.support:support-annotations:28.0.0'
}

5. 集成验证

初始化个推 SDK，打开 logcat 查看信息，Verbose 级日志，tag 过滤内容“Assist_”，Filter 选择“No Filters”。

成功打印 token 信息则表示集成成功：
config_succ

6. 通知开关开启

6.1 检测用户设备是否开启通知权限，示例代码如下：

boolean notificationsEnabled = PushManager.getInstance().areNotificationsEnabled(context);

返回true，表示用户设备正常开启通知权限，推送通知在设备上可以正常到达、展示；
返回false，表示用户设备未开启通知权限，通知权限被关闭后，重要服务通知均无法正常触达用户，进而影响日活、留存和转化数据。

6.2 通知关闭引导开通功能，示例代码如下：

PushManager.getInstance().openNotification(context);

调用上述方法，将跳转到系统开启通知功能页面，引导用户开启通知权限

7. 打开应用自定义页面

鉴于各厂商SDK打开应用自定义页面有多种方式，且有些方式互不兼容，为了保持统一并且方便开发者，个推提供一种标准且唯一的打开应用自定义页面方式，通过服务端API指定intent参数，同时此方式兼容旧版本SDK，可以正常打开自定义页面，不会影响未更新用户使用。
注意：原有intent方式，请慎重使用，即："intent:#Intent;component=com.getui.demo/com.getui.demo.DemoActivity;S.key1=value1;end"；
使用原有intent格式，将会影响vivo、荣耀等渠道的通知展示、点击，后续其他厂商会逐步禁止原有intent方法。建议服务端和客户端尽快修改至当前文档要求的符合scheme协议格式。例如当vivo厂商sdk版本从 com.assist-v3:vivo:3.0.5 开始 ，使用老版本格式intent (在部分 vivo 机型, 比如 android 11 ) 可能出现无法打开应用内自定义界面

跨应用启动Activity必须使用显式intent方式，通过intent可以携带额外的数据给客户端应用。主要通过如下几步来完成:

7.1 生成Intent参数：

    //在Android 开发工具中，参考如下代码生成 Intent
    Intent intent = new Intent(this, DemoActivity.class);
    //Scheme协议（gtpushscheme://com.getui.push/detail?）开发者可以自定义
    intent.setData(Uri.parse("gtpushscheme://com.getui.push/detail?"));

    //如果设置了 package，则表示目标应用必须是 package 所对应的应用
    intent.setPackage(getPackageName());
    //intent 中添加自定义键值对，value 为 String 型
    intent.putExtra("payload", "payloadStr");
    //gttask 不用赋值，添加 gttask 字段后，个推给客户端的 intent 里会自动拼接上 taskid 和 actionid ；app 端接收到参数以后，可通过下方 6.3 的 pushClick 方法解析及上报埋点。
    intent.putExtra("gttask", "");

    // 应用必须带上该Flag，如果不添加该选项有可能会显示重复的消息，强烈推荐使用Intent.FLAG_ACTIVITY_CLEAR_TOP
    intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
    String intentUri = intent.toUri(Intent.URI_INTENT_SCHEME);

    //得到intent url 值
    //示例：intent://com.getui.push/detail?#Intent;scheme=gtpushscheme;launchFlags=0x4000000;package=com.getui.demo;component=com.getui.demo/com.getui.demo.DemoActivity;S.payload=payloadStr;S.gttask=;end

    // 打印出的intentUri值就是设置到推送消息中intent字段的值
    Log.d("intentUri", intentUri);

注意：
1、com.getui.demo是您的包名即applicationId，com.getui.demo.DemoActivity是您要打开的 activity 全路径

2、S 大写是 string 类型，s小写是short类型，B 大写是 boolean 类型，b 小写是 byte 类型，其它均小写即可；

3、如果您手动拼装intent，如有特殊字符：比如 Scheme 链接含有#符号，建议 encode 编码处理，参数在经过Android 系统接收后，会自动进行解码处理（经测试，intent 参数里面有 % 符号，客户端接收参数会乱码；intent 参数里面有 # 和 ; 符号，会影响跳转，encode 编码处理后正常）；


4、如果遇到点击第二条通知，页面不能正常跳转的情况，建议设置 launchFlags为0x04000000 测试，这个一般是 activity 启动模式的问题，参数会在 activity 的 onCreate 或 onNewIntent 方法回调。

7.2 在AndroidManifest.xml文件注册被启动的Activity：

比如被启动的自定义页面 DemoActivity，其中host、path、scheme 一定要与上面的 Intent 生成参数匹配。
注意：该属性必须设置android:exported="true"；activity 名称用户自己定义.

<activity android:name=".DemoActivity"
    android:exported="true">
        <intent-filter>
            <action android:name="android.intent.action.VIEW"/>
            <category android:name="android.intent.category.DEFAULT" />
            <category android:name="android.intent.category.BROWSABLE" />
                <data
                    <!-- 下面内容由您自定义 -->
                    android:host="com.getui.push"
                    android:path="/detail"
                    android:scheme="gtpushscheme" />
        </intent-filter>
</activity>

7.3 在上一步中您自定义Activity中接收数据：

// 此处DemoActivity是您需要打开的应用内的页面Activity
public class DemoActivity extends Activity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_demo);
        //获取自定义透传参数值
        Intent intent = getIntent();
        if (null != intent) {
            String payload = intent.getStringExtra("payload");
            Log.d("DemoActivity", "payload = " + payload);
        }

        //上报华为、oppo、vivo离线点击数据
        pushClick(intent);
    }

    //或者在onNewIntent中接收（某些特殊情况下，例如：DemoActivity的启动模式是singleTop、singleTask或者是singleInstance，并且DemoActivity是打开的情况下）
    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);
        //获取自定义透传参数值
        if (null != intent) {
            String payload = intent.getStringExtra("payload");
            Log.d("DemoActivity", "payload = " + payload);
        }
    }

    /**
     * 由于华为、oppo 无点击数报表返回，vivo无单推点击数报表返回，所以需要您在客户端埋点上报。
     * 点击厂商通知以后，在触发的activity的onCreate()方法里面接收相关参数，上报这 3 个离线厂商消息的点击数据。
     * 开发者可直接使用此方法示例
     *
     * @param intent
     * @return
     */
    public boolean pushClick(Intent intent) {
        boolean result = false;
        try {
            String taskid = intent.getStringExtra("gttask");
            String gtaction = intent.getStringExtra("gtaction");
            String clientid = PushManager.getInstance().getClientid(context);
            String uuid = UUID.randomUUID().toString().replaceAll("-", "");
            // 这里的messageid需要自定义， 保证每条消息汇报的都不相同
            String contentToDigest = taskid + clientid + uuid;
            byte[] md5s = MessageDigest.getInstance("MD5").digest(contentToDigest.getBytes(StandardCharsets.UTF_8));
            String messageid = new BigInteger(1, md5s).toString(16);

            /***
             * 第三方回执调用接口，可根据业务场景执行
             * 注意：只能用下面回执对应的机型进行上报点击测试，其它机型获取不到 gttask 字段
             *
             * 60020 华为点击
             * 60030 oppo点击
             * 60040 vivo点击
             * 60070 荣耀点击
             *
             * 埋点接口对应填写获取到的actionid值，如果有获取到 actionid 值，就上报埋点，如 果没有则不用上报。
             *
             */
            if (gtaction != null) {
                int actionid = Integer.parseInt(gtaction);
                result = PushManager.getInstance().sendFeedbackMessage(context, taskid, messageid, actionid);
            }
        } catch (Exception e) {
            //…………
        }
        return result;
    }
}

8. 厂商消息分类申请

为了改善终端用户的通知体验，营造良好可持续的推送生态，部分手机厂商推送对各个APP的push消息数量进行了限量管控。
作为开发者，也不希望用户全局屏蔽这个应用的所有通知，但又不知道该如何实现消息分类。小米、OPPO和vivo厂商提供了渠道申请，开发者仅需根据自身应用的通知场景，将消息通过对应的Channel发送，即可为用户提供简单清晰的通知类别，便于用户自行选择权限；也有助于解决厂商消息限量、到达率等问题。

8.1 小米消息分类申请：

官方文档：https://dev.mi.com/console/doc/detail?pId=2422

8.2 OPPO消息分类申请：

官方文档：https://open.oppomobile.com/wiki/doc#id=11252

8.3 vivo消息分类申请：

官方文档：https://dev.vivo.com.cn/documentCenter/doc/578#w1-25260340
​

在这篇文章中： 前言 1. 添加辅助 SDK 及相关配置 2. 华为配置 3. 荣耀配置 4. OPPO配置 5. 集成验证 6. 通知开关开启 7. 打开应用自定义页面 8. 厂商消息分类申请
开发者中心 SDK 下载

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询