Quick Integration with Android

Discontinuing Push Notification Service TPNS

Announcements

Features

SDK for Android

SDK for iOS

SDK for macOS

Release Notes

Overview

Strengths

Use Cases

Global Deployment

Product Introduction

Billing Overview

Purchase Directions

Billing Modes

Free Trial

Payment Overdue

Purchase Guide

Creating Products and Applications

Quick Integration with iOS

Creating a Push Task

Querying Push Records

Guidelines for Push Testing Methods

Product Restrictions

Getting Started

Troubleshooting Tool

Conversion Funnel

Push Plan

Push Settings

Message Recall

Push Management

Multi-Package Name Push

Notification Tap-to-Redirect

Custom Push Speed

Channel Policies

Message Collapse

Rich Media Notification

Custom Notification

Push to Accounts

Advanced Push Features

Operation Guide 

iOS Badge Feature Practice

Practical Tutorial

API Overview

Signature Authentication (Recommended)

Basic Auth Authentication

Request Structure

Call Method

Push API

Creating a Push Plan

Account Package Upload API

Token Package Upload API

Push APIs

Tag Binding and Unbinding

Deleting All Devices Under Tag

Tag APIs

Account Binding and Unbinding

Account and Device Binding Query

Account APIs

Querying Daily Aggregated Push Statistics

Querying Device Statistics

Querying All Push Information in Specific Period

Querying Push Information for One Task

Querying Push Statistics for a Single Task

Querying Aggregated Statistics for Multiple Tasks

Querying All Push Tasks on the Day by Token

Statistics APIs

User Attribute APIs

Server-Side Error Codes

Server SDKs

API (Java)

API Documentation

SDK Integration

Vendor Channel Integration Guide

Vendor Channels

Android SDK FAQs

Compatibility with Android P

Error Codes

Android Integration Guide

Acquisition of Push Certificate

Push Environment Selection Description

Extension Feature

iOS SDK FAQs

iOS Integration Guide

Client Integration Plugin

Push Certificate Description

macOS Integration Guide

SDK Documentation

Quick Configuration

Advanced Custom Configuration

Resource Tag

Users and Permissions

Service Level Agreement

Service Agreement

Android

Flutter

Others

FAQs

Privacy Policy

Data Processing and Security Agreement

Developer Agreement

Tencent Push Notification Service Policy

Contact Us

Glossary

Tencent Push Notification Service

This document describes how to quickly integrate the Tencent Push Notification Service SDK into your Android application. You can use the Tencent Push Notification Service on your application after performing the following steps.

 To avoid your app from being criticized in a circulated notice or removed from the market by regulatory authorities, be sure to add mobile push related instructions in the Privacy Policy according to the Android Compliance Guide before integrating the Tencent Push Notification Service SDK and initialize the SDK after the user agrees to the Privacy Policy. 

Before integrating the SDK, you need to log in to the 

Tencent Push Notification Service console

https://console.tencentcloud.com/tpns

 and create the product and Android application. For detailed directions, please see 

https://www.tencentcloud.com/document/product/1024/32603

 page of the application to prepare for the integration.


Complete the configuration as instructed and click 

If the following prompt is displayed, the Tencent Push Notification Service SDK is successfully integrated.
 


 If verification failure information as shown in the figure below is reported, check whether the application has been successfully registered with the Tencent Push Notification Service as instructed in 

#jierujieguo

To increase the offline reach rate, the Tencent Push Notification Service SDK enables the session keep-alive feature by default. To disable the feature, see 

https://www.tencentcloud.com/document/product/1024/32624#how-do-i-disable-the-keep-alive-feature-of-tpns.3F

Run the application, filter logs by the "TPush" keyword, and view the displayed logs.



If a log similar to that shown in the preceding figure is displayed, the Tencent Push Notification Service SDK has been successfully integrated as a plugin.

Check whether the registration with the push service is successful. The following log indicates successful registration.

XG register push success with token:6ed8af8d7b18049d9fed116a9db9c71ab4aabb65

If the token cannot be found, please check the error code returned by the registration API and troubleshoot as instructed in 

https://www.tencentcloud.com/document/product/1024/30722

Quickly Integrating with a Vendor Channel

 page, enable the vendor push channel and configure the application information such as 

. For more information about how to apply for such information, see the documentation of the vendor channel.

After configuring the vendor channel information, click 

 at the top of the page to download the vendor channel configuration file and use it to replace the legacy one in the project file.
 

View the Android Gradle plugin logs.
 If an exception occurs during integration, set the 

./gradlew --rerun-tasks :app:processReleaseManifest 

Check whether relevant dependencies exist in 

Execution failed for task ':Paracraft:checkTPNS'

, the Tencent Push Notification Service Android SDK can be updated to a later version. If you do not want to check for updates, add 

If you encounter the version mismatch between the Android Gradle plugin and Gradle version when using the plugin, upgrade the Gradle version by referring to 

https://developer.android.google.cn/studio/releases/gradle-plugin

. The table in following figure lists which version of Gradle is required for each version of the Android Gradle plugin.


tencent cloud