Подключение и инициализация AppMetrica Push SDK

Перед подключением библиотеки AppMetrica Push SDK, подготовьте ваше приложение:

1. Подключите основную библиотеку AppMetrica SDK не ниже версии 3.0.0.
2. Настройте приложение для отправки push-уведомлений.

Начиная с версии 1.4.0 в Push SDK добавлена библиотека OKHttp. Она используется для кэширования изображений, которые показываются в push-уведомлениях. Правила кэширования берутся из HTTP-заголовка cache-control. Если вы не хотите, чтобы изображения кэшировались, подключите библиотеку без кэширования.

Инициализируйте библиотеку в приложении — объявите производный класс от базового класса Application и переопределите метод onCreate() следующим образом:

Только Firebase

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(getApplicationContext());
    }
}
Скопировано

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(applicationContext)
    }
}
Скопировано

Только HMS

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(getApplicationContext(), new HmsPushServiceControllerProvider(this));
    }
}
Скопировано

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(applicationContext, HmsPushServiceControllerProvider(this))
    }
}
Скопировано

Firebase и HMS

• Java
• Kotlin

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        YandexMetricaPush.init(
            getApplicationContext(), 
            new FirebasePushServiceControllerProvider(this),
            new HmsPushServiceControllerProvider(this)
        );
    }
}
Скопировано

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YandexMetricaPush.init(
            applicationContext,
            FirebasePushServiceControllerProvider(this),
            HmsPushServiceControllerProvider(this)
        )
    }
}
Скопировано

Настройте обработку push-уведомлений, которые не предполагают вывод сообщений (Silent Push Notifications).

1. Создайте специальный 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);
           ...
       }
   }
   Скопировано

2. Внесите изменения в элемент application файла AndroidManifest.xml:

   <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>
   Скопировано

   applicationId — уникальный идентификатор приложения в Gradle (имя пакета). Например, com.example.name.

Сервис FCM может отозвать push-токен устройства, например, если пользователь долго не запускал приложение. AppMetrica хранит push-токены на сервере и не может отправить push-уведомление на устройство с устаревшим токеном.

Чтобы автоматически собирать актуальные push-токены, перейдите в настройки приложения в веб-интерфейсе AppMetrica и выберите опцию Актуализировать токены с помощью Silent Push-уведомлений во вкладке Push-уведомления.

При необходимости вы можете передавать вместе с push-уведомлением дополнительную информацию. Эти данные указываются в веб-интерфейсе AppMetrica при настройке push-кампании.

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);
        ...
    }
}
Скопировано

Чтобы отличить запуски приложения по открытию push-уведомления AppMetrica Push SDK от общего числа запусков, необходимо проверить Intent action приложения. Если в качестве действия вы указали deeplink, он будет являться Intent action. Если в качестве действия выбрано открытие приложения, Intent action будет передавать значение YandexMetricaPush#OPEN_DEFAULT_ACTIVITY_ACTION.

Чтобы указать иконку push-уведомления по умолчанию, внесите изменения в элемент application файла AndroidManifest.xml:

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

ICON_RESOURCE — ресурс иконки. Например, @drawable/large_icon.