IMA DAI SDK для Roku, IMA DAI SDK для Roku

    1. я
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Классное изображение

Методы

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

disableLogging()

Отключает ведение журнала SDK. По умолчанию ведение журнала будет включено.

getStreamManager()

Возвращает менеджер потоков, если он доступен. Если менеджер потоков еще недоступен, возвращается Invalid. Если при создании диспетчера потоков произошла ошибка, возвращается объект ошибки.

Возвращаемый object : диспетчер потока или объект ошибки.

initSdk(settings)

Инициализирует SDK.

Параметр Тип Описание
settings object

Необязательный объект настроек IMA.

requestStream(streamRequest)

Запускает запрос асинхронного потока. Управление немедленно возвращается проигрывателю после вызова этого метода.

Возвращает object : ошибка или недействительный, если ошибки нет.

Параметр Тип Описание
streamRequest object

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

Класс ima.AdBreakInfo

Поля

Методы

Содержит информацию о рекламной паузе. Передается в обратные вызовы событий SDK.

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

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

Индекс объявления в рекламной паузе. Будет 1 для отдельных объявлений.

duration

Максимальная продолжительность перерыва в секундах или -1, если неизвестна.

podIndex

Для прямых трансляций всегда возвращается -1. Для видео по запросу (VOD) возвращает индекс рекламного модуля. Для пакета в начале ролика возвращается 0. Для пакета в середине ролика возвращается 1, 2, ..., n. Для модуля построллинга возвращает n+1...n+x. По умолчанию установлено значение 0, если это объявление не является частью модуля или этот модуль не является частью плейлиста.

timeOffset

Положение модуля в контенте в секундах. Преролл возвращает 0, постролл возвращает -1, а середина ролика возвращает запланированное время пакета.

totalAds

Общее количество объявлений, содержащихся в этой рекламной паузе. Будет 1 для отдельных объявлений.

createAdBreakInfo()


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

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

Класс ima.AdEvent

Поля

События, запускаемые менеджером рекламы.

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

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

Запускается каждый раз, когда поток переключается с рекламы или рекламы на контент. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.

AD_PERIOD_STARTED

Запускается каждый раз, когда поток переключается с контента на рекламу или презентацию. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.

COMPLETE

Запускается, когда объявление завершает воспроизведение.

ERROR

Запускается при возникновении ошибки.

FIRST_QUARTILE

Запускается, когда курсор воспроизведения объявления пересекает первый квартиль.

ICON_FALLBACK_IMAGE_CLOSED

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

ICON_FALLBACK_IMAGE_SHOWN

Вызывается, когда отображается резервное изображение значка.

MIDPOINT

Срабатывает, когда курсор воспроизведения объявления пересекает среднюю точку.

PROGRESS

Запускается при обновлении хода выполнения объявления.

SKIPPABLE_STATE_CHANGED

Запускается при изменении состояния пропуска объявления.

SKIPPED

Срабатывает, когда реклама пропускается.

START

Запускается, когда начинается воспроизведение рекламы.

THIRD_QUARTILE

Запускается, когда курсор воспроизведения объявления пересекает третий квартиль.

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

Класс ima.AdInfo

Поля

Методы

Содержит информацию об объявлении. Передается в обратные вызовы событий SDK.

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

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

Информация, относящаяся ко всему перерыву, в котором находится это объявление.

adDescription

Описание объявления.

adId

Идентификатор объявления или пустая строка, если он неизвестен.

adSystem

Рекламная система, предоставляющая креатив.

adTitle

Название объявления.

advertiserName

Имя рекламодателя, определенное обслуживающей стороной.

companions

Сопутствующие объявления, указанные в ответе VAST.

creativeAdId

Код ISCI (отраслевой стандартный коммерческий идентификатор) для объявления. Это рекламный идентификатор выбранного креатива в ответе VAST.

creativeId

Идентификатор выбранного креатива для объявления.

currentTime

Текущее время в объявлении в секундах или -1, если неизвестно.

dealId

Возвращает идентификатор первой сделки, присутствующей в цепочке-оболочке текущего объявления, начиная сверху.

duration

Продолжительность этого одиночного объявления в секундах или -1, если неизвестно.

skipOffset

Время, необходимое для того, чтобы объявление можно было пропустить, или -1, если оно неизвестно.

universalAdIDRegistry

Строка, используемая для идентификации URL-адреса веб-сайта реестра, на котором каталогизирован универсальный идентификатор объявления выбранного креатива.

universalAdIDValue

Универсальный рекламный идентификатор выбранного креатива для объявления.

wrappers

Массив ima.WrapperInfo с информацией об обертке для этого объявления. Порядок будет от внешней оболочки к внутренней.

createAdInfo()


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

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

Класс ima.Companion

Поля

Методы

Содержит информацию о сопутствующих объявлениях.

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

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

API, необходимый для показа этого объявления, или недействительный, если он недоступен.

creativeType

Представляет креативный тип, обычно mimetype.

height

Высота компаньона в пикселях. 0, если недоступен.

trackingEvents

Карта отслеживания событий, где ключом является событие, а значением — список URL-адресов для проверки связи с этим событием.

url

URL-адрес статического ресурса этого сопутствующего баннера.

width

Ширина сопутствующего баннера в пикселях. 0, если недоступен.

createCompanion()


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

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

Класс ima.CuePoint

Поля

Методы

Содержит информацию о ключевой точке.

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

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

Время окончания ключевой точки в секундах. Это соответствует рекламной паузе.

hasPlayed

Логическое значение, указывающее, что точка разметки уже воспроизведена.

start

Время начала ключевой точки в секундах. Это соответствует рекламной паузе.

createCuePoint()


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

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

Класс ima.Error

Поля

Методы

Объект передается обработчику ошибок в случае возникновения ошибки.

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

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

Идентификатор ошибки. См. константу ErrorEvent для получения списка кодов ошибок.

info

Дополнительная информация об ошибке.

type

Всегда устанавливайте значение error, чтобы указать тип этого объекта.

createError()


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

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

Класс ima.ErrorEvent

Поля

Все ошибки, которые SDK может отправить обратно.

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

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

Запрос потока не был заполнен правильно.

COULD_NOT_LOAD_STREAM

Не удалось загрузить поток.

ERROR

Неизвестная ошибка.

INVALID_RESPONSE

Ответ сервера недействителен.

STREAM_API_KEY_NOT_VALID

Предоставленный ключ API не был принят сервером.

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

Класс ima.Player

Методы

adBreakEnded(adBreakInfo)

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

Параметр Тип Описание
adBreakInfo ima.AdBreakInfo

Содержит информацию о рекламной паузе.

adBreakStarted(adBreakInfo)

Необязательный. Вызывается, когда началась рекламная пауза.

Параметр Тип Описание
adBreakInfo ima.AdBreakInfo

Содержит информацию о рекламной паузе.

allVideoComplete()

Необязательный. Вызывается, когда все видео завершено.

createPlayer()

Создает пустой объект IMA Player . Для воспроизведения рекламы необходимо реализовать функцию loadUrl . Остальные функции являются необязательными.

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

loadUrl(streamInfo)

Вызывается, когда игрок должен начать воспроизведение URL-адреса. Вы должны реализовать этот метод для загрузки потока.

Параметр Тип Описание
streamInfo ima.StreamInfo

Содержит информацию, необходимую для воспроизведения контента.

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

Класс ima.StreamFormat

Поля

Определяет формат потока.

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

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

HLS

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

Класс ima.StreamInfo

Поля

Методы

Информация о потоке передавалась из SDK в плеер.

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

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

Формат видео: hls или тире. Определено в ima.StreamFormat.

manifest

URL-адрес потока.

streamId

Уникальный идентификатор потока.

streamType

Тип видео: прямой эфир или по запросу. Определено в ima.StreamType.

subtitles

Субтитры, если они есть. Недействительно, если нет.

createStreamInfo()


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

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

Класс ima.StreamManager

Методы

Объект для управления воспроизведением потока.

addEventListener(event, callback)

Добавляет прослушиватель указанного события. См. константу AdEvents для поддерживаемых событий.

Параметр Тип Описание
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


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

Параметр Тип Описание
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Не поддерживается. Вместо этого передавайте данные из сопутствующего объявления напрямую в RAF. Теперь это не операция.

getContentTime(streamTime)

Получает время в миллисекундах для потока VOD, представляющее время в контенте без рекламы. См.: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Чтобы получить время контента для текущего потока, перейдите в -1. Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI и возвращает то же значение, переданное для всех остальных потоков.

Возвращает Integer : время контента, соответствующее заданному времени потока.

Параметр Тип Описание
streamTime Integer

Время в потоке.

getCuePoints()

Возвращает все ключевые точки, соответствующие всем рекламным паузам. Это справедливо только для контента видео по запросу, где все рекламные паузы известны заранее. Все значения времени представляют собой время трансляции в секундах. Для потоков API Cloud Stitching свойство hasPlayed каждого ima.CuePoint всегда имеет значение false.

Возвращает Object : Массив со всеми ключевыми точками.

getPreviousCuePoint(time)

Возвращает точку разметки, предшествующую этому времени. Ключевая точка указывает на рекламную паузу. Все значения времени представляют собой время трансляции в секундах. Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI.

Возвращает ima.CuePoint : объект с началом, концом и hasPlayed. Возвращает значение Invalid, если ключевая точка недоступна.

Параметр Тип Описание
time Float

Время поиска, -1 указывает текущее время и возвращает Invalid для всех остальных потоков.

getStreamTime(contentTime)

Получает время для потока из времени контента для VOD в миллисекундах. См.: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI и возвращает то же значение, которое было передано для все остальные потоки.

Возвращает Integer : время потока, соответствующее заданному времени контента.

Параметр Тип Описание
contentTime Integer

Время контента.

loadThirdPartyStream(streamManifest, streamSubtitle)

streamSubtitle метаданные объявления и вызывает функцию loadUrl с предоставленными даннымиstreamManifestUrl streamManifestUrl . Эта функция работает только в том случае, если тип запроса потока — ima.StreamType.POD_VOD .

Параметр Тип Описание
streamManifest string

URL-адрес манифеста потока со вшитыми объявлениями.

streamSubtitle ifArray >|Invalid ifArray >|Invalid

Субтитры связаны с потоком или Invalid , если их нет.

onMessage(msg)

Обрабатывает все сообщения, поступающие от объекта Video. Должен вызываться для каждого сообщения, полученного через roMessagePort.

Параметр Тип Описание
msg object

Сообщение от порта roVideo.

replaceAdTagParameters(adTagParameters)

Заменяет все параметры тега объявления, которые будут использоваться для предстоящих запросов объявлений для прямой трансляции. Обратите внимание, что этот вызов неактивен для потоков VOD.

Параметр Тип Описание
adTagParameters string

Новые параметры тега объявления.

start()

Начинает воспроизведение потока.

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

Класс ima.StreamRequest

Поля

Методы

Используется для указания свойств запроса потока.

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

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

Необязательный. Вы можете переопределить ограниченный набор параметров рекламного тега в запросе трансляции. Добавьте параметры таргетинга в свой поток, чтобы получить больше информации. Вы также можете использовать параметры dai-ot и dai-ov для предпочтения варианта потока. Дополнительные сведения см. в разделе «Переопределить параметры варианта потока» .

adUiNode

Узел графа сцены, в котором отображается пользовательский интерфейс рекламы. IMA размещает на этом элементе такие элементы, как кнопки «Почему эта реклама» и «Пропустить» во время рекламы. Элемент должен перекрывать весь видеоэлемент.

apiKey

Необязательный. Эти ключи можно использовать для аутентификации запросов потока. Ключи аутентификации DAI необходимо настроить в пользовательском интерфейсе DFP.

assetKey

Требуется для прямых трансляций. Это используется для определения того, какой поток следует воспроизводить. Ключ объекта запроса прямой трансляции – это идентификатор, который можно найти в пользовательском интерфейсе DFP.

authToken

Токен авторизации запроса потока. Используется вместо ключа API для более строгой авторизации контента. Издатель может управлять авторизацией отдельных потоков контента на основе этого токена.

contentSourceId

Требуется для потоков по запросу. cmsid берется из источника видеоконтента DFP в пользовательском интерфейсе DFP.

customAssetKey

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

format

Формат потока. По умолчанию — ima.StreamFormat.HLS .

networkCode

Сетевой код издателя, отправляющего запрос потока. Для всех запросов потока требуются сетевые коды, а запросы потока с неверным кодом могут завершиться неудачно. Код применяет настройки, выбранные в пользовательском интерфейсе Менеджера рекламы, например включение ограниченной алгоритмической рекламы. Чтобы узнать код сети, смотрите эту статью .

player

Реализация интерфейса плеера.

ppid

Устарело. Используйте adTagParameters. Необязательный. Издатель DFP Audience предоставил идентификатор .

streamActivityMonitorId

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

videoId

Требуется для потоков по запросу. Идентификатор источника видеоконтента.

videoObject

Видеообъект (например, Video roSGNode), отвечающий за воспроизведение видео в клиентском приложении. Этот объект будет опрашиваться на предмет различных данных, которые будут использоваться для правильной синхронизации событий Live HLS ID3.

videoStitcherSessionOptions

Параметры сеанса используются для установки конкретных параметров видеостикера для потоковых запросов VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Инициализирует необходимые свойства Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами Live.

Параметр Тип Описание
assetKey string

apiKey string

Параметр, назначенный возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey . Если ключ API не существует, передайте пустую строку.

networkCode string

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Инициализирует необходимые свойства Pod Live ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает StreamRequest : объект ima.StreamRequest с необходимыми свойствами PodLive.

Параметр Тип Описание
customAssetKey string

networkCode string

apiKey string

Необязательный параметр, присваиваемый возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey ; по умолчанию — пустая строка.

createPodVodStreamRequest(networkCode)

Инициализирует необходимые свойства ima.StreamRequest для регистрации потока VOD при использовании модуля DAI, обслуживающего стороннюю программу сшивки видео. Эта функция устанавливает тип запроса ima.StreamType.POD_VOD и проверяет все необходимые свойства на наличие отсутствующих данных. Неудачные проверки зарегистрируют ошибку в консоли отладки.

Возвращает StreamRequest : объект ima.StreamRequest . Если указаны все обязательные свойства, тип запроса устанавливается на ima.StreamType.POD_VOD .

Параметр Тип Описание
networkCode string

код сети Google Ad Manager

createStreamRequest()


Возвращает ima.StreamRequest : пустой объект ima.StreamRequest .

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства запроса Video Stitcher Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherLive.

Параметр Тип Описание
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства Video Stitcher VOD StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherVod.

Параметр Тип Описание
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства Video Stitcher VOD StreamRequest используя vodConfigId созданный из Cloud Video Stitcher. Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherVod.

Параметр Тип Описание
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Инициализирует необходимые свойства VOD ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VOD.

Параметр Тип Описание
contentSourceId string

videoId string

apiKey string

Параметр, назначенный возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey . Если ключ API не существует, передайте пустую строку.

networkCode string

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

Класс ima.StreamType

Поля

Определяет тип потока, который проигрывателю предлагается воспроизвести. Прероллы и VOD должны воспроизводиться с начала трансляции.

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

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

Видео живое.

VOD

Видео по запросу.

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

Класс ima.WrapperInfo

Поля

Методы

Содержит информацию об обертке.

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

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

Идентификатор объявления или пустая строка, если он неизвестен.

adSystem

Объявленное имя рекламной системы или пустая строка, если она неизвестна.

creativeAdId

Идентификатор объявления в креативе или пустая строка, если он неизвестен.

creativeId

Идентификатор объявления или пустая строка, если он неизвестен.

dealId

Идентификатор сделки или пустая строка, если она неизвестна.

createWrapperInfo()


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

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

,
    1. я
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Классное изображение

Методы

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

disableLogging()

Отключает ведение журнала SDK. По умолчанию ведение журнала будет включено.

getStreamManager()

Возвращает менеджер потоков, если он доступен. Если менеджер потоков еще недоступен, возвращается Invalid. Если при создании диспетчера потоков произошла ошибка, возвращается объект ошибки.

Возвращаемый object : диспетчер потока или объект ошибки.

initSdk(settings)

Инициализирует SDK.

Параметр Тип Описание
settings object

Необязательный объект настроек IMA.

requestStream(streamRequest)

Запускает запрос асинхронного потока. Управление немедленно возвращается проигрывателю после вызова этого метода.

Возвращает object : ошибка или недействительный, если ошибки нет.

Параметр Тип Описание
streamRequest object

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

Класс ima.AdBreakInfo

Поля

Методы

Содержит информацию о рекламной паузе. Передается в обратные вызовы событий SDK.

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

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

Индекс объявления в рекламной паузе. Будет 1 для отдельных объявлений.

duration

Максимальная продолжительность перерыва в секундах или -1, если неизвестна.

podIndex

Для прямых трансляций всегда возвращается -1. Для видео по запросу (VOD) возвращает индекс рекламного модуля. Для пакета в начале ролика возвращается 0. Для пакета в середине ролика возвращается 1, 2, ..., n. Для модуля построллинга возвращает n+1...n+x. По умолчанию установлено значение 0, если это объявление не является частью модуля или этот модуль не является частью плейлиста.

timeOffset

Положение модуля в контенте в секундах. Преролл возвращает 0, постролл возвращает -1, а середина ролика возвращает запланированное время пакета.

totalAds

Общее количество объявлений, содержащихся в этой рекламной паузе. Будет 1 для отдельных объявлений.

createAdBreakInfo()


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

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

Класс ima.AdEvent

Поля

События, запускаемые менеджером рекламы.

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

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

Запускается каждый раз, когда поток переключается с рекламы или рекламы на контент. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.

AD_PERIOD_STARTED

Запускается каждый раз, когда поток переключается с контента на рекламу или презентацию. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.

COMPLETE

Запускается, когда объявление завершает воспроизведение.

ERROR

Запускается при возникновении ошибки.

FIRST_QUARTILE

Запускается, когда курсор воспроизведения объявления пересекает первый квартиль.

ICON_FALLBACK_IMAGE_CLOSED

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

ICON_FALLBACK_IMAGE_SHOWN

Вызывается, когда отображается резервное изображение значка.

MIDPOINT

Срабатывает, когда курсор воспроизведения объявления пересекает среднюю точку.

PROGRESS

Запускается при обновлении хода выполнения объявления.

SKIPPABLE_STATE_CHANGED

Запускается при изменении состояния пропуска объявления.

SKIPPED

Срабатывает, когда реклама пропускается.

START

Запускается, когда начинается воспроизведение рекламы.

THIRD_QUARTILE

Запускается, когда курсор воспроизведения объявления пересекает третий квартиль.

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

Класс ima.AdInfo

Поля

Методы

Содержит информацию об объявлении. Передается в обратные вызовы событий SDK.

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

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

Информация, относящаяся ко всему перерыву, в котором находится это объявление.

adDescription

Описание объявления.

adId

Идентификатор объявления или пустая строка, если он неизвестен.

adSystem

Рекламная система, предоставляющая креатив.

adTitle

Название объявления.

advertiserName

Имя рекламодателя, определенное обслуживающей стороной.

companions

Сопутствующие объявления, указанные в ответе VAST.

creativeAdId

Код ISCI (отраслевой стандартный коммерческий идентификатор) для объявления. Это рекламный идентификатор выбранного креатива в ответе VAST.

creativeId

Идентификатор выбранного креатива для объявления.

currentTime

Текущее время в объявлении в секундах или -1, если неизвестно.

dealId

Возвращает идентификатор первой сделки, присутствующей в цепочке-оболочке текущего объявления, начиная сверху.

duration

Продолжительность этого одиночного объявления в секундах или -1, если неизвестно.

skipOffset

Время, необходимое для того, чтобы объявление можно было пропустить, или -1, если оно неизвестно.

universalAdIDRegistry

Строка, используемая для идентификации URL-адреса веб-сайта реестра, на котором каталогизирован универсальный идентификатор объявления выбранного креатива.

universalAdIDValue

Универсальный рекламный идентификатор выбранного креатива для объявления.

wrappers

Массив ima.WrapperInfo с информацией об обертке для этого объявления. Порядок будет от внешней оболочки к внутренней.

createAdInfo()


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

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

Класс ima.Companion

Поля

Методы

Содержит информацию о сопутствующих объявлениях.

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

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

API, необходимый для показа этого объявления, или недействительный, если он недоступен.

creativeType

Представляет креативный тип, обычно mimetype.

height

Высота компаньона в пикселях. 0, если недоступен.

trackingEvents

Карта отслеживания событий, где ключом является событие, а значением — список URL-адресов для проверки связи с этим событием.

url

URL-адрес статического ресурса этого сопутствующего баннера.

width

Ширина сопутствующего баннера в пикселях. 0, если недоступен.

createCompanion()


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

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

Класс ima.CuePoint

Поля

Методы

Содержит информацию о ключевой точке.

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

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

Время окончания ключевой точки в секундах. Это соответствует рекламной паузе.

hasPlayed

Логическое значение, указывающее, что точка разметки уже воспроизведена.

start

Время начала ключевой точки в секундах. Это соответствует рекламной паузе.

createCuePoint()


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

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

Класс ima.Error

Поля

Методы

Объект передается обработчику ошибок в случае возникновения ошибки.

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

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

Идентификатор ошибки. См. константу ErrorEvent для получения списка кодов ошибок.

info

Дополнительная информация об ошибке.

type

Всегда устанавливайте значение error, чтобы указать тип этого объекта.

createError()


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

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

Класс ima.ErrorEvent

Поля

Все ошибки, которые SDK может отправить обратно.

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

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

Запрос потока не был заполнен правильно.

COULD_NOT_LOAD_STREAM

Не удалось загрузить поток.

ERROR

Неизвестная ошибка.

INVALID_RESPONSE

Ответ сервера недействителен.

STREAM_API_KEY_NOT_VALID

Предоставленный ключ API не был принят сервером.

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

Класс ima.Player

Методы

adBreakEnded(adBreakInfo)

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

Параметр Тип Описание
adBreakInfo ima.AdBreakInfo

Содержит информацию о рекламной паузе.

adBreakStarted(adBreakInfo)

Необязательный. Вызывается, когда началась рекламная пауза.

Параметр Тип Описание
adBreakInfo ima.AdBreakInfo

Содержит информацию о рекламной паузе.

allVideoComplete()

Необязательный. Вызывается, когда все видео завершено.

createPlayer()

Создает пустой объект IMA Player . Для воспроизведения рекламы необходимо реализовать функцию loadUrl . Остальные функции являются необязательными.

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

loadUrl(streamInfo)

Вызывается, когда игрок должен начать воспроизведение URL-адреса. Вы должны реализовать этот метод для загрузки потока.

Параметр Тип Описание
streamInfo ima.StreamInfo

Содержит информацию, необходимую для воспроизведения контента.

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

Класс ima.StreamFormat

Поля

Определяет формат потока.

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

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

HLS

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

Класс ima.StreamInfo

Поля

Методы

Информация о потоке передавалась из SDK в плеер.

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

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

Формат видео: hls или тире. Определено в ima.StreamFormat.

manifest

URL-адрес потока.

streamId

Уникальный идентификатор потока.

streamType

Тип видео: прямой эфир или по запросу. Определено в ima.StreamType.

subtitles

Субтитры, если они есть. Недействительно, если нет.

createStreamInfo()


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

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

Класс ima.StreamManager

Методы

Объект для управления воспроизведением потока.

addEventListener(event, callback)

Добавляет прослушиватель указанного события. См. константу AdEvents для поддерживаемых событий.

Параметр Тип Описание
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


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

Параметр Тип Описание
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Не поддерживается. Вместо этого передавайте данные из сопутствующего объявления напрямую в RAF. Теперь это не операция.

getContentTime(streamTime)

Получает время в миллисекундах для потока VOD, представляющее время в контенте без рекламы. См.: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Чтобы получить время контента для текущего потока, перейдите в -1. Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI и возвращает то же значение, переданное для всех остальных потоков.

Возвращает Integer : время контента, соответствующее заданному времени потока.

Параметр Тип Описание
streamTime Integer

Время в потоке.

getCuePoints()

Возвращает все ключевые точки, соответствующие всем рекламным паузам. Это справедливо только для контента видео по запросу, где все рекламные паузы известны заранее. Все значения времени представляют собой время трансляции в секундах. Для потоков API Cloud Stitching свойство hasPlayed каждого ima.CuePoint всегда имеет значение false.

Возвращает Object : Массив со всеми ключевыми точками.

getPreviousCuePoint(time)

Возвращает точку разметки, предшествующую этому времени. Ключевая точка указывает на рекламную паузу. Все значения времени представляют собой время трансляции в секундах. Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI.

Возвращает ima.CuePoint : объект с началом, концом и hasPlayed. Возвращает значение Invalid, если ключевая точка недоступна.

Параметр Тип Описание
time Float

Время поиска, -1 указывает текущее время и возвращает Invalid для всех остальных потоков.

getStreamTime(contentTime)

Получает время для потока из времени контента для VOD в миллисекундах. См.: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Примечание. Эта функция поддерживается только для потоков VOD с полным набором услуг DAI и возвращает то же значение, которое было передано для все остальные потоки.

Возвращает Integer : время потока, соответствующее заданному времени контента.

Параметр Тип Описание
contentTime Integer

Время контента.

loadThirdPartyStream(streamManifest, streamSubtitle)

streamSubtitle метаданные объявления и вызывает функцию loadUrl с предоставленными даннымиstreamManifestUrl streamManifestUrl . Эта функция работает только в том случае, если тип запроса потока — ima.StreamType.POD_VOD .

Параметр Тип Описание
streamManifest string

URL-адрес манифеста потока со вшитыми объявлениями.

streamSubtitle ifArray >|Invalid ifArray >|Invalid

Субтитры связаны с потоком или Invalid , если их нет.

onMessage(msg)

Обрабатывает все сообщения, поступающие от объекта Video. Должен вызываться для каждого сообщения, полученного через roMessagePort.

Параметр Тип Описание
msg object

Сообщение от порта roVideo.

replaceAdTagParameters(adTagParameters)

Заменяет все параметры тега объявления, которые будут использоваться для предстоящих запросов объявлений для прямой трансляции. Обратите внимание, что этот вызов неактивен для потоков VOD.

Параметр Тип Описание
adTagParameters string

Новые параметры тега объявления.

start()

Начинает воспроизведение потока.

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

Класс ima.StreamRequest

Поля

Методы

Используется для указания свойств запроса потока.

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

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

Необязательный. Вы можете переопределить ограниченный набор параметров рекламного тега в запросе трансляции. Добавьте параметры таргетинга в свой поток, чтобы получить больше информации. Вы также можете использовать параметры dai-ot и dai-ov для предпочтения варианта потока. Дополнительные сведения см. в разделе «Переопределить параметры варианта потока» .

adUiNode

Узел графа сцены, в котором отображается пользовательский интерфейс рекламы. IMA размещает на этом элементе такие элементы, как кнопки «Почему эта реклама» и «Пропустить» во время рекламы. Элемент должен перекрывать весь видеоэлемент.

apiKey

Необязательный. Эти ключи можно использовать для аутентификации запросов потока. Ключи аутентификации DAI необходимо настроить в пользовательском интерфейсе DFP.

assetKey

Требуется для прямых трансляций. Это используется для определения того, какой поток следует воспроизводить. Ключ объекта запроса прямой трансляции – это идентификатор, который можно найти в пользовательском интерфейсе DFP.

authToken

Токен авторизации запроса потока. Используется вместо ключа API для более строгой авторизации контента. Издатель может управлять авторизацией отдельных потоков контента на основе этого токена.

contentSourceId

Требуется для потоков по запросу. cmsid берется из источника видеоконтента DFP в пользовательском интерфейсе DFP.

customAssetKey

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

format

Формат потока. По умолчанию — ima.StreamFormat.HLS .

networkCode

Сетевой код издателя, отправляющего запрос потока. Для всех запросов потока требуются сетевые коды, а запросы потока с неверным кодом могут завершиться неудачно. Код применяет настройки, выбранные в пользовательском интерфейсе Менеджера рекламы, например включение ограниченной алгоритмической рекламы. Чтобы узнать код сети, смотрите эту статью .

player

Реализация интерфейса плеера.

ppid

Устарело. Используйте adTagParameters. Необязательный. Издатель DFP Audience предоставил идентификатор .

streamActivityMonitorId

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

videoId

Требуется для потоков по запросу. Идентификатор источника видеоконтента.

videoObject

Видеообъект (например, Video roSGNode), отвечающий за воспроизведение видео в клиентском приложении. Этот объект будет опрашиваться на предмет различных данных, которые будут использоваться для правильной синхронизации событий Live HLS ID3.

videoStitcherSessionOptions

Параметры сеанса используются для установки конкретных параметров видеостикера для потоковых запросов VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Инициализирует необходимые свойства Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами Live.

Параметр Тип Описание
assetKey string

apiKey string

Параметр, назначенный возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey . Если ключ API не существует, передайте пустую строку.

networkCode string

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Инициализирует необходимые свойства Pod Live ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает StreamRequest : объект ima.StreamRequest с необходимыми свойствами PodLive.

Параметр Тип Описание
customAssetKey string

networkCode string

apiKey string

Необязательный параметр, присваиваемый возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey ; по умолчанию — пустая строка.

createPodVodStreamRequest(networkCode)

Инициализирует необходимые свойства ima.StreamRequest для регистрации потока VOD при использовании модуля DAI, обслуживающего стороннюю программу сшивки видео. Эта функция устанавливает тип запроса ima.StreamType.POD_VOD и проверяет все необходимые свойства на наличие отсутствующих данных. Неудачные проверки зарегистрируют ошибку в консоли отладки.

Возвращает StreamRequest : объект ima.StreamRequest . Если указаны все обязательные свойства, тип запроса устанавливается на ima.StreamType.POD_VOD .

Параметр Тип Описание
networkCode string

код сети Google Ad Manager

createStreamRequest()


Возвращает ima.StreamRequest : пустой объект ima.StreamRequest .

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства запроса Video Stitcher Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherLive.

Параметр Тип Описание
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства Video Stitcher VOD StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherVod.

Параметр Тип Описание
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Инициализирует необходимые свойства Video Stitcher VOD StreamRequest используя vodConfigId созданный из Cloud Video Stitcher. Использование этого API приводит к игнорированию любых других свойств, специфичных для StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VideoStitcherVod.

Параметр Тип Описание
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Инициализирует необходимые свойства VOD ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования свойств.

Возвращает ima.StreamRequest : объект ima.StreamRequest с необходимыми свойствами VOD.

Параметр Тип Описание
contentSourceId string

videoId string

apiKey string

Параметр, назначенный возвращаемому свойству ima.StreamRequest ima.StreamRequest.apiKey . Если ключ API не существует, передайте пустую строку.

networkCode string

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

Класс ima.StreamType

Поля

Определяет тип потока, который проигрывателю предлагается воспроизвести. Прероллы и VOD должны воспроизводиться с начала трансляции.

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

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

Видео живое.

VOD

Видео по запросу.

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

Класс ima.WrapperInfo

Поля

Методы

Содержит информацию об обертке.

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

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

Идентификатор объявления или пустая строка, если он неизвестен.

adSystem

Объявленное имя рекламной системы или пустая строка, если она неизвестна.

creativeAdId

Идентификатор объявления в креативе или пустая строка, если он неизвестен.

creativeId

Идентификатор объявления или пустая строка, если он неизвестен.

dealId

Идентификатор сделки или пустая строка, если она неизвестна.

createWrapperInfo()


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

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