API Google IMA DAI SDK

    1. google.ima.dai.api.Ad
    2. google.ima.dai.api.AdPodInfo
    3. google.ima.dai.api.AdProgressData
    4. google.ima.dai.api.CompanionAd
    5. google.ima.dai.api.CuePoint
    6. google.ima.dai.api.LiveStreamRequest
    7. google.ima.dai.api.StreamData
    8. google.ima.dai.api.StreamEvent
    9. google.ima.dai.api.StreamEvent.Type
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.VERSION

Class google.ima.dai.api.Ad

Методы

Класс, представляющий объект объявления при динамической вставке объявлений. Этот класс предоставляет подмножество свойств ima.Ad.

getAdId()


Возврат товаров string:

getAdPodInfo()


Возвращает google.ima.dai.api.AdPodInfo:

getAdSystem()


Возврат товаров string:

getAdvertiserName()


Возврат товаров string:

getApiFramework()


Возвращает string:

getCompanionAds()


Возвраты Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()


Возвраты string:

getCreativeId()


Возврат товаров string:

getDealId()


Возврат товаров string:

getDescription()


Возвращает string:

getDuration()


Возврат товаров number:

getTitle()


Возврат товаров string:

getVastMediaHeight()


Возвращает number:

getVastMediaWidth()


Возвращает number:

getWrapperAdIds()


Возврат товаров Array.<string>:

getWrapperAdSystems()


Возврат товаров Array.<string>:

getWrapperCreativeIds()


Возвраты Array.<string>:

Класс google.ima.dai.api.AdPodInfo

Методы

Класс, представляющий объект информации о пакете объявлений во время вставки динамического объявления. Этот класс предоставляет доступ к подмножеству свойств ima.AdPodInfo.

getAdPosition()


Возврат товаров number:

getMaxDuration()


Возвращает number:

getPodIndex()


Возвращает number:

getTimeOffset()


Возвращает number:

getTotalAds()


Возвращает number:

Класс google.ima.dai.api.AdProgressData

Поля

Класс для указания данных о ходе показа объявлений.

Свойства

Название Тип Описание
adBreakDuration

adPosition

currentTime

duration

totalAds

Класс google.ima.dai.api.CompanionAd

Методы

Класс, представляющий объект сопутствующего объявления при динамической вставке объявлений. Этот класс предоставляет доступ к подмножеству свойств ima.CompanionAd.

getAdSlotId()


Возвраты string:

getContent()


Возврат товаров string:

getContentType()


Возвращает string:

getHeight()


Возвращает number:

getWidth()


Возвращает number:

Класс google.ima.dai.api.CuePoint

Поля

Класс для указания свойств временной точки, которая представляет собой рекламную паузу в потоках DAI VOD.

Свойства

Название Тип Описание
end

Время окончания этой временной метки.
played

Воспроизведена ли эта временная метка.
start

Время начала этой временной метки.

Class google.ima.dai.api.LiveStreamRequest

Поля

Класс для указания свойств запроса трансляции.

Конструктор
Параметр Тип Описание
opt_liveStreamRequest Object

, в котором уже заданы свойства запроса потока.

Свойства

Название Тип Описание
assetKey

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

Класс google.ima.dai.api.StreamData

Поля

Класс для указания данных потока.

Свойства

Название Тип Описание
adProgressData

Информация о времени показа текущего объявления.
cuepoints

Рекламные временные метки для трансляции по запросу. Эти значения могут меняться по мере воспроизведения. Это поле заполняется только в прослушивателе событий для AdEvent CUEPOINTS_CHANGED.
errorMessage

streamId

subtitles

url

Класс google.ima.dai.api.StreamEvent

Методы

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

getAd()


Возвращает google.ima.dai.api.Ad: возвращает объект с информацией об объявлении.

getStreamData()


Возвращает google.ima.dai.api.StreamData: объект возврата с информацией о потоке.

Enum google.ima.dai.api.StreamEvent.Type

Поля

Список типов событий, поддерживаемых IMA SDK.

Значения

Значение Описание
AD_BREAK_ENDED

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

Срабатывает при начале рекламной паузы.
AD_PROGRESS

Срабатывает при обновлении хода воспроизведения объявления.
CLICK

Срабатывает, когда пользователь нажимает на элемент клика во время воспроизведения объявления.
COMPLETE

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

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

Срабатывает при возникновении ошибки.
FIRST_QUARTILE

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

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

Срабатывает, когда объявление достигает середины.
STARTED

Срабатывает при запуске объявления.
STREAM_INITIALIZED

Активируется при инициализации потока.
THIRD_QUARTILE

Срабатывает, когда объявление достигает третьего квартиля.

Класс google.ima.dai.api.StreamManager

Методы

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

Конструктор
Параметр Тип Описание
videoElement HTMLVideoElement

Фактический элемент видеопроигрывателя.

contentTimeForStreamTime(streamTime)

Возвращает время контента без рекламы для заданного времени трансляции. Возвращает указанное время трансляции.

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

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

Время трансляции с вставленными объявлениями (в секундах).

onTimedMetadata(metadata)

Передает словарь обработанных метаданных. Словарь должен содержать ключ TXXX со строкой метаданных, заданной пользователем, в качестве значения. Если ваш проигрыватель предоставляет необработанные метаданные, используйте вызов ima.dai.api.StreamManager.processMetadata.

Параметр Тип Описание
metadata Object

Словарь метаданных.

previousCuePointForStreamTime(streamTime)

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

Возвращает google.ima.dai.api.CuePoint: предыдущую временную метку для заданного времени трансляции.

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

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

processMetadata(type, data, timestamp)

Обрабатывает временные метаданные для прямых трансляций. Используйте, если ваш видеопроигрыватель предоставляет неразобранные метаданные вместе с временными метками. В противном случае вызовите ima.dai.api.StreamManager.onTimedMetadata.

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

Тип метаданных. Должно быть указано значение ID3.
data Uint8Array

Необработанные данные тега. Для ID3 – весь тег.
timestamp number

Время, когда должны быть обработаны данные.

requestStream(streamRequest)

Запрашивает загрузку потока с использованием предоставленных параметров.

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

содержит параметры для загрузки метаданных потока.

setClickElement(clickElement)

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

Параметр Тип Описание
clickElement Element

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

streamTimeForContentTime(contentTime)

Возвращает время трансляции с рекламой для заданного времени контента. Возвращает указанное время контента для трансляций.

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

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

Продолжительность контента без рекламы (в секундах).

Class google.ima.dai.api.StreamRequest

Поля

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

Свойства

Название Тип Описание
adTagParameters

Вы можете переопределить ограниченный набор параметров тега объявления в запросе видеопотока. Подробнее о том, как добавить параметры таргетинга в потоковое видео… Для выбора варианта трансляции можно использовать параметры dai-ot и dai-ov. Подробнее о том, как переопределить параметры вариантов трансляции…
apiKey

Ключ API для запроса потока. Он настраивается в интерфейсе администратора DFP и предоставляется издателю для разблокировки контента. Она проверяет приложения, которые пытаются получить доступ к контенту.
streamActivityMonitorId

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

Класс google.ima.dai.api.VODStreamRequest

Поля

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

Конструктор
Параметр Тип Описание
opt_VODStreamRequest Object

объект, которому уже назначены свойства запроса потока.

Свойства

Название Тип Описание
contentSourceId

Уникальный идентификатор контента издателя из CMS. Обязательно для трансляций по запросу.
videoId

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

Константа google.ima.VERSION

Строка, содержащая полную версию SDK.