Справочник по API PAL SDK Roku

    1. я
    2. ima.NonceLoader
    3. ima.NonceManager
    4. ima.NonceRequest

Класс има

Глобальные функции, управляющие Roku IMA для PAL.

Вернуться наверх

Класс ima.NonceLoader

Методы

Библиотека программного доступа позволяет издателям собирать сигналы, которые можно использовать для раскрытия спроса AdX. Для каждого запроса объявления при необходимости вызывайте соответствующие установщики, а затем вызывайте loadNonceManager. Затем издатели могут вызвать NonceManager.getNonce(), чтобы получить строку, которая должна быть добавлена ​​к запросам объявлений в качестве значения

createNonceLoader()


Возвращает ima.NonceLoader :

loadNonceManager(request)


Возвращает ima.NonceManager : менеджер nonce для генерации nonce для запроса объявления.

Параметр Тип Описание
request ima.NonceRequest

Запрос, содержащий информацию о запрашиваемом nonce.

Вернуться наверх

Класс ima.NonceManager

Методы

Управляет одноразовым номером и отчетами о его событиях для одного сеанса воспроизведения контента. Методы жизненного цикла сеанса воспроизведения контента, включая ima.NonceManager.sendAdClick , ima.NonceManager.sendAdTouch , ima.NonceManager.sendPlaybackStart и sendPlaybackEnd , должны вызываться при возникновении соответствующих событий, чтобы включить программную монетизацию.

getNonce()


Возвращает String : Nonce, сгенерированный для этого менеджера при его загрузке. Это значение никогда не изменится для данного экземпляра NonceManager. Это значение nonce действительно только для одного сеанса воспроизведения контента, максимальная продолжительность которого не превышает 6 часов.

poll()

Обновляет состояние менеджера, чтобы он мог отслеживать ход воспроизведения.

sendAdClick()

Уведомляет рекламные серверы Google о том, что во время данного сеанса воспроизведения контента произошел клик по объявлению.

sendAdImpression()

Устарело. Используйте ima.NonceManager.sendPlaybackStart и ima.NonceManager.sendPlaybackEnd/code>.

sendAdTouch(touch)

Уведомляет рекламные серверы Google о том, что пользователь коснулся или нажал на объявление, отличное от клика (например, пропустил, отключил звук, коснулся и т. д.), произошло во время данного сеанса воспроизведения контента.

Параметр Тип Описание
touch roInputEvent|String

Ключ, полученный от onKeyEvent (если используется SceneGraph), или от roInputEvent в противном случае.

sendPlaybackEnd()

Уведомляет рекламные серверы Google о завершении воспроизведения данного сеанса воспроизведения контента. Его следует вызывать, когда воспроизведение заканчивается (например, когда проигрыватель достигает конца потока, или когда пользователь завершает воспроизведение на полпути, или когда пользователь выходит из канала, или при переходе к следующему элементу контента в настройках списка воспроизведения). . Этот метод завершает асинхронные вызовы серверов Google, запущенные в sendPlaybackStart.

sendPlaybackStart()

Уведомляет рекламные серверы Google о начале воспроизведения данного сеанса воспроизведения контента. Это должно вызываться при «запуске видеоплеера». Это может быть ответом на действие, инициированное пользователем (воспроизведение по клику), или действие, инициированное каналом (автовоспроизведение). Этот метод запускает асинхронные вызовы серверов Google для сбора сигнала, необходимого для мониторинга и обнаружения IVT.

Вернуться наверх

Класс ima.NonceRequest

Поля

Методы

Информация, которую издатель может предоставить при запросе nonce PAL.

Характеристики

Имя Тип Описание
adWillAutoPlay

Установите значение true, если объявление будет воспроизводиться автоматически, не дожидаясь взаимодействия с пользователем. Установите значение false, если перед воспроизведением реклама будет ожидать взаимодействия с пользователем.

adWillPlayMuted

Установите значение true, если реклама будет воспроизводиться при отключенном звуке. Установите значение false, если реклама будет воспроизводиться без звука.

continuousPlayback

Установите значение true, если проигрыватель намерен непрерывно воспроизводить видеоконтент один за другим, как в телетрансляции или в списке воспроизведения видео. В противном случае установите значение false.

descriptionUrl

URL-адрес описания контента, во время которого будет воспроизводиться реклама. Любая строка URL-адреса описания длиной более 500 символов будет игнорироваться и исключаться из nonce.

directedForChildOrUnknownAge

Направлен ли запрос объявления на ребенка или пользователя неизвестного возраста (TFCD или TFUA). Значение по умолчанию — ложь.

iconsSupported

Поддерживаются ли видеоплеером значки VAST. На Roku это значение всегда должно быть ложным.

ppid

Издатель предоставил удостоверение личности. Любой PPID длиной более 200 символов будет игнорироваться. Примечание. PPID не будет использоваться при персонализации. Если для персонализации уместно использовать ppid, включите его отдельно в открытом тексте в свой запрос объявления.

sessionId

Идентификатор сеанса — это временный случайный идентификатор. Он используется исключительно для ограничения частоты показов. Идентификатор сеанса должен быть UUID.

storageAllowed

Было ли предоставлено пользователем согласие на хранение (согласие цели 1) из спецификации IAB TCF V2. По умолчанию истинно.

supportedApiFrameworks

Принимает массив строк, представляющих API-фреймворки, поддерживаемые проигрывателем, как определено в списке AdCOM 1.0 «API Frameworks» https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list- -api-frameworks-. Пример: ["2","7","9"] означает, что этот проигрыватель поддерживает VPAID 2.0, OMID 1.0 и SIMID 1.1.

videoHeight

Высота элемента рекламного видео.

videoWidth

Ширина рекламного видеоэлемента.

createNonceRequest()


Возвращает ima.NonceRequest :

Вернуться наверх