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

Методы

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

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

Поля

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

Ценности

Ценить Описание
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

Методы

Обрабатывает потоки динамической вставки рекламы. Он управляет взаимодействием с бэкэндом 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

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

apiKey

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

streamActivityMonitorId

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

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

Поля

Класс для указания свойств запроса на потоковую передачу видео по запросу (VOD).

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

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

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

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

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

videoId

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

Constant google.ima.VERSION

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