API Reference
GuidesAPI ReferenceAuthentication

Zone

Zone JSON Fields

PropertyDescriptionTypeOptional on Creation?
site-idThe id of the site to which the zone belongs.
This can be set only when a site is created.		IntegerNo
nameThe zone nameString (245 max)No
deviceThe zone device type:
  • mobile web
  • web


    • Possible values for site:

    • web
    • iptv
    • ott

      • For site-type defined as mobile-in-app: mobile-in-app
StringNo
positioningThe zone positioning type.

Possible values are:

  • 2 (preroll)
  • 3 (midroll)
  • 4 (postroll)
  • 5 (outstream)
IntegerNo
vast-redirectIndicates if the zone supports redirect or notBooleanYes

Default is true.
vpaidIndicates if the zone supports VPAID.

VPAID Flash & VPAID JavaScript support are set automatically based on device and integration type chosen. If integration type chosen is set to "vast" and VPAID support is enabled, then Flash and JS VPAID support are enabled.

If set to true, all formats are activated on the zone (Youtube, Overlay, Rich formats)		BooleanYes

Default is true.
cappingAn object describing the capping applied for this zone.

Capping.view is the maximum number of impressions for a viewer and capping.duration is the duration in seconds for which this limitation applies		ObjectYes

Default is null: no capping is applied to ads.
max-ad-durationThe maximum duration in seconds that the zone allows for an ad.

Zero value indicates that no limitation is applied		IntegerYes

Default is null: no limitation is applied on ad durations.
floor-priceThe minimum CPM (in the private exchange currency) that the zone allows for a campaignString with decimal point separator to avoid conversion issuesYes

Default is null: no limitation is applied on bid prices.
floor-price-buy-sideThe minimum buy-side CPM (in the private exchange currency) that the zone allows for a campaign.

This field is not allowed if the AdNetwork module is disabled.		String with decimal point separator to avoid conversion issuesYes

Default is null: no limitation is applied on bid prices.
seb-policyPossible values are "", "" and "".

Possible values are:

  • disallowed
  • allowed
  • allowed-under-conditions


    • Works for EPB policy (Exclusive Programmatic Buyers
StringYes
play-typePossible values are "auto", "click" and "scroll".

Possible values are:

  • auto
  • click
  • scroll
StringYes

Default is click.
player-heightHeight of the playerInteger

Minimum value is 10.		Yes
player-widthWidth of the playerInteger

Minimum value is 10.		Yes
skippable-adAllow or disallow to skip the adBooleanYes

Default is false.
soundAuto-play sound on/offBooleanYes

Default is true.
integration-typeAllowed values are :

Permitted values are:

  • brightcove-plugin
  • jw-plugin
  • flowplayer-plugin
  • viper-sdk
  • prime-time-sdk
  • android-sdk
  • ios-sdk
  • html5-sdk
  • vast (equivalent to External in UI)
  • vpaid-adapter
  • screen-roll
  • expand-banner
  • appletv-sdk
  • slider-ad
  • floor-ad
  • prebid
StringYes

Default is "vast": equivalent to External in UI.
tag-idsAn array with tag IDsArray of integersYes

Default is null: zone is not tagged.
skip-ad-buttonAn object defining the behavior of the skip ad button.

Skip-ad-button.type is the duration type where the button appears and skip-ad-button.value is the duration in milliseconds/percent of the video from where the button appears.		ObjectYes

Default is null: no skip ad button is added. To delete set it to null.
ssl-onlyTrue if zone accepts only ads that can be delivered in a SSL context, false if not.BooleanYes

Default is false.
externalrefString(50)Yes

Default is null.
ad-typeDefines the ad type for this site:
  • 0 for video

  • 1 for audio


Audio support module is required when creating audio inventory.		IntYes

(Default is 0, video)

Capping

PropertyDescriptionTypeOptional on Creation?
viewThe maximum number of impressions for a viewer for the current zoneIntegerNo, if the capping object is present, the field is mandatory.
durationThe duration in seconds for which this capping limitation appliesIntegerNo, if the capping object is present, the field is mandatory.

Skip Ad Button

PropertyDescriptionTypeOptional on Creation?
typeThe duration of the video at which the button appearsEnum ('ms', 'percent')No, if the skip-ad-button object is present, the field is mandatory.
valueThe duration in milliseconds/percent of the video at which the button appearsIntNo, if the skip-ad-button object is present, the field is mandatory.