Native Display Ad

Note

Fields marked with an asterisk (*) are optional.

Native Object Properties
Value Type Description
asset array of objects List of native ad assets, see Native Asset Object
link object The Native Link Object. This is the default link object for the ad. Individual assets can also have a link object which applies if the asset is activated (clicked). If the asset has no link object, the parent link object applies.

Native Asset Object

Note

  • (*) There may be exactly one of the fields marked with asterisk in one asset object.
  • (**) The link object is optional and may not be present in each response.
Native Asset Object Properties
Value Type Description
id integer A unique asset ID, must match one of the asset IDs in the bid request, for example, 1.
req* integer Set to 1 if the asset is required (bidder requires it to be displayed), default is 0, for example, 1.
title* object Title object for a title asset, see, Native Asset Title Object.
img* object Image object for an image asset, see, Native Asset Image Object.
video* object Video object for a video asset, see, Native Asset Video Object.
data* object Data object for a data asset, see, Native Asset Data Object.
link ** object

Link object for a call to action.

  • The link object applies if the asset item is activated (clicked).
  • If there is no link object on the asset, the parent link object on the bid response applies. See Native Link Object.

Native Asset Title Object

Native Asset Title Object Properties
Value Type Description
text string (Required) The text associated with the title element. "Our product is the best!"

Native Asset Image Object

Native Asset Image Object Properties
Value Type Description
url string (Required) URL of the image asset, for example, "http://adserver.com/image?impid=102".
h integer (Recommended) Height of the image in pixels, for example, 250.
w integer (Recommended) Width of the image in pixels, for example, 300.

Native Asset Video Object

Native Asset Video Object Properties
Value Type Description
adm string

(Required) Vast XML, use the following example to format your VAST XML response. See the VAST Tag example below, Video Asset vasttag Example.

Note Exactly one of adm and curl is required. Including both is not recommended.

curl string

A URL that returns the video markup (e.g., VAST document) for the asset. If this ad is matched to a placement specification, the placement.curlx attribute indicates if this markup retrieval option is supported.

Note Exactly one of adm and curl is required. Including both is not recommended.

Native Asset Data Object

Native Asset Data Object Properties
Value Type Description
value string (Required) The formatted string of data to be displayed. Can contain a formatted value such as "5 stars" or "$10" or "3.4 stars out of 5".

Video Asset adm Example

<?xml version="1.0" encoding="UTF-8"?>
<VAST version="2.0">
   <Ad id="12345">
      <InLine>
         <AdSystem version="1.0">SpotXchange</AdSystem>
         <AdTitle><![CDATA[Sample VAST]]></AdTitle>
         <Impression>http://sample.com</Impression>
         <Description><![CDATA[A sample VAST feed]]></Description>
         <Creatives>
            <Creative sequence="1" id="1">
               <Linear>
                  <Duration>00:00:30</Duration>
                  <TrackingEvents />
                  <VideoClicks>
                     <ClickThrough><![CDATA[http://sample.com/openrt btest]]>
                     </ClickThrough>
                  </VideoClicks>
                  <MediaFiles>
                     <MediaFile delivery="progressive" bitrate="256"
                     width="640" height="480" type="video/mp4">
                     <![CDATA[http://sample.com/video.mp4]]>
                     </MediaFile>
                  </MediaFiles>
               </Linear>
            </Creative>
         </Creatives>
      </InLine>
   </Ad>
</VAST>