For the complete documentation index, see llms.txt. This page is also available as Markdown.

Response Zones

The Ad Placement API response JSON contains the zones array and the renderers and user objects.

In this page we will explain the zones array, which contains all the details regarding the ad that won your ad request.

The array contains an object with ad data for each zone ID requested.

Property
Description

idzone

The ID of the ad zone.

type

The ad format used, e.g. banner.

data

The ad data (Object)

Below you will find a detailed list of properties returned for each data object according to the available ad formats.

Property
Description

url

The URL that the ad directs to.

impression

The impression URL

image

The original image uploaded for the ad.

optimum_image

If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad.

width

The width of the ad in pixels.

height

The height of the ad in pixels.

media

This shows which type of banner this is: Image, HTML, or video: This should be img_banner, html_banner or video_banner, respectively.

Image Banner:

HTML Banner:

Video Banner:

Sticky Banner

Property
Description

url

The Click URL

impression

The impression URL

image

The original image uploaded for the ad.

optimum_image

In a sticky banner, if the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad.

width

The width of the ad in pixels.

height

The height of the ad in pixels.

frequency_period

How often in minutes the ad shows.

v_pos

The vertical position of the ad.

h_pos

The horizontal position of the ad.

media

This shows which type of banner this is: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively.

Sticky Banner Response Example

Instant Messages

Property
Description

url

The Click URL

impression

The impression URL

image

The URL of the image

optimum_image

If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad.

width

The width of the ad in pixels.

height

The height of the ad in pixels.

frequency_period

How often the ad shows in minutes.

media

This shows which type of banner is used: Image, HTML, or video: This should be img_banner, html_banner, or video_banner respectively.

Instant Message Response Example

Native Ads

When the response returns a Native ad, zones.data will return two objects: layout and ad_items

data.layout

Property
Description

widgetHeaderContentHtml

The URL of the 'Powered by' branding that shows.*

branding_logo

The URL for the branding logo that shows if enabled.*

branding_logo_hover

The URL for the branding logo that shows when the user hovers over it.*

itemsPerRow

The number of ads that show in each row of the widget.

itemsPerCol

The number of ads that show in each column of the widget.

font_family

The family of font used in the ad.

header_font_size

The size of font used in the branding header.

header_font_color

The colour of font used in the branding header.

widget_background_color

The hex code of the background colour used for the widget.

widget_width

The width of the entire widget.

minimum_width_for_full_sized_layout

The minimum width for a full-sized layout in pixels.

item_height

The height of each individual ad.

item_padding

The padding between each of the ads.

image_height

The height of the image in each ad.

image_width

The width of the image in each ad.

text_margin_top

The size in pixels of the top text margin.

text_margin_bottom

The size in pixels of the bottom text margin.

text_margin_left

The size in pixels of the left text margin.

text_margin_right

The size in pixels of the right text margin.

title_font_size

The font size of the title for each ad.

title_font_color

The font colour of the title for each ad.

title_font_weight

The font weight of the title for each ad.

title_decoration

Whether the title is underlined or not.

title_hover_color

The font colour when the title is hovered over.

title_hover_font_weight

The font weight when the title is hovered over.

title_hover_decoration

Whether the title is underlined on hover or not.

description_font_size

The font size of the description for each ad.

description_font_color

The font colour of the description for each ad.

description_font_weight

The font weight of the description for each ad.

description_decoration

Whether the description is underlined or not.

description_hover_color

The font colour when the description is hovered over.

description_hover_font_weight

The font weight when the description is hovered over.

description_hover_decoration

Whether the description is underlined on hover or not.

open_in_new_window

Whether the ad should be opened in a new window when clicked. 1=yes, 0=no.

mobile_responsive_type

The type of responsiveness when using a mobile device (i.e none or compact). 1=compact, 0=no.

header_is_on_top

Whether the branding should be displayed above or below the ads. 1=yes, 0=no.

header_text_align

The horizontal alignment of the branding header.

title_enabled

Whether the title is enabled or not. 1=yes, 0=no.

description_enabled

Whether the description is enabled or not. 1=yes, 0=no.

image_border_size

The size in pixels of the image border.

image_border_color

The hex code colour of the image border.

text_align

The alignment of the text: left, center, or right.

customcss_enabled

Whether custom css is enabled or not. 1=yes, 0=no.

customcss

If enabled the custom css will display here.

header_enabled

Whether header is enabled or not. 1=yes, 0=no.

mobile_breakpoint

The breakpoint in pixels, between desktop and mobile views of the ad zone.

spacing_v

The vertical spacing in pixels between the ads, set in Advanced Options.

spacing_h

The horizontal spacing in pixels between the ads, set in Advanced Options.

zoom

Whether the ad should zoom in/out on hover.

mobile_rows

The number of rows of ads in the mobile widget.

mobile_cols

The number of columns of ads in the mobile widget.

use_v2_script

Whether the ad zone was created with the newer V2 setup or the older v1.

text_enabled

Whether the text title and description should be displayed. 1=yes, 0=no.

mobile_image_width

The width of the image in each ad on mobile.

mobile_text_box_size

The text box size when on mobile. Valid range 50-500.

mobile_text_enabled

Whether the title is enabled or not on mobile. 1=yes, 0=no.

mobile_text_position

The position of the text on mobile: bottom or right.

item_spacing_on_each_side

The padding on each side of the ads, if they were set up using the old v1 setup.

text_position

Whether the text is positioned on the left or right side.

text_box_size

The size of the text box in pixels. Range 50-500.

widget_height

The height of the entire widget.

brand_enabled

Whether the branding is enabled or not.

brand_font_size

The font size of the branding.

brand_font_color

The font colour of the branding.

brand_font_weight

The font weight of the branding.

brand_decoration

Whether the font is underlined or not.

mobile_image_height

The height of the image in each ad on mobile.

publisherAdType

What type of native ad this is, i.e recommendation, exit, or interstitial: native-recommendation, native-interstitial.

data.ad_items

Property
Description

idvariation

The ID of the variation.

image

The original image uploaded for the ad.

url

The click URL.

impression

The impression URL.

title

The title text of the ad.

description

The description text of the ad.

brand

The brand text of the ad.

original_url

The original url of the landing page.

image_position

The position of the ad image (how the image will be cropped).

size

The size of the ad format selected

iframe_url

If an iframe is used as a variation, this will be the URL of the iframe.

video_thumb_id

The identifier of the video thumb asset (if present) associated with the ad creative.

video_thumb_url

The URL of the video thumb asset (if present).

video_thumb_enabled

The status of the video thumb asset (if present).

Native Ads Response Example

Outstream Video

Property
Description

url

The Click URL

tracking

An object with tracking info.

video

The video ad file or VAST link to load.

brandingEnabled

Flag to enable the branding. This value is currently not used

frequencyPeriod

How often in minutes the ad shows.

maximumWidth

Video width size.

isVast

States whether the winning campaign is a regular video ad (false) or a VAST link campaign (true).

ctaEnabled

Flag to display a CTA on the ad

cta

An object containing the details of the CTA

impression

The impression URL

data.tracking

At the moment, the data.tracking object only returns a progress array with objects meant to track the playback of the video. From these objects, the one with "offset": "00:00:10.000" is the one to call to persist the video view. The properties of each object are explained below:

Property
Description

offset

Progress marker in seconds or as a percentage of video ad played

url

Tracking URL

data.cta

Property
Description

displayUrl

URL related to the landing page of the ad

text

Text to be used in the CTA element

Outstream Video Response Example

Video Slider

Property
Description

url

The Click URL

tracking

An object with tracking info.

video

The video ad file or VAST link to load.

screenDensity

Integer indicating the share of the maximum screen space taken by the ad on a user's device

onComplete

Indicates the behaviour of the ad after the video has finished playing. "hide" means the ad should be hidden, whereas "repeat" means ad should stay on page to let the user replay it

closeAfter

Indicates the amount of seconds needed before the close button is shown on the ad

brandingEnabled

Flag to enable the branding. This property is currently not used

frequencyPeriod

How often in minutes the ad shows.

impression

The impression URL

isVast

States whether the winning campaign is a regular video ad (false) or a VAST link campaign (true).

ctaEnabled

Flag to display a CTA on the ad

cta

An object containing the details of the CTA

data.tracking

At the moment, the data.tracking object only returns a progress array with objects meant to track the playback of the video. From these objects, the one with "offset": "00:00:10.000" is the one to call to persist the video view. The properties of each object are explained below:

Property
Description

offset

Progress marker in seconds or as a percentage of video ad played

url

Tracking URL

data.cta

Property
Description

displayUrl

URL related to the landing page of the ad

text

Text to be used in the CTA element

Video Slider Response Example

Fullpage Interstitials

Property
Description

url

The Click URL

impression

The impression URL

image

The original image uploaded for the ad.

optimum_image

If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad.

width

The width of the ad in pixels.

height

The height of the ad in pixels.

frequency_count

How many times the ad can show

frequency_period

How often in minutes the ad shows

frequency_trigger_type

Flag to indicate whether this ad's frequency is based on impressions (0) or clicks (1)

ad_trigger_method

Trigger method enabled for this ad zone

ad_trigger_classes

Classes that should trigger the ad, if any

first_trigger_clicks

Number of clicks needed on the initial visit from the user in order to trigger the ad

next_trigger_clicks

Number of clicks needed after the first trigger of the ad in order to display the ad again

chrome_enabled

Flag to indicate whether this ad zone is enabled for Chrome (1), disabled (0) or enabled exclusively for this browser (2)

capping_enabled

Flag to indicate whether capping should be enforced to this ad zone or not

media

This shows which type of banner this is: Image, HTML, or video: This should be img_banner, html_banner or video_banner, respectively.

Note: most of the properties of the Fullpage Interstitial response are related to the capping and trigger of the ad. Since you are in charge of rendering the ad, it is up to you to decide whether you want to pay attention to these properties or not.

Fullpage Interstitial Response Example

Note that, although the example shows a Desktop Fullpage Interstitial, the response for a Mobile Fullpage Interstitial should be the same aside from the zone.type.

In-Page Push

Property
Description

url

The Click URL

impression

The Impression URL

image

The original image uploaded for the ad.

optimum_image

If the creative uploaded is an animated GIF, this is the optimized MP4 version of it that is created for use in the ad.

title

Title of the notification

description

Description of the notification

horizontal_position

Indicates the horizontal position on the page (left, center, right)

vertical_position

Indicates the vertical position on the page (top, middle, bottom)

delay

Number of seconds before the notification appears after the page loads

max_notifications_on_page

Number of notifications that can appear on the page at the same time

once_closed_hide_for

Length of time in seconds that the ad is hidden for once it is closed (needs cookie consent from user)

user_session_capping

Number of times the ad is shown to the user (needs cookie consent from user)

delay_between_notifications

Number of seconds before the next notification appears after the previous one loads

In-Page Push Notification Response Example

Multi-Format

A response for a Multi-Format request might return different results:

  • If the winning ad is a Native campaign, then the response will contain a regular Native data object.

  • If the winning ad is a Banner campaign and you have a Single Zone on the layout, then the response will contain a regular Banner data object.

  • If the winning ad is a Banner campaign and you chose a layout with multiple ads, then the response will contain a group object with the following properties:

Property
Description

orientation

The orientation of the Multi-Zone Layout, which can be "horizontal" or "vertical"

ad_items

Array containing the ad data for each spot on the layout.

Regardless of the result, the property multizoneid will be added to the response, indicating the zone ID of the multi-format ad zone to which this response corresponds to.

Multi-Format Response Example

The following example shows the zones object for a Multi-Format ad zone with an Horizontal x 3 layout:

Responsive Display Ads

Some formats, like Banners and Fullpage interstitials, can enable Responsive Display Ads to receive demand from Native Ads campaigns in addition to the demand from their original ad formats. In these situations, the response will contain the original_zone object indicating the type and data of the original format.

Here is an example for a Banner ad format:

Impression tracking

Make sure to make a GET call for the Impression URL to register the impressions for your ad requests. One way to achieve this is by creating an invisible image file using the impression URL as the source on the page where the ad will be displayed, e.g:

Last updated

Was this helpful?