API SDK Google IMA DAI

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

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

Методы

getAdId , getAdPodInfo , getAdSystem , getAdvertiserName , getApiFramework , getCompanionAds , getCreativeAdId , getCreativeId , getDealId , getDescription , getDuration , getTitle , getVastMediaHeight , getVastMediaWidth , getWrapperAdIds , getWrapperAdSystems , getWrapperCreativeIds

Класс, представляющий объект рекламы при динамической вставке. Этот класс предоставляет подмножество свойств 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

Методы

getAdPosition , getMaxDuration , getPodIndex , getTimeOffset , getTotalAds

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

getAdPosition()

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

getMaxDuration()

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

getPodIndex()

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

getTimeOffset()

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

getTotalAds()

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

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

Поля

adBreakDuration , adPosition , currentTime , duration , totalAds

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

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

Имя	Тип	Описание
adBreakDuration
adPosition
currentTime
duration
totalAds

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

Методы

getAdSlotId , getContent , getContentType , getHeight , getWidth

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

getAdSlotId()

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

getContent()

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

getContentType()

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

getHeight()

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

getWidth()

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

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

Поля

конец , воспроизведение , начало

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

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

Имя	Тип	Описание
end		Конечное время для этой контрольной точки.
played		Если эта контрольная точка была воспроизведена.
start		Время начала этой контрольной точки.

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

Поля

assetKey

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

Конструктор :

Параметр	Тип	Описание
opt_liveStreamRequest	Object	объект, которому уже назначены свойства запроса потока.

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

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

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

Поля

adProgressData , контрольные точки , errorMessage , streamId , субтитры , URL

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

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

Имя	Тип	Описание
adProgressData		Информация о времени показа воспроизводимой в данный момент рекламы.
cuepoints		Точки показа рекламы для трансляции по запросу. Они могут меняться по мере трансляции. Они будут заполнены только в прослушивателе событий CUEPOINTS_CHANGED AdEvent .
errorMessage
streamId
subtitles
url

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

Методы

getAd , getStreamData

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

getAd()

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

getStreamData()

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

Перечисление google.ima.dai.api.StreamEvent.Type

Поля

AD_BREAK_ENDED , AD_BREAK_STARTED , AD_PROGRESS , CLICK , COMPLETE , CUEPOINTS_CHANGED , ERROR , FIRST_QUARTILE , LOADED , MIDPOINT , STARTED , STREAM_INITIALIZED , THIRD_QUARTILE

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

Ценности

Ценить	Описание
AD_BREAK_ENDED	Срабатывает по окончании рекламной паузы.
AD_BREAK_STARTED	Срабатывает при начале рекламной паузы.
AD_PROGRESS	Срабатывает при обновлении хода показа объявления.
CLICK	Отправляется при нажатии или касании элемента click во время воспроизведения рекламы.
COMPLETE	Срабатывает после завершения показа рекламы.
CUEPOINTS_CHANGED	Отправляется для потоковой передачи по запросу при изменении контрольных точек.
ERROR	Срабатывает при возникновении ошибки.
FIRST_QUARTILE	Срабатывает, когда объявление достигает первого квартиля.
LOADED	Срабатывает, когда манифест потока доступен.
MIDPOINT	Срабатывает, когда объявление достигает своей середины.
STARTED	Срабатывает при запуске рекламы.
STREAM_INITIALIZED	Срабатывает при инициализации потока.
THIRD_QUARTILE	Срабатывает, когда объявление достигает третьего квартиля.

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

Методы

contentTimeForStreamTime , onTimedMetadata , previousCuePointForStreamTime , processMetadata , requestStream , setClickElement , streamTimeForContentTime

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

Конструктор :

Параметр	Тип	Описание
videoElement	HTMLVideoElement	Фактический элемент видеоплеера.

contentTimeForStreamTime(streamTime)

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

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

Параметр	Тип	Описание
streamTime	number	время трансляции со вставленной рекламой (в секундах).

onTimedMetadata(metadata)

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

Параметр	Тип	Описание
metadata	Object	Словарь метаданных.

previousCuePointForStreamTime(streamTime)

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

Возвращает 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	время контента без рекламы (в секундах).

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

Поля

adTagParameters , apiKey , streamActivityMonitorId

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

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

Имя	Тип	Описание
adTagParameters		Вы можете переопределить ограниченный набор параметров тега рекламы в запросе потока. Дополнительную информацию можно получить, указав параметры таргетинга для потока . Параметры dai-ot и dai-ov можно использовать для настройки вариантов потока. Подробнее см. в разделе «Переопределение параметров вариантов потока» .
apiKey		API-ключ запроса потока. Он настраивается через интерфейс администратора DFP и предоставляется издателю для разблокировки его контента. Он проверяет приложения, пытающиеся получить доступ к контенту.
streamActivityMonitorId		Идентификатор, который будет использоваться для отладки трансляции с помощью инструмента мониторинга активности трансляции. Он обеспечивает удобный способ поиска журнала трансляции в инструменте мониторинга активности трансляции.

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

Поля

contentSourceId , videoId

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

Конструктор :

Параметр	Тип	Описание
opt_VODStreamRequest	Object	объект, которому уже назначены свойства запроса потока.

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

Имя	Тип	Описание
contentSourceId		Уникальный идентификатор контента издателя из CMS. Требуется для потоковой передачи по запросу.
videoId		Идентификатор источника видеоконтента. Требуется для потоковой передачи по запросу.

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

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