- google.ima.dai.api.Ad
- google.ima.dai.api.AdPodInfo
- google.ima.dai.api.AdProgressData
- google.ima.dai.api.CompanionAd
- google.ima.dai.api.CuePoint
- google.ima.dai.api.LiveStreamRequest
- google.ima.dai.api.StreamData
- google.ima.dai.api.StreamEvent
- google.ima.dai.api.StreamEvent.Type
- google.ima.dai.api.StreamManager
- google.ima.dai.api.StreamRequest
- google.ima.dai.api.VODStreamRequest
- 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 |
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 | Отправляется при нажатии или касании элемента клика во время воспроизведения объявления. |
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 |
| Идентификатор источника видеоконтента. Требуется для потоков по запросу. |
Константа google.ima.VERSION
Строка, содержащая полную версию SDK.