Зоны ответа
В JSON-ответе API размещения рекламы содержатся зоны массив и рендереры и пользовательские объекты.
На этой странице мы объясним зоны массив, который содержит все сведения о рекламе, выигравшей ваш запрос на рекламу.
Массив содержит объект с данными о рекламе для каждого запрошенного ID зоны.
idzone
ID рекламной зоны.
type
Используемый формат рекламы, например banner.
data
Данные рекламы (объект)
Ниже вы найдете подробный список свойств, возвращаемых для каждого data объекта в зависимости от доступных форматов рекламы.
Баннер
url
URL, на который ведет реклама.
impression
URL показа
image
Исходное изображение, загруженное для рекламы.
optimum_image
Если загруженный креатив — анимированный GIF, это его оптимизированная версия в формате MP4, создаваемая для использования в рекламе.
width
Ширина рекламы в пикселях.
height
Высота рекламы в пикселях.
media
Это показывает, какой это тип баннера: изображение, HTML или видео: это должно быть img_banner, html_banner или video_banner, соответственно.
Примеры ответа для баннера
Баннер с изображением:
HTML-баннер:
Видео-баннер:
Закрепленный баннер
url
URL перехода по клику
impression
URL показа
image
Исходное изображение, загруженное для рекламы.
optimum_image
В закрепленном баннере, если загруженный креатив — анимированный GIF, это его оптимизированная версия в формате MP4, создаваемая для использования в рекламе.
width
Ширина рекламы в пикселях.
height
Высота рекламы в пикселях.
frequency_period
Как часто реклама показывается в минутах.
v_pos
Вертикальное положение рекламы.
h_pos
Горизонтальное положение рекламы.
media
Это показывает, какой это тип баннера: изображение, HTML или видео: это должно быть img_banner, html_banner, или video_banner соответственно.
Пример ответа для закрепленного баннера
Мгновенные сообщения
url
URL перехода по клику
impression
URL показа
image
URL изображения
optimum_image
Если загруженный креатив — анимированный GIF, это его оптимизированная версия в формате MP4, создаваемая для использования в рекламе.
width
Ширина рекламы в пикселях.
height
Высота рекламы в пикселях.
frequency_period
Как часто реклама показывается в минутах.
media
Это показывает, какой тип баннера используется: изображение, HTML или видео: это должно быть img_banner, html_banner, или video_banner соответственно.
Пример ответа для мгновенного сообщения
Нативная реклама
Когда в ответе возвращается нативная реклама, zones.data вернет два объекта: layout и ad_items
data.layout
widgetHeaderContentHtml
URL отображаемого брендинга «При поддержке».*
branding_logo
URL логотипа брендинга, который отображается при включении.*
branding_logo_hover
URL логотипа брендинга, который отображается при наведении пользователя.*
itemsPerRow
Количество объявлений, отображаемых в каждой строке виджета.
itemsPerCol
Количество объявлений, отображаемых в каждом столбце виджета.
font_family
Шрифт, используемый в рекламе.
header_font_size
Размер шрифта, используемого в заголовке брендинга.
header_font_color
Цвет шрифта, используемого в заголовке брендинга.
widget_background_color
Шестнадцатеричный код цвета фона, используемого для виджета.
widget_width
Ширина всего виджета.
minimum_width_for_full_sized_layout
Минимальная ширина полноразмерного макета в пикселях.
item_height
Высота каждого отдельного объявления.
item_padding
Отступ между каждым из объявлений.
image_height
Высота изображения в каждом объявлении.
image_width
Ширина изображения в каждом объявлении.
text_margin_top
Размер верхнего отступа текста в пикселях.
text_margin_bottom
Размер нижнего отступа текста в пикселях.
text_margin_left
Размер левого отступа текста в пикселях.
text_margin_right
Размер правого отступа текста в пикселях.
title_font_size
Размер шрифта заголовка каждого объявления.
title_font_color
Цвет шрифта заголовка каждого объявления.
title_font_weight
Начертание шрифта заголовка каждого объявления.
title_decoration
Подчеркнут ли заголовок.
title_hover_color
Цвет шрифта при наведении на заголовок.
title_hover_font_weight
Начертание шрифта при наведении на заголовок.
title_hover_decoration
Подчеркивается ли заголовок при наведении.
description_font_size
Размер шрифта описания каждого объявления.
description_font_color
Цвет шрифта описания каждого объявления.
description_font_weight
Начертание шрифта описания каждого объявления.
description_decoration
Подчеркнуто ли описание.
description_hover_color
Цвет шрифта при наведении на описание.
description_hover_font_weight
Начертание шрифта при наведении на описание.
description_hover_decoration
Подчеркивается ли описание при наведении.
open_in_new_window
Должна ли реклама открываться в новом окне при нажатии. 1=да, 0=нет.
mobile_responsive_type
Тип адаптивности при использовании мобильного устройства (то есть none или compact). 1=compact, 0=нет.
header_is_on_top
Следует ли показывать брендинг над объявлениями или под ними. 1=да, 0=нет.
header_text_align
Горизонтальное выравнивание заголовка брендинга.
title_enabled
Включен ли заголовок. 1=да, 0=нет.
description_enabled
Включено ли описание. 1=да, 0=нет.
image_border_size
Размер границы изображения в пикселях.
image_border_color
Шестнадцатеричный код цвета границы изображения.
text_align
Выравнивание текста: слева, по центру или справа.
customcss_enabled
Включен ли пользовательский CSS или нет. 1=да, 0=нет.
customcss
Если включен, пользовательский CSS будет отображаться здесь.
header_enabled
Включен ли заголовок или нет. 1=да, 0=нет.
mobile_breakpoint
Точка перехода в пикселях между десктопным и мобильным представлениями рекламной зоны.
spacing_v
Вертикальный промежуток в пикселях между объявлениями, заданный в дополнительных параметрах.
spacing_h
Горизонтальный промежуток в пикселях между объявлениями, заданный в дополнительных параметрах.
zoom
Должна ли реклама увеличиваться/уменьшаться при наведении.
mobile_rows
Количество строк объявлений в мобильном виджете.
mobile_cols
Количество столбцов объявлений в мобильном виджете.
use_v2_script
Была ли рекламная зона создана с новой настройкой V2 или со старой v1.
text_enabled
Должны ли отображаться текст заголовка и описание. 1=да, 0=нет.
mobile_image_width
Ширина изображения в каждом объявлении на мобильном устройстве.
mobile_text_box_size
Размер текстового блока на мобильном устройстве. Допустимый диапазон 50-500.
mobile_text_enabled
Включен ли заголовок на мобильном устройстве или нет. 1=да, 0=нет.
mobile_text_position
Положение текста на мобильном устройстве: снизу или справа.
item_spacing_on_each_side
Отступ с каждой стороны объявлений, если они были настроены с использованием старой настройки v1.
text_position
Расположен ли текст слева или справа.
text_box_size
Размер текстового блока в пикселях. Диапазон 50-500.
widget_height
Высота всего виджета.
brand_enabled
Включен ли брендинг или нет.
brand_font_size
Размер шрифта брендинга.
brand_font_color
Цвет шрифта брендинга.
brand_font_weight
Начертание шрифта брендинга.
brand_decoration
Подчеркнут ли шрифт.
mobile_image_height
Высота изображения в каждом объявлении на мобильном устройстве.
publisherAdType
Что это за тип нативной рекламы, то есть recommendation, exit или interstitial: native-recommendation, native-interstitial.
data.ad_items
idvariation
ID вариации.
image
Исходное изображение, загруженное для рекламы.
url
URL перехода по клику.
impression
URL показа.
title
Текст заголовка рекламы.
description
Текст описания рекламы.
brand
Текст бренда рекламы.
original_url
Исходный URL целевой страницы.
image_position
Положение изображения рекламы (как будет обрезано изображение).
size
Размер выбранного формата рекламы
iframe_url
Если в качестве варианта используется iframe, это будет URL iframe.
video_thumb_id
Идентификатор ресурса миниатюры видео (если есть), связанного с рекламным креативом.
video_thumb_url
URL ресурса миниатюры видео (если есть).
video_thumb_enabled
Статус ресурса миниатюры видео (если есть).
Пример ответа для нативной рекламы
Видео Outstream
url
URL перехода по клику
отслеживание
Объект с информацией об отслеживании.
видео
Файл видеорекламы или ссылка VAST для загрузки.
brandingEnabled
Флаг для включения брендинга. Это значение в настоящее время не используется
frequencyPeriod
Как часто реклама показывается в минутах.
maximumWidth
Размер ширины видео.
isVast
Указывает, является ли выигравшая кампания обычной видеорекламой (false) или кампанией со ссылкой VAST (true).
ctaEnabled
Флаг для отображения CTA в объявлении
cta
Объект, содержащий сведения о CTA
impression
URL показа
data.tracking
В данный момент, data.tracking объект возвращает только progress массив объектов, предназначенных для отслеживания воспроизведения видео. Из этих объектов тот, у которого "offset": "00:00:10.000" нужно вызвать, чтобы зафиксировать просмотр видео. Свойства каждого объекта описаны ниже:
offset
Метка прогресса в секундах или в процентах просмотренной видеорекламы
url
URL отслеживания
data.cta
displayUrl
URL, связанный с целевой страницей объявления
text
Текст, используемый в элементе CTA
Пример ответа Outstream Video
Видеослайдер
url
URL перехода по клику
отслеживание
Объект с информацией об отслеживании.
видео
Файл видеорекламы или ссылка VAST для загрузки.
screenDensity
Целое число, указывающее долю максимального экранного пространства, занимаемого объявлением на устройстве пользователя
onComplete
Указывает поведение объявления после завершения воспроизведения видео. "hide" означает, что объявление должно быть скрыто, а "repeat" означает, что объявление должно остаться на странице, чтобы пользователь мог воспроизвести его снова
closeAfter
Указывает количество секунд до появления кнопки закрытия на объявлении
brandingEnabled
Флаг для включения брендинга. Это свойство в настоящее время не используется
frequencyPeriod
Как часто реклама показывается в минутах.
impression
URL показа
isVast
Указывает, является ли выигравшая кампания обычной видеорекламой (false) или кампанией со ссылкой VAST (true).
ctaEnabled
Флаг для отображения CTA в объявлении
cta
Объект, содержащий сведения о CTA
data.tracking
В данный момент, data.tracking объект возвращает только progress массив объектов, предназначенных для отслеживания воспроизведения видео. Из этих объектов тот, у которого "offset": "00:00:10.000" нужно вызвать, чтобы зафиксировать просмотр видео. Свойства каждого объекта описаны ниже:
offset
Метка прогресса в секундах или в процентах просмотренной видеорекламы
url
URL отслеживания
data.cta
displayUrl
URL, связанный с целевой страницей объявления
text
Текст, используемый в элементе CTA
Пример ответа Video Slider
Полностраничные межстраничные объявления
url
URL перехода по клику
impression
URL показа
image
Исходное изображение, загруженное для рекламы.
optimum_image
Если загруженный креатив — анимированный GIF, это его оптимизированная версия в формате MP4, создаваемая для использования в рекламе.
width
Ширина рекламы в пикселях.
height
Высота рекламы в пикселях.
frequency_count
Сколько раз может показываться объявление
frequency_period
Как часто в минутах показывается объявление
frequency_trigger_type
Флаг, указывающий, основана ли частота этого объявления на показах (0) или кликах (1)
ad_trigger_method
Метод триггера, включенный для этой рекламной зоны
ad_trigger_classes
Классы, которые должны запускать показ объявления, если таковые имеются
first_trigger_clicks
Количество кликов, необходимых при первом посещении пользователя для запуска объявления
next_trigger_clicks
Количество кликов, необходимых после первого срабатывания объявления, чтобы показать его снова
chrome_enabled
Флаг, указывающий, включена ли эта рекламная зона для Chrome (1), отключена (0) или включена исключительно для этого браузера (2)
capping_enabled
Флаг, указывающий, следует ли применять лимитирование к этой рекламной зоне
media
Это показывает, какой это тип баннера: изображение, HTML или видео: это должно быть img_banner, html_banner или video_banner, соответственно.
Примечание: Большинство свойств ответа Fullpage Interstitial связаны с лимитированием и триггером объявления. Поскольку вы отвечаете за отображение объявления, вам решать, обращать ли внимание на эти свойства или нет.
Пример ответа Fullpage Interstitial
Обратите внимание, что хотя пример показывает Desktop Fullpage Interstitial, ответ для Mobile Fullpage Interstitial должен быть таким же, за исключением zone.type.
Внутристраничный Push
url
URL перехода по клику
impression
URL показа
image
Исходное изображение, загруженное для рекламы.
optimum_image
Если загруженный креатив — анимированный GIF, это его оптимизированная версия в формате MP4, создаваемая для использования в рекламе.
title
Заголовок уведомления
description
Описание уведомления
horizontal_position
Указывает горизонтальное положение на странице (слева, по центру, справа)
vertical_position
Указывает вертикальное положение на странице (вверху, посередине, внизу)
delay
Количество секунд до появления уведомления после загрузки страницы
max_notifications_on_page
Количество уведомлений, которые могут одновременно отображаться на странице
once_closed_hide_for
Продолжительность скрытия объявления в секундах после его закрытия (требуется согласие пользователя на использование cookie)
user_session_capping
Количество раз, когда объявление показывается пользователю (требуется согласие пользователя на использование cookie)
delay_between_notifications
Количество секунд до появления следующего уведомления после загрузки предыдущего
Пример ответа In-Page Push Notification
Многоформатный
Ответ на запрос Multi-Format может вернуть разные результаты:
Если выигравшее объявление является Native-кампанией, ответ будет содержать обычный объект данных Native.
Если выигравшее объявление является кампанией Banner и у вас есть Одна зона в макете, ответ будет содержать обычный объект данных Banner.
Если выигравшее объявление является кампанией Banner и вы выбрали макет с несколькими объявлениями, ответ будет содержать объект группы со следующими свойствами:
orientation
Ориентация макета Multi-Zone, которая может быть "horizontal" или "vertical"
ad_items
Массив, содержащий данные объявления для каждого места в макете.
Независимо от результата, свойство multizoneid будет добавлено в ответ, указывая ID зоны многоформатной рекламной зоны, которой соответствует этот ответ.
Пример ответа Multi-Format
Следующий пример показывает зоны объект для многоформатной рекламной зоны с Горизонтальный x 3 макет:
Адаптивные медийные объявления
Некоторые форматы, такие как баннеры и полностраничные межстраничные объявления, могут включать Адаптивные медийные объявления чтобы получать спрос от кампаний Native Ads в дополнение к спросу от их исходных рекламных форматов. В таких случаях ответ будет содержать original_zone объект, указывающий тип и данные исходного формата.
Вот пример формата баннерной рекламы:
Отслеживание показов
Обязательно выполните GET-запрос по URL показов, чтобы зарегистрировать показы для ваших рекламных запросов. Один из способов сделать это — создать невидимый файл изображения, используя URL показов в качестве источника на странице, где будет отображаться реклама, например:
Последнее обновление
Это было полезно?

