Как включить креативы VPAID 2 JavaScript

IMA HTML5 SDK поддерживает креативы VPAID 2 JavaScript. При включении поддержки следует учитывать два основных различия между спецификацией VPAID 2 и тем, как IMA SDK поддерживает VPAID 2. Эти различия не влияют на код реализации проигрывателя или SDK, но они важны для авторов креативов VPAID 2 JavaScript, поскольку креативы могут вызывать ошибки или работать не так, как ожидалось, при отрисовке с помощью IMA HTML5 SDK.

Требования

Чтобы следовать этому руководству, начните с приложения, в котором есть:

  • Видеопроигрыватель HTML5 с интегрированным IMA HTML5 SDK. Если у вас его нет, ознакомьтесь с информацией о том, как настроить IMA SDK.
  • URL тега объявления VAST, который указывает на креатив VPAID 2 JavaScript.

Полезные материалы

Включить поддержку VPAID 2

Чтобы включить поддержку VPAID 2 JavaScript, вызовите следующий метод перед инициализацией AdDisplayContainer:

google.ima.settings.setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.ENABLED);
...
var adDisplayContainer = new google.ima.AdDisplayContainer(adContainerElement);
var adsLoader = new google.ima.AdsLoader(adDisplayContainer);
...

Доступны следующие режимы VPAID:

  • ENABLED – разрешает объявления VPAID с настройками по умолчанию.
  • INSECURE – позволяет показывать объявления VPAID в небезопасном режиме. Подробнее о безопасности iframe и прокси-элементе видеопроигрывателя…
  • DISABLED – объявления VPAID не воспроизводятся. Если в ответ на запрос объявления возвращается креатив VPAID, возникает ошибка.

Дополнительную информацию о режимах VPAID можно найти в документации по API для ImaSdkSettings.VpaidMode.

Особенности поддержки VPAID 2

Безопасность iframe

По умолчанию IMA SDK использует защищенное окно iframe вместо совместимого окна iframe (в том же домене) или скрипта на странице для отрисовки креативов VPAID 2 JavaScript. Это означает, что если креатив пытается получить доступ к DOM родительской страницы, может возникнуть ошибка. Чтобы объявление показывалось в совместимом окне iframe, используйте ImaSdkSettings.setVpaidMode(...) следующим образом:

adsLoader.getSettings().setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.INSECURE);

Прокси-элемент видеопроигрывателя

В режиме ENABLED IMA HTML5 SDK не предоставляет фактический видеоэлемент для объявления, а вместо этого предоставляет прокси-элемент, который имитирует большую часть функций обычного видеоэлемента. Это делается для обеспечения безопасности и правильной работы на мобильных устройствах. Если рекламные креативы вызывают только поддерживаемые методы API, то их отрисовка не должна измениться. В режиме VpaidMode.INSECURE SDK предоставляет элемент видеопроигрывателя вместо прокси.

Ниже перечислены методы, прослушиватели и атрибуты, доступные для элемента прокси-видео.

Методы

  • addEventListener
  • canPlayType
  • load
  • play
  • pause
  • setattribute

Типы событий для addEventListener

  • abort
  • canplay
  • canplaythrough
  • click
  • durationchange
  • emptied
  • ended
  • error
  • loadeddata
  • loadedmetadata
  • loadstart
  • pause
  • play
  • playing
  • progress
  • ratechange
  • suspend
  • seeked
  • seeking
  • timeupdate
  • waiting

Атрибуты

  • currentTime
  • duration
  • ended
  • paused
  • playbackRate
  • src
  • type

Часто задаваемые вопросы

Поддерживаются ли креативы VPAID 2 JavaScript в iOS или Android SDK?
IMA HTML5 SDK – единственная платформа IMA SDK, поддерживающая креативы VPAID 2 JavaScript.
Включит ли это креативы VPAID в IMA HTML5 SDK?
Да, IMA HTML5 SDK поддерживает креативы VPAID 2 JavaScript.