Native Response Object¶

Note

Fields marked with an asterisk (*) are optional.

Native Object Properties¶
Value	Type	Description
assets	array of objects	List of native ad assets.
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.
imptrackers **	array of strings	An array of impression tracking URLs, expected to return a 1x1 image or 204 response, for example, `["http://adserver.com/native?impid=102"]` Note: This field can contain the win price macro, see the Macros section for more details
ver*	string	Version of the Native Markup version in use, for example, `"1.2"`.
jstracker*	string	Optional JavaScript impression tracker. This should be valid HTML with JavaScript already wrapped in `<script>` tags. It will be executed at impression time where it can be supported. Note: This field can contain the win price macro, see the Macros section for more details
eventtrackers*	array of objects	Array of tracking objects to run with the ad, in response to the declared supported methods in the request. The link see Event Tracker Request Object for details.
privacy*	string	If support for this was indicated in the request, sets the URL of a page informing the user about the buyer’s targeting activity, e.g `https://www.example.com/privacy-notice`

Native Assets 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`.
required*	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 Assets Title Object below.
img*	object	Image object for an image asset, see Native Assets Image Object below.
video*	object	Video object for a video asset, see Native Asset Video Object below.
data*	object	Data object for a data asset, see Native Asset Data Object below.
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 below.

Native Assets Title Object¶

Native Asset Title Object Properties¶
Value	Type	Description
text*	string	The text associated with the title element. `"Our product is the best!"`

Native Assets 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
vasttag	string	Vast XML, use the following example to format your VAST XML response.

<?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>

Native Asset Data Object¶

Native Asset Data Object Properties¶
Value	Type	Description
value	string	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”`.

Native Link Object¶

Native Link Object Properties¶
Value	Type	Description
url	string	Landing URL of the clickable link, for example, `"http://advertiser.com/"`
clicktrackers*	array of strings	Click tracker URLs to be activated when the URL is clicked, for example, `["http://adserver.com/click?impid=102"]`

Native Response Example¶

{
  "seatbid":[
    {
      "bid":[
        {
          "adm_native":{
            "ver":"1.2",
            "jstracker":"<html></head><body></body><script src='./jquery.js'></script></html>",
            "link":{
              "url":"http://adserver.com/click?impid=102"
            },
            "imptrackers":[
              "http://adserver.com/native?impid=102"
            ],
            "assets":[
              {
                "id":1,
                "required":1,
                "title":{
                  "text":"A test Native Ad"
                }
              }
            ]
          }
        }
      ]
    }
  ]
}