Эта страница переведена с помощью Cloud Translation API.

Класс: Объявление

Методы

getAdId

getAdId() возвращает строку

Идентификатор объявления используется для синхронизации основного объявления и сопутствующих объявлений.

Возвращает: string Идентификатор объявления или пустая строка, если эта информация недоступна.

получитьAdPodInfo

getAdPodInfo() возвращает AdPodInfo

Возвращает информацию о блоке объявления.

Возвращает: non-null AdPodInfo Информация о блоке рекламы.

getAdSystem

getAdSystem() возвращает строку

Информация об исходном рекламном сервере, включенная в рекламный ответ.

Возвращает: string Исходный рекламный сервер объявления или пустая строка, если эта информация недоступна.

getРекламодательName

getAdvertiserName() возвращает строку

Имя рекламодателя, определенное обслуживающей стороной.

Возвращает: string Имя рекламодателя или пустая строка, если эта информация недоступна.

получитьApiFramework

getApiFramework() возвращает строку

Идентифицирует API, необходимый для запуска объявления. Это соответствует APIFramework, указанному в обширном.

Возвращает: nullable string Платформа API должна выполнить объявление или null, если эта информация недоступна.

получить сопутствующие объявления

getCompanionAds(adSlotWidth, adSlotHeight, settings) возвращает массив ненулевых CompanionAd

Получает сопутствующие объявления для этого объявления на основе размера рекламного места для сопутствующих объявлений. Опционально принимаются расширенные настройки выбора. Обратите внимание, что этот метод будет возвращать непустой массив только для экземпляров объявлений, полученных во время или после события STARTED. В частности, объявления из события LOADED вернут пустой массив.

Параметр
adSlotWidth	число Ширина рекламного места для сопутствующего баннера.
adSlotHeight	число Высота рекламного места для сопутствующего баннера.
настройки	Необязательный CompanionAdSelectionSettings Настройки выбора сопутствующих объявлений. Значение не должно быть нулевым.

Параметр

adSlotWidth

число

Ширина рекламного места для сопутствующего баннера.

adSlotHeight

число

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

настройки

Необязательный

CompanionAdSelectionSettings

Настройки выбора сопутствующих объявлений.

Значение не должно быть нулевым.

Возвращает: non-null Array of non-null CompanionAd Массив сопутствующих объявлений, соответствующих настройкам и размеру рекламного места.

getContentType

getContentType() возвращает строку

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

Возвращает: string Тип содержимого, пустая строка, если оно недоступно.

getCreativeAdId

getCreativeAdId() возвращает строку

Возвращает код ISCI (Промышленный стандартный коммерческий идентификатор) для объявления или пустую строку, если код недоступен. Это Ad-ID креатива в ответе VAST.

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

getCreativeId

getCreativeId() возвращает строку

Получает идентификатор выбранного креатива для объявления.

Возвращает: string Идентификатор выбранного креатива для объявления или пустая строка, если эта информация недоступна.

getDealId

getDealId() возвращает строку

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

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

получить описание

getDescription() возвращает строку

Возвращает описание этого объявления из ответа VAST.

Возвращает: string Описание, пустое, если не указано.

getDuration

getDuration() возвращает число

Возвращает продолжительность выбранного объявления или -1 для нелинейных объявлений.

Возвращает: number Продолжительность выбранного объявления в секундах, -1, если оно нелинейное.

получитьвысоту

getHeight() возвращает число

Возвращает высоту выбранного нелинейного объявления.

Возвращает: number Высота выбранного нелинейного объявления или 0 для линейного объявления.

getMediaUrl

getMediaUrl() возвращает строку

Возвращает URL-адрес медиафайла, выбранного из объявления, на основе используемых в данный момент настроек выбора медиафайлов. Возвращает null, если эта информация недоступна. Доступно в событии НАЧАЛО.

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

getMinSuggestedDuration

getMinSuggestedDuration() возвращает число

Возвращает минимальную рекомендуемую продолжительность в секундах, в течение которой должно отображаться нелинейное объявление. Возвращает -2, если минимальная предлагаемая продолжительность неизвестна. Для линейного объявления возвращается вся продолжительность объявления.

Возвращает: number Минимальная предлагаемая продолжительность показа объявления в секундах.

getSkipTimeOffset

getSkipTimeOffset() возвращает число

Количество секунд воспроизведения до того, как рекламу можно будет пропустить. -1 возвращается для объявлений без возможности пропуска или если это недоступно.

Возвращает: number Смещение в секундах или -1.

getSurveyUrl

getSurveyUrl() возвращает строку

Возвращает URL-адрес, связанный с опросом для данного объявления. Возвращает ноль, если недоступен.

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

получить название

getTitle() возвращает строку

Возвращает заголовок этого объявления из ответа VAST.

Возвращает: string Заголовок, пустой, если не указан.

getTraffickingParameters

getTraffickingParameters() возвращает объект со строковыми свойствами

Получает настраиваемые параметры, связанные с объявлением во время его размещения.

Возвращает: non-null Object with string properties Сопоставление ключей трафика с их значениями или пустой Объект, если эта информация недоступна.

getTraffickingParametersString

getTraffickingParametersString() возвращает строку

Получает настраиваемые параметры, связанные с объявлением во время его размещения. Возвращает необработанную строковую версию проанализированных параметров из getTraffickingParameters.

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

получитьUiElements

getUiElements() возвращает массив строк

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

Возвращает: non-null Array of string Отображаемые элементы пользовательского интерфейса.

getUniversalAdIdRegistry

getUniversalAdIdRegistry() возвращает строку

Реестр, связанный с каталогизацией UniversalAdId выбранного креатива для объявления.

Устаревший: Вместо этого используйте ad.getUniversalAdIds().
Возвращает: string Возвращает значение реестра или «неизвестно», если оно недоступно.

getUniversalAdIdValue

getUniversalAdIdValue() возвращает строку

UniversalAdId выбранного креатива для объявления.

Устаревший: Вместо этого используйте ad.getUniversalAdIds().
Возвращает: string Возвращает значение идентификатора или «неизвестно», если оно недоступно.

getUniversalAdIds

getUniversalAdIds() возвращает массив ненулевого значения UniversalAdIdInfo.

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

Возвращает: non-null Array of non-null UniversalAdIdInfo Возвращает список сведений об универсальном идентификаторе объявления, применимых к данному объявлению.

getVastMediaBitrate

getVastMediaBitrate() возвращает число

Когда SDK выберет и креатив, и медиафайл, он вернет битрейт для медиафайла, указанный в развернутом ответе.

Возвращает: number Битрейт для выбранного медиафайла или 0.

getVastMediaHeight

getVastMediaHeight() возвращает число

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

Возвращает: number Высота медиафайла VAST для выбранного объявления или 0, если ничего не выбрано.

getVastMediaWidth

getVastMediaWidth() возвращает число

Возвращает ширину мультимедиа VAST для выбранного объявления.

Возвращает: number Ширина мультимедиа VAST для выбранного объявления или 0, если ничего не выбрано.

получитьширину

getWidth() возвращает число

Возвращает ширину выбранного объявления.

Возвращает: number Ширина выбранного нелинейного объявления или 0 для линейного объявления.

getWrapperAdIds

getWrapperAdIds() возвращает массив строк

Идентификаторы объявлений, используемые для объявлений-оболочек. Возвращаемые идентификаторы начинаются с встроенного объявления (самого внутреннего) и проходят к самой внешней рекламе-оболочке. Пустой массив возвращается, если нет объявлений-оболочек.

Возвращает: non-null Array of string Идентификаторы объявлений, начиная со встроенного объявления, или пустой массив, если объявлений-оболочек нет.

getWrapperAdSystems

getWrapperAdSystems() возвращает массив строк

Рекламные системы, используемые для рекламы-обертки. Возвращаемые рекламные системы начинаются со встроенного объявления и переходят к самой внешней рекламе-оболочке. Пустой массив возвращается, если нет объявлений-оболочек.

Возвращает: non-null Array of string Рекламные системы объявлений, начиная со встроенного объявления, или пустой массив, если нет объявлений-оболочек.

getWrapperCreativeIds

getWrapperCreativeIds() возвращает массив строк

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

Возвращает: non-null Array of string Идентификаторы креативов объявлений, начиная со встроенного объявления, или пустой массив, если объявлений-оболочек нет.

Линейный

isLinear() возвращает логическое значение

Указывает, является ли текущий режим работы объявления линейным или нелинейным. Если значение равно true, это означает, что реклама находится в режиме линейного воспроизведения; если false, это указывает на нелинейный режим. Плеер проверяет линейное свойство и обновляет его состояние в соответствии с деталями размещения рекламы. Пока реклама находится в линейном режиме, проигрыватель приостанавливает воспроизведение видео контента. Если изначально значение linear равно true, а реклама находится в начале ролика (определено извне), проигрыватель может отложить загрузку видеоконтента почти до конца воспроизведения рекламы.

Возвращает: boolean True, если реклама линейная, иначе false.