Как настроить IMA SDK для динамической вставки объявлений

Выберите платформу: HTML5 Android iOS tvOS Cast Roku

IMA SDK позволяет легко интегрировать мультимедийные объявления на сайты и в приложения. IMA SDK могут запрашивать объявления у любого совместимого с VAST сервера объявлений и управлять воспроизведением рекламы в ваших приложениях. При использовании IMA DAI SDK приложения отправляют запрос на показ рекламы и видеоконтента (видео по запросу или прямых трансляций). Затем SDK возвращает объединенный видеопоток, чтобы вам не приходилось переключаться между видеообъявлением и контентом в приложении.

Выберите решение для динамической вставки объявлений

Показ пакетов с динамической вставкой объявлений

С помощью IMA SDK можно легко интегрировать мультимедийные объявления в сайты и приложения. IMA SDK могут запрашивать объявления у любого совместимого с VAST сервера объявлений и управлять воспроизведением рекламы в ваших приложениях. При использовании IMA DAI SDK приложения отправляют запрос на показ рекламы и видеоконтента (видео по запросу или прямых трансляций). Затем SDK возвращает объединенный видеопоток, чтобы вам не приходилось переключаться между видеообъявлением и контентом в приложении.

В этом руководстве рассказывается, как воспроизводить поток с динамической вставкой пакетов объявлений с помощью IMA DAI SDK и видеопроигрывателя для трансляций и видео по запросу. Чтобы посмотреть или повторить готовую интеграцию, скачайте пример пакета.

Общие сведения о показе пакетов с динамической вставкой объявлений в IMA DAI

  • StreamRequest – объект, который определяет запрос потока к рекламным серверам Google. Чтобы включить показ пакетов, манифест должен быть создан с помощью ImaSdkFactory.createPodStreamRequest() или ImaSdkFactory.createPodVodStreamRequest(). Для этих методов требуется код сети, а для createPodStreamRequest также нужен ключ пользовательского объекта и необязательный ключ API. Оба варианта включают другие необязательные параметры.

  • StreamManager – объект, который обрабатывает связь между видеопотоком и IMA DAI SDK, например отправляет пинги отслеживания и пересылает события потока издателю.

Требования

  • Приложение для Android, в котором уже настроен IMA DAI SDK для воспроизведения видеопотоков с объявлениями, размещенными с помощью динамической вставки. Если у вас нет такого приложения, рекомендуем использовать в качестве отправной точки Android DAI BasicExample. В BasicExample есть база кода, на которую ссылается это руководство.

  • Чтобы IMA DAI работал, ваше приложение должно отправлять события ID3 с помощью VideoStreamPlayerCallback.onUserTextReceived(). Ознакомьтесь с примером фрагмента кода для DAI с полным набором функций.

Как настроить переменные для показа пакетов

Все изменения, необходимые для показа пакетов, вносятся в файл SampleAdsWrapper.java. Первым делом нужно обновить постоянные переменные.

Ниже перечислены константы запроса потока пакета объявлений, которые необходимо добавить.

  • STREAM_URL: Используется только для прямых трансляций. URL видеопотока, предоставленный манипулятором манифеста или внешним партнером, который использует пакетную передачу. Вам нужно будет вставить идентификатор трансляции, предоставленный IMA DAI SDK, прежде чем отправлять запрос. В этом случае URL трансляции содержит плейсхолдер "[[STREAMID]]", который перед отправкой запроса заменяется идентификатором трансляции.

  • NETWORK_CODE – код сети вашего аккаунта Менеджера рекламы 360.

  • CUSTOM_ASSET_KEY: используется только для трансляций – специальный ключ объекта, который идентифицирует ваше событие показа блоков в Менеджере рекламы 360. Его может создать ваш инструмент управления манифестом или сторонний партнер по показу пакетов.

  • API_KEY: используется только для трансляций – необязательный ключ API, который может потребоваться для получения идентификатора трансляции из IMA DAI SDK.

Приложение Android DAI BasicExample предназначено для воспроизведения различных типов потоков, но для показа пакетов оно настроено на воспроизведение только одного потока. Измените раздел переменных в примере, чтобы он соответствовал следующему:

/** This class implements IMA to add pod ad-serving support to SampleVideoPlayer */
@SuppressLint("UnsafeOptInUsageError")
/* @SuppressLint is needed for new media3 APIs. */
public class SampleAdsWrapper
    implements AdEvent.AdEventListener, AdErrorEvent.AdErrorListener, AdsLoader.AdsLoadedListener {

  // Set up the pod serving variables.
  private static final String NETWORK_CODE = "";
  private static final String CUSTOM_ASSET_KEY = "";
  private static final String API_KEY = "";
  private static final String STREAM_URL = "";
  private static final StreamFormat STREAM_FORMAT = StreamFormat.HLS;

Как создать запрос на поток пакета объявлений для трансляции или видео по запросу, чтобы включить показ пакетов объявлений

Показ пакетов в трансляциях

Удален метод buildStreamRequest(), который использовался для переключения между разными типами потоков. Затем измените requestAndPlayAds() на ImaSdkFactory.createPodStreamRequest(), чтобы создать запрос на показ рекламы в Live Pod Serving.

// Live pod stream request.
request = sdkFactory.createPodStreamRequest(NETWORK_CODE, CUSTOM_ASSET_KEY, API_KEY);

Показ пакетов в видео по запросу

Удалите метод buildStreamRequest(), который использовался для переключения между созданием потоков разных типов. Затем измените requestAndPlayAds() на ImaSdkFactory.createPodVodStreamRequest(), чтобы создать запрос объявления для показа в пакете видео по запросу.

// VOD pod stream request.
request = sdkFactory.createPodVodStreamRequest(NETWORK_CODE);

После создания экземпляра запроса потока запросите поток с помощью AdsLoader.requestStream():

request.setFormat(STREAM_FORMAT);
adsLoader.requestStream(request);

Как изменить и настроить URL стрима

Показ пакетов в трансляциях

Вызовите метод StreamManager.getStreamId(), чтобы получить идентификатор потока. Его нужно вставить в STEAM_URL вместо "[[STREAMID]]". После этого измените URL трансляции с помощью метода videoPlayer.setStreamUrl() и вызовите метод videoPlayer.play(), чтобы начать воспроизведение трансляции.

// Play the live pod stream.
streamID = streamManager.getStreamId();
String liveStreamUrl = STREAM_URL.replace("[[STREAMID]]", streamID);
// Call videoPlayer.play() here, because IMA doesn't call the VideoStreamPlayer.loadUrl()
// function for livestreams.
videoPlayer.setStreamUrl(liveStreamUrl);
videoPlayer.play();

Показ пакетов в видеопотоке по запросу

  1. Вызовите метод StreamManager.getStreamId(), чтобы получить идентификатор потока.
  2. Запросите URL потока у своего партнера по видеотехнологиям.
  3. Получив URL от поставщика видеоконтента, вызовите метод StreamManager.loadThirdPartyStream() с этим URL, чтобы загрузить трансляцию, а также любые субтитры, которые вернул поставщик.
// Play the VOD pod stream.
streamID = streamManager.getStreamId();
String vodStreamUrl = "";
// Refer to your Video Tech Partner (VTP) or video stitching guide to fetch the stream URL
// and the subtitles for a the ad stitched VOD stream.

// In the following commented out code, 'vtpInterface' is a place holder
// for your own video technology partner (VTP) API calls.
// vodStreamUrl = vtpInterface.requestStreamURL(streamID);
List<Map<String, String>> subtitles = new ArrayList<>();
streamManager.loadThirdPartyStream(vodStreamUrl, subtitles);

При запросах на показ пакетов объявлений в видео по запросу IMA вызывает функцию обратного вызова VideoStreamPlayer.loadUrl() после загрузки потока. Чтобы начать воспроизведение трансляции, добавьте вызовы videoPlayer.setStreamUrl() и videoPlayer.play() в обратный вызов VideoStreamPlayer.loadUrl():

private VideoStreamPlayer createVideoStreamPlayer() {
  return new VideoStreamPlayer() {
    @Override
    public void loadUrl(String url, List<HashMap<String, String>> subtitles) {
      // IMA doesn't make calls to VideoStreamPlayer.loadUrl() for pod serving live streams.
      // The following code is for VOD streams.
      videoPlayer.setStreamUrl(url);
      videoPlayer.play();
    }

Как удалить объекты IMA DAI

После того как вы успешно запросите и покажете объявления в потоке с показом пакетов объявлений с помощью IMA DAI SDK, мы рекомендуем очистить все ресурсы после завершения сеанса показа пакетов объявлений. Вызовите StreamManager.destroy(), чтобы остановить воспроизведение потока, прекратить отслеживание рекламы и освободить все загруженные объекты потока.

Другие примеры использования Android SDK можно найти на GitHub.