Базовая интеграция (ExoPlayer AdsLoader API)

YandexAdsLoader — упрощенный API для интеграции InStream-рекламы через Media3 и ExoPlayer. YandexAdsLoader поддерживает воспроизведение рекламных вставок с типом Pre-roll, Mid-roll, Post-roll.

Этот тип интеграции подходит для приложений, которым не нужны расширенные возможности InStream API.

Подключение с использованием Gradle

В файл build.gradle добавьте следующие зависимости на уровне приложения:

dependencies {
          ...
          implementation 'com.yandex.android:mobileads:7.8.0'
          implementation 'androidx.media3:media3-exoplayer:1.4.1'
          implementation 'androidx.media3:media3-ui:1.4.1'
}
dependencies {
          ...
          implementation 'com.yandex.android:mobileads:7.8.0'
          implementation 'com.google.android.exoplayer:exoplayer-core:2.18.1'
}

Показ рекламных объявлений

  1. Добавьте в layout приложения PlayerView:

    <FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
    
        <androidx.media3.ui.PlayerView
            android:id="@+id/player_view"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_gravity="center" />
    
    </FrameLayout>
    
    <FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
    
        <com.google.android.exoplayer2.ui.PlayerView
            android:id="@+id/player_view"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:layout_gravity="center" />
    
    </FrameLayout>
    
  2. Создайте конфигурацию запроса instreamAdRequestConfiguration с помощью класса InstreamAdRequestConfiguration.Builder. В качестве параметров запроса передайте идентификатор рекламного блока (AD_UNIT_ID) из Партнерского интерфейса.

    val configuration = InstreamAdRequestConfiguration
                .Builder(AD_UNIT_ID)
                .build()
    
    InstreamAdRequestConfiguration configuration = new InstreamAdRequestConfiguration
                .Builder(AD_UNIT_ID)
                .build();
    
  3. Создайте экземпляр класса YandexAdsLoader в onCreate() методе цикла Activity для показа и загрузки InStream-рекламы.

    Примечание

    Для использования YandexAdsLoader с Media3 стоит импортировать его из пакета com.yandex.mobile.ads.instream.media3, для использования с ExoPlayer2 — из пакета com.yandex.mobile.ads.instream.exoplayer.

    yandexAdsLoader = YandexAdsLoader(context, configuration)
    
    yandexAdsLoader = new YandexAdsLoader(context, configuration);
    
  4. Добавьте функцию для создания ExoPlayer, в которой создайте экземпляр класса DefaultMediaSourceFactory, установив в него созданный экземпляр YandexAdsLoader и PlayerView.

    private fun createPlayer(): Player {
        val mediaSourceFactory = DefaultMediaSourceFactory(context)
            .setLocalAdInsertionComponents({ yandexAdsLoader }, playerView)
    
        val player = ExoPlayer.Builder(context)
            .setMediaSourceFactory(mediaSourceFactory)
            .build()
    
        return player
    }
    
    private YandexAdsLoader yandexAdsLoader;
    
    ...
    
    private class YandexAdsLoaderProvider implements AdsLoader.Provider {
        @Nullable
        @Override
        public AdsLoader getAdsLoader(@NonNull MediaItem.AdsConfiguration adsConfiguration) {
            return yandexAdsLoader;
        }
    }
    
    private Player createPlayer() {
        AdsLoader.Provider yandexAdsLoaderProvider = new YandexAdsLoaderProvider();
        DefaultMediaSourceFactory mediaSourceFactory = new DefaultMediaSourceFactory(context)
                .setLocalAdInsertionComponents(yandexAdsLoaderProvider, playerView);
    
        Player player = new ExoPlayer.Builder(context)
                .setMediaSourceFactory(mediaSourceFactory)
                .build();
    
        return player;
    }
    
  5. Добавьте функцию для создания MediaItem.

    private fun getMediaItem(): MediaItem {
        val contentVideoUrl = CONTENT_URL
        val adTagUri = Uri.parse(YandexAdsLoader.AD_TAG_URI)
        val mediaItem = MediaItem.Builder()
            .setUri(contentVideoUrl)
            .setAdsConfiguration(MediaItem.AdsConfiguration.Builder(adTagUri).build())
            .build()
        return mediaItem
    }
    
    private MediaItem getMediaItem() {
        String contentVideoUrl = CONTENT_URL;
        Uri adTagUri = Uri.parse(YandexAdsLoader.AD_TAG_URI);
        MediaItem mediaItem = new MediaItem.Builder()
                .setUri(contentVideoUrl)
                .setAdsConfiguration(new MediaItem.AdsConfiguration.Builder(adTagUri).build())
                .build();
        return mediaItem;
    }
    
  6. Добавьте функцию для инициализации ExoPlayer и восстановления состояния.

    private var rememberedPlayerPosition = 0L
    private var rememberedPlayWhenReady = false
    private var player: Player? = null
    
    ...
    
    private fun initPlayer() {
        val mediaItem = getMediaItem()
        player = createPlayer().also {
            playerView.player = it
            yandexAdsLoader.setPlayer(it)
            it.setMediaItem(mediaItem)
            it.playWhenReady = rememberedPlayWhenReady
            it.seekTo(rememberedPlayerPosition)
            it.prepare()
        }
    }
    
    private Long rememberedPlayerPosition = 0L;
    private Boolean rememberedPlayWhenReady = false;
    private Player player = null;
    
    ...
    
    private void initPlayer() {
        MediaItem mediaItem = getMediaItem();
        Player player = createPlayer();
        playerView.setPlayer(player);
        yandexAdsLoader.setPlayer(player);
        player.setMediaItem(mediaItem);
        player.setPlayWhenReady(rememberedPlayWhenReady);
        player.seekTo(rememberedPlayerPosition);
        player.prepare();
        this.player = player;
    }
    
  7. Добавьте функцию для вызова метода release() и сохранения состояния ExoPlayer.

    private var rememberedPlayerPosition = 0L
    private var rememberedPlayWhenReady = false
    private var player: Player? = null
    
    ...
    
    private fun releasePlayer() {
        yandexAdsLoader.setPlayer(null)
        playerView.player = null
        player?.also {
            rememberedPlayerPosition = it.contentPosition
            rememberedPlayWhenReady = it.playWhenReady
            it.release()
        }
        player = null
    }
    
    private Long rememberedPlayerPosition = 0L;
    private Boolean rememberedPlayWhenReady = false;
    private Player player = null;
    
    ...
    
    private void releasePlayer() {
        yandexAdsLoader.setPlayer(null);
        playerView.setPlayer(null);
        Player player = this.player;
        if (player != null) {
            rememberedPlayerPosition = player.getContentPosition();
            rememberedPlayWhenReady = player.getPlayWhenReady();
           player.release();
        }
        this.player = null;
    }
    
  8. Перепишите методы onStart(), onResume(), onPause() и onStop(), используя созданные функции. Для API версии 23 и ниже вызывайте созданные функции в onPause() и onResume(), в более новых версиях API — в методах onStop() и onStart().

    override fun onStart() {
        super.onStart()
        if (Build.VERSION.SDK_INT > 23) {
            initPlayer()
            playerView.onResume()
        }
    }
    
    override fun onStop() {
        super.onStop()
        if (Build.VERSION.SDK_INT > 23) {
            playerView.onPause()
            releasePlayer()
        }
    }
    
    override fun onResume() {
        super.onResume()
        if (Build.VERSION.SDK_INT <= 23) {
            initPlayer()
            playerView.onResume()
        }
    }
    
    override fun onPause() {
        super.onPause()
        if (Build.VERSION.SDK_INT <= 23) {
            playerView.onPause()
            releasePlayer()
        }
    }
    
    @Override
    protected void onStart() {
        super.onStart();
        if (Build.VERSION.SDK_INT > 23) {
            initPlayer();
            playerView.onResume();
        }
    }
    
    @Override
    protected void onStop() {
        super.onStop();
        if (Build.VERSION.SDK_INT > 23) {
            playerView.onPause();
            releasePlayer();
        }
    }
    
    @Override
    protected void onResume() {
        super.onResume();
        if (Build.VERSION.SDK_INT <= 23) {
            initPlayer();
            playerView.onResume();
        }
    }
    
    @Override
    protected void onPause() {
        super.onPause();
        if (Build.VERSION.SDK_INT <= 23) {
            playerView.onPause();
            releasePlayer();
        }
    }
    
  9. Вызовите метод release() у YandexAdsLoader, когда он больше не нужен.

    override fun onDestroy() {
        releasePlayer()
        yandexAdsLoader.release()
        super.onDestroy()
    }
    
    @Override
    protected void onDestroy() {
        releasePlayer();
        yandexAdsLoader.release();
        super.onDestroy();
    }