Android 快速接入

最后更新时间:2021-06-22 10:44:12

    简介

    本文档提供移动推送 TPNS Android 应用快速接入指引。只需按照如下步骤,即可在您的 Android 应用上面使用移动推送 TPNS 服务。

    接入前准备

    创建 Android 平台应用

    1. 接入 SDK 之前,需要您前往移动推送 TPNS 控制台 创建产品和 Android 应用,详情请参见 创建产品和应用 文档。
    2. 完成以上步骤后,进入应用的【配置管理】页面,准备接入。

    步骤1:开始接入

    1. 在【配置管理】页面中, 单击【快速接入】。
    2. 按照接入指引的操作顺序完成配置,然后单击【点击验证】。
    3. 若出现以下提示,则表示 SDK 接入成功 。

      若出现以下提示,请确认 App 是否成功注册推送服务,可参见 接入结果验证
    注意:

    为提升离线抵达率,TPNS SDK 默认开启联合保活能力,开发者可手动关闭,详情请参见 关闭 TPNS 保活功能

    步骤2:接入结果验证

    1. 运行 App,过滤“TPush”关键字,查看相关日志:

      如出现有类似上图日志,则表明 TPNS-SDK 的插件集成方式已经成功。
    2. 推送服务注册成功的日志如下:
      XG register push success with token:6ed8af8d7b18049d9fed116a9db9c71ab4aabb65
      

    若未搜索到 Token,请查看注册接口返回的错误码,根据 错误码对照表 排查。

    步骤3:厂商通道快速接入

    1. 在配置管理页面打开厂商推送通道开关并配置好应用的 AppId、SecretKey 等信息,申请方式可查看各厂商通道的说明文档。
      • 单击【查看说明文档】,可查看厂商通道说明。
      • 在右侧 AppId、AppKey、AppSecret 处可配置厂商通道信息。
    2. 厂商通道信息配置完成后,单击页面上方【配置文件下载】,下载包含厂商通道配置信息的配置文件,然后用该配置文件替换工程文件中旧的配置文件即可。

    问题排查指引

    1. 查看插件日志。
      如果集成出现异常,则将 tpns-configs.json 文件中的 “debug” 字段置为 true,运行命令:
      ./gradlew --rerun-tasks :app:processReleaseManifest 
      
      并通过“TpnsPlugin”关键字进行分析。
    2. sync projects。
    3. 在项目的 External Libraries 中查看是否有相关依赖。
    4. 如果日志显示 Execution failed for task ':Paracraft:checkTPNS',说明检查到有新版本的 TPNS Android SDK 可以升级。如果不希望检查更新,可以在 tpns-configs.json 文件中添加 "upgrade": false,效果如下图:
    5. 使用插件过程中,遇到 Android Gradle 插件版本跟 Gradle 版本不匹配的问题,可以参考 Android Gradle 插件版本说明 进行版本升级,下图列出了当前各个 Android Gradle 插件版本所需的 Gradle 版本: