IMA DAI SDK для Roku

1. 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

Класс има

Методы

disableLogging , getStreamManager , initSdk , requestStream

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

disableLogging()

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

getStreamManager()

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

Возвращает object : менеджер потока или объект ошибки.

initSdk(settings)

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

Параметр	Тип	Описание
settings	object	Дополнительный объект настроек IMA.

requestStream(streamRequest)

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

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

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

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

Класс ima.AdBreakInfo

Поля

adPosition , продолжительность , podIndex , timeOffset , totalAds

Методы

createAdBreakInfo

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

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

Имя	Тип	Описание
adPosition		Индекс рекламы в рекламной паузе. Для отдельных объявлений индекс равен 1 .
duration		Максимальная продолжительность перерыва в секундах или -1 , если неизвестна.
podIndex		Для прямых трансляций возвращает идентификатор паузы как индекс модуля или 0 для преролла. В прямых трансляциях построллы отсутствуют. Значение по умолчанию -2 . Для видео по запросу (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

События, инициированные менеджером объявлений.

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

Имя	Тип	Описание
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

Поля

adBreakInfo , adDescription , adId , adSystem , adTitle , advertisingerName , companions , creativeAdId , creativeId , currentTime , dealId , duration , skipOffset , universalAdIDRegistry , universalAdIDValue , wrappers

Методы

createAdInfo

Содержит информацию о рекламе. Передаётся 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

Поля

adSlotId , apiFramework , companionClickThrough , creativeType , height , trackingEvents , url , width

Методы

createCompanion

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

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

Имя	Тип	Описание
adSlotId		Идентификатор рекламного места сопутствующего объявления. Пусто, если недоступно.
apiFramework		API, необходимый для выполнения этой рекламы, или Invalid, если он недоступен.
companionClickThrough		Перейдите по URL-адресу сопутствующего материала.
creativeType		Представляет собой тип креатива, обычно MIME-тип.
height		Высота объекта-компаньона в пикселях. 0, если недоступно.
trackingEvents		Карта отслеживания событий, где ключом является событие, а значением — список URL-адресов для отправки ping-запроса на это событие.
url		URL-адрес статического ресурса этого компаньона.
width		Ширина компаньона в пикселях. 0, если недоступно.

createCompanion()

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

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

Класс ima.CuePoint

Поля

конец , уже пройдено , начало

Методы

createCuePoint

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

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

Имя	Тип	Описание
end		Время окончания ключевой точки в секундах. Соответствует рекламной паузе.
hasPlayed		Логическое значение, указывающее, что контрольная точка уже воспроизведена.
start		Время начала ключевой точки в секундах. Соответствует рекламной паузе.

createCuePoint()

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

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

Класс ima.Error

Поля

идентификатор , информация , тип

Методы

createError

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

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

Имя	Тип	Описание
id		Идентификатор ошибки. Список кодов ошибок см. в константе ErrorEvent.
info		Дополнительная информация об ошибке.
type		Всегда устанавливайте значение error для указания типа этого объекта.

createError()

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

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

Класс ima.ErrorEvent

Поля

BAD_STREAM_REQUEST , COULD_NOT_LOAD_STREAM , ERROR , INVALID_RESPONSE , STREAM_API_KEY_NOT_VALID

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

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

Имя	Тип	Описание
BAD_STREAM_REQUEST		Запрос потока не был заполнен корректно.
COULD_NOT_LOAD_STREAM		Не удалось загрузить поток.
ERROR		Неизвестная ошибка.
INVALID_RESPONSE		Ответ сервера недействителен.
STREAM_API_KEY_NOT_VALID		Предоставленный ключ API не был принят сервером.

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

Класс ima.Player

Методы

adBreakEnded , adBreakStarted , allVideoComplete , createPlayer , loadUrl , streamInitialized

adBreakEnded(adBreakInfo)

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

Параметр	Тип	Описание
adBreakInfo	ima.AdBreakInfo	Содержит информацию о рекламной паузе.

adBreakStarted(adBreakInfo)

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

Параметр	Тип	Описание
adBreakInfo	ima.AdBreakInfo	Содержит информацию о рекламной паузе.

allVideoComplete()

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

createPlayer()

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

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

loadUrl(streamInfo)

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

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

streamInitialized(streamInfo)

Вызывается при инициализации потока.

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

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

Класс ima.StreamFormat

Поля

DASH , HLS

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

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

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

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

Класс ima.StreamInfo

Поля

формат , манифест , streamId , streamType , субтитры

Методы

createStreamInfo

Информация о потоке, передаваемая от SDK к проигрывателю.

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

Имя	Тип	Описание
format		Формат видео: hls или dash. Определяется в ima.StreamFormat.
manifest		URL для потока.
streamId		Уникальный идентификатор потока.
streamType		Тип видео: в прямом эфире или по запросу. Определяется в ima.StreamType.
subtitles		Субтитры, если есть. Если нет, то недействительны.

createStreamInfo()

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

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

Класс ima.StreamManager

Методы

addEventListener , createStreamManager , enableInteractiveAds , getContentTime , getCuePoints , getPreviousCuePoint , getStreamTime , loadThirdPartyStream , onMessage , replaceAdTagParameters , start

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

addEventListener(event, callback)

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

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

createStreamManager(streamRequest, streamInitResponse)

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

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

enableInteractiveAds()

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

getContentTime(streamTime)

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

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

Параметр	Тип	Описание
streamTime	Integer	Время в потоке.

getCuePoints()

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

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

getPreviousCuePoint(time)

Возвращает контрольную точку, предшествующую данному времени. Эта контрольная точка указывает на рекламную паузу. Все значения времени соответствуют продолжительности трансляции в секундах.

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

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

getStreamTime(contentTime)

Получает время трансляции из времени контента для VOD в миллисекундах. Подробнее см. в разделе часто задаваемых вопросов .

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

Параметр	Тип	Описание
contentTime	Integer	Время содержания.

loadThirdPartyStream(streamManifest, streamSubtitle)

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

Параметр	Тип	Описание
streamManifest	string	URL-адрес манифеста потока со вшитыми рекламными объявлениями.
streamSubtitle	ifArray >|Invalid	Субтитры связаны с потоком или Invalid , если их нет.

onMessage(msg)

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

Параметр	Тип	Описание
msg	object	Сообщение из порта roVideo.

replaceAdTagParameters(adTagParameters)

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

Параметр	Тип	Описание
adTagParameters	string	Новые параметры тега объявления.

start()

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

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

Класс ima.StreamRequest

Поля

adTagParameters , adUiNode , apiKey , assetKey , authToken , contentSourceId , customAssetKey , format , networkCode , player , ppid , streamActivityMonitorId , videoId , videoObject , videoStitcherSessionOptions

Методы

createLiveStreamRequest , createPodLiveStreamRequest , createPodVodStreamRequest , createStreamRequest , createVideoStitcherLiveStreamRequest , createVideoStitcherVodStreamRequest , createVideoStitcherVodStreamRequestWithVodConfig , createVodStreamRequest

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

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

Имя	Тип	Описание
adTagParameters		Необязательно. Вы можете переопределить ограниченный набор параметров тега рекламы в запросе потока. Укажите параметры таргетинга для потока, чтобы получить дополнительную информацию. Вы также можете использовать параметры dai-ot и dai-ov для настройки вариантов потока. Подробнее см. в разделе «Переопределение параметров вариантов потока» .
adUiNode		Узел графа сцены, где отображается пользовательский интерфейс рекламы. IMA размещает на этом элементе такие элементы, как «Почему эта реклама» и « Пропустить » во время рекламы. Элемент должен перекрывать весь видеоэлемент.
apiKey		Необязательно. Эти ключи можно использовать для аутентификации запросов потоковой передачи. Ключи аутентификации DAI необходимо настроить в пользовательском интерфейсе DFP.
assetKey		Требуется для прямых трансляций. Используется для определения потока, который следует воспроизводить. Ключ ресурса запроса прямой трансляции — это идентификатор, который можно найти в пользовательском интерфейсе DFP.
authToken		Токен авторизации запроса потока. Используется вместо ключа API для более строгой авторизации контента. Издатель может контролировать авторизацию отдельных потоков контента на основе этого токена.
contentSourceId		Требуется для потоковой передачи по запросу. CMSID берётся из источника видеоконтента DFP в пользовательском интерфейсе DFP.
customAssetKey		Пользовательский ключ ресурса используется для определения потока, который следует воспроизводить. Пользовательские ключи ресурсов требуются для обслуживания потоковой передачи pod.
format		Формат потока. По умолчанию ima.StreamFormat.HLS .
networkCode		Сетевой код издателя, выполняющего запрос на поток. Сетевые коды требуются для запросов на поток, обслуживаемых Pod, с помощью createPodLiveStreamRequest или createPodVodStreamRequest. Эти коды также требуются для запросов на поток, объединяемых в облако, с помощью createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest или createVideoStitcherVodStreamRequestWithVodConfig. Эти коды необязательны и рекомендуются для запросов на поток, обслуживаемых Full Service, с помощью createLiveStreamRequest или createVodStreamRequest. Добавление сетевого кода применяет настройки, выбранные в пользовательском интерфейсе Менеджера рекламы, такие как программная ограниченная поддержка рекламы. Для обслуживания Pod и объединения в облако добавление сетевого кода позволяет найти и воспроизвести поток. Чтобы найти сетевой код, см. эту статью .
player		Реализация интерфейса плеера.
ppid		Устарело. Используйте adTagParameters. Необязательно. Идентификатор предоставлен издателем DFP Audience.
streamActivityMonitorId		Идентификатор, который будет использоваться для отладки трансляции с помощью инструмента мониторинга активности трансляции. Он обеспечивает удобный способ поиска журнала трансляции в инструменте мониторинга активности трансляции.
videoId		Требуется для потоковой передачи по запросу. Идентификатор источника видеоконтента.
videoObject		Видеообъект (например, Video roSGNode), отвечающий за воспроизведение видео в клиентском приложении. Этот объект будет опрашиваться на предмет различных данных, которые будут использоваться для правильного определения времени событий Live HLS ID3.
videoStitcherSessionOptions		Параметры сеанса используются для настройки специфических параметров видеостичера для VideoStitcher streamRequests.

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.apiKey ima.StreamRequest по умолчанию — пустая строка.

createPodVodStreamRequest(networkCode)

Инициализирует требуемые свойства запроса ima.StreamRequest для регистрации потока VOD при использовании DAI Pod для обслуживания со сторонним видеосшивателем. Эта функция устанавливает тип запроса 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)

Инициализирует обязательные свойства запроса VOD StreamRequest от Video Stitcher, используя 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

Поля

ВЖИВУЮ , ВИДЕО ПО ЗАПРОСУ

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

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

Имя	Тип	Описание
LIVE		Видео транслируется в прямом эфире.
VOD		Видео доступно по запросу.

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

Класс ima.WrapperInfo

Поля

adId , adSystem , creativeAdId , creativeId , dealId

Методы

createWrapperInfo

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

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

Имя	Тип	Описание
adId		Идентификатор объявления или пустая строка, если неизвестен.
adSystem		Объявленное имя рекламной системы или пустая строка, если неизвестно.
creativeAdId		Идентификатор объявления в креативе или пустая строка, если он неизвестен.
creativeId		Идентификатор креатива или пустая строка, если неизвестен.
dealId		Идентификатор сделки или пустая строка, если неизвестен.

createWrapperInfo()

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

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