Connecting the AppMetrica Push SDK

Before integrating the AppMetrica Push SDK library, prepare your app:

1. Integrate the AppMetrica SDK library at least version 3.0.0.
2. Configure your app for sending push notifications.

Since version 1.4.0 to the Push SDK added the OKHttp library. The SDK uses it for caching images that are displayed in push notifications. Caching rules are taken from the cache-control HTTP header. If you do not want the images to be cached, connect the library without caching.

Initialize the library in the app — extend the Application class and override the onCreate() method as follows:

Firebase only

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(getApplicationContext());
    }
}
Copied to clipboard

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(applicationContext)
    }
}
Copied to clipboard

HMS only

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(getApplicationContext(), new HmsPushServiceControllerProvider(this));
    }
}
Copied to clipboard

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(applicationContext, HmsPushServiceControllerProvider(this))
    }
}
Copied to clipboard

Firebase and HMS

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(
            getApplicationContext(), 
            new FirebasePushServiceControllerProvider(this),
            new HmsPushServiceControllerProvider(this)
        );
    }
}
Copied to clipboard

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(
            applicationContext,
            FirebasePushServiceControllerProvider(this),
            HmsPushServiceControllerProvider(this)
        )
    }
}
Copied to clipboard

Configure processing silent push notifications.

1. Create a special BroadcastReceiver:

   import com.yandex.metrica.push.YandexMetricaPush;
   public class SilentPushReceiver extends BroadcastReceiver {
       @Override
       public void onReceive(Context context, Intent intent) {
           // Extract push message payload from your push message.
           String payload = intent.getStringExtra(YandexMetricaPush.EXTRA_PAYLOAD);
           ...
       }
   }
   Copied to clipboard

2. Make changes in the application element in the AndroidManifest.xml file:

   <manifest xmlns:android="http://schemas.android.com/apk/res/android">
     <application>
     ...
       <receiver android:name=".SilentPushReceiver">
         <intent-filter>
           <!-- Receive silent push notifications. -->
           <action android:name="${applicationId}.action.ymp.SILENT_PUSH_RECEIVE"/>
         </intent-filter>
       </receiver>
     ...
     </application>
   </manifest>
   Copied to clipboard

   applicationId — Unique app ID in Gradle (package name). For example, com.example.name.

The FCM service can withdraw the push token of the device, for example, if the user did not launch the application for a long time. AppMetrica stores push tokens on the server and can not send a push notification to a device with an obsolete token.

To automatically collect current push token go to the application settings in the AppMetrica interface and enable the Update tokens with a Silent Push notification option in the Push Notifications tab.

You can send additional information with the push notification if necessary. This data is specified in the AppMetrica web interface when configuring the push campaign.

public class TargetActivity extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(saveInstanceState);
        handlePayload(getIntent());
    }

    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);
        handlePayload(intent);
    }

    private void handlePayload(Intent intent) {
        // Handle your payload.
        String payload = intent.getStringExtra(YandexMetricaPush.EXTRA_PAYLOAD);
        ...
    }
}
Copied to clipboard

To distinguish app launches initiated by opening an AppMetrica push notification from the total number of app starts, you should check the Intent action of the app. If you specified a deeplink as the action, this will be the Intent action. If the action is set as opening the app, the Intent action passes the value YandexMetricaPush#OPEN_DEFAULT_ACTIVITY_ACTION.

To set the default push notification icon, make changes in the application element in the AndroidManifest.xml file:

<meta-data android:name="com.yandex.metrica.push.default_notification_icon"
           android:resource="ICON_RESOURCE"/>

ICON_RESOURCE — Icon resource. For example, @drawable/large_icon.