Browse the help center

Add a VAST companion to a video banner

Adds a companion ad to a video banner, as the console's Companions grid does, without a file upload.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/vast/companions.do

Adds a companion ad to a video banner, as the console's Companions grid does, without a file upload. type STATIC takes an image (JPEG, GIF or PNG) from externalCreativeLink, which is downloaded and stored, and reads its size from the image; IFRAME takes the frame's externalCreativeLink with width and height; HTML_STATIC takes markup with width and height; HTML_TEMPLATE takes a Video Companion templateId with width and height. Needs the VAST Companion Ads permission and update rights on the banner's advertiser. Answers with the banner's companions and the new one's id.

Path Params

bannerId integer required

Video banner id

5001

Form Params

type string

Companion resource type

STATIC

externalCreativeLink string

Image URL for STATIC, frame URL for IFRAME

https://cdn.northwind.example/companion-300x250.png

markup string

HTML markup for HTML_STATIC

<a href="https://northwind.example">Shop now</a>

templateId integer

Video Companion template id for HTML_TEMPLATE

12

width integer

Conditionally required — for IFRAME, HTML_STATIC and HTML_TEMPLATE companions. Width in pixels

300

height integer

Conditionally required — for IFRAME, HTML_STATIC and HTML_TEMPLATE companions. Height in pixels

250

Responses

200

{success:true, id, companions:[…]}; success:false with 'errors' naming the missing or invalid field

400

The banner is not a video banner, the template is not a Video Companion template, or type STATIC while file storage is off

401

Authentication error

403

The VAST Companion Ads permission is off, or no update rights on the banner

404

The banner does not exist or is deleted

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.