API SDK Google IMA DAI

    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.Тип
    10. google.ima.dai.api.StreamManager
    11. google.ima.dai.api.StreamRequest
    12. google.ima.dai.api.VODStreamRequest
    13. google.ima.ВЕРСИЯ

Класс 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

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

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

Поля

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

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

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

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

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

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

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

Поля

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

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

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

Информация о времени воспроизведения текущей рекламы.

cuepoints

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

errorMessage

streamId

subtitles

url

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

Методы

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

getAd()


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

getStreamData()


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

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

Поля

Список типов событий, поддерживаемых 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

Методы

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

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

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

contentTimeForStreamTime(streamTime)

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

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

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

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

onTimedMetadata(metadata)

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

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

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

previousCuePointForStreamTime(streamTime)

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

Возвращает 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)

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

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

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

streamTimeForContentTime(contentTime)

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

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

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

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

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

Поля

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

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

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

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

apiKey

API-ключ запроса потока. Он настраивается через DFP Admin UI и предоставляется издателю для разблокировки его контента. Он проверяет приложения, которые пытаются получить доступ к контенту.

streamActivityMonitorId

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

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

Поля

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

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

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

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

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

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

videoId

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

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

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