Page tree


Note: For native ad request, ensure that you send all the parameters only in HTTP POST.

All the following parameters' values should be URI encoded.

           

ParameterMandatoryDescription
nativeYesNative object in JSON format

Native Markup Request Object

The Native object defines the native advertising opportunity available for bid via this bid request.

                                           

ParameterMandatoryDescription
verNo

Version of the Native Markup version in use.
Default value: 1

layoutNo but recommendedLayout ID of the native ad unit. For more information, refer the Native Layout IDs table.
adunitNo but recommendedAd unit ID of the native ad unit. This corresponds to one of IAB Core's native ad units. For more information, refer the Native Ad Unit IDs table.
plcmtcntNo

The number of identical placements in this Format ID. If this optional parameter is present and greater than 1, then the implication is that the bidder is submitting bids to a Generalized Second Price auction where multiple identical placements are being offered in the same content feed or stream.
Default value: 1

seqNo

Sequence number of the native ad unit. For more information, refer the Native Layout IDs table.
0 for the first ad, 1 for the second ad, and so on. This is not the sequence number of the content in the stream.
Default value: 0

assetsYesAn array of Asset Objects. Any bid must comply with the array of elements expressed by the Exchange.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Asset Object

This is the main container object for each asset requested.

                                           

ParameterMandatoryDescription
idYesUnique asset ID, assigned by exchange. Typically a counter for the array.
requiredNo

Set to 1 if asset is required (exchange will not accept a bid without it)
Default value: 0

titleNoTitle object for title assets. Refer to the Title Object definition.
imgNoImage object for image assets. Refer to the Image Object definition.
videoNoVideo object for video assets. Refer to the Video request object definition.  Note that in-stream video ads are not part of Native. Native ads may contain a video as the ad creative itself.
dataNoData object for ratings, prices etc.  Refer to the Data Object definition.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Title Object

The Title object is to be used for the title element of the Native ad.

                

ParameterMandatoryDescription
lenYesMaximum length of the text in the title element.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Image Object

The Image object to be used for all the image elements of the Native ad such as Icons, Main Image, etc.

                                           

ParameterMandatoryDescription
typeNoType ID of the image element supported by the publisher. The publisher can display this information in an appropriate format. For more information, refer the Image Asset Types table.
wNoWidth of the image in pixels.
wminNo but recommendedThe minimum requested width of the image in pixels.  This option should be used for any rescaling of images by the client.  Either w or wmin should be transmitted. If w is included it should be considered an exact requirement.
hNoHeight of the image in pixels.
hminNo but recommendedThe minimum requested height of the image in pixels.  This option should be used for any rescaling of images by the client. Either h or hmin should be transmitted. If hmin is included it should be considered an exact requirement.
mimesNoWhitelist of content MIME types supported. Popular MIME types include, but are not limited to image/jpg & image/gif. Each implementing Exchange should have their own list of supported types in the integration docs.  Refer to the Wikipedia's MIME page for more information and links to all IETF RFCs. If blank, assume all types are allowed.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Video Object

The video object is to be used for all the video elements supported in the Native Ad.

                               

ParameterMandatoryDescription
mimesYesContent MIME types supported. Popular MIME types include, but are not limited to "video/x-ms-wmv" for Windows Media, and "video/x-flv" for Flash Video.
mindurationYesMinimum video ad duration in seconds.
maxdurationYesMaximum video ad duration in seconds.
protocolsYesAn array of video protocols the publisher can accept in the bid response.  Refer to the OpenRTB 2.3 Table 6.7 Video Bid Response Protocols for a list of possible values.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Data Object

The Data Object is to be used for all non-core elements of the native unit such as Ratings, Review Count, Stars, Download count, descriptions etc.

                       

ParameterMandatoryDescription
typeYesType ID of the element supported by the publisher. The publisher can display this information in an appropriate format.  For more information, refer the Data Asset Types table.
lenNoMaximum length of the text in the element's response.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Native Ad Bid Response Markup

           

ParameterMandatoryDescription
nativeYesNative object in JSON format

Native Object

The response is a JSON string with the following attributes:

                                    

ParameterMandatoryDescription
verNo

Version of Native Markup being used.
Default value: 1

assetsYesList of native ad's assets.
linkYesDestination Link. Refer to the Link Object definition
imptrackers[]NoArray of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers.
jstrackerNoOptional JavaScript impression tracker. Contains <script> tags to be executed at impression time where it can be supported
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Asset Object

This object corresponds to the Asset Object in the request.

                                                

ParameterMandatoryDescription
idYesUnique asset ID, assigned by exchange, must match one of the asset IDs in request
reqNo

Set to 1 if asset is required. (bidder requires it to be displayed).
Default value: 0

titleNoTitle object for title assets. Refer to the Title Object definition.
imgNoImage object for image assets. Refer to the Image Object definition.
videoNoVideo object for video assets. Refer to the Video object definition.  Note that in-stream video ads are not part of Native. Native ads may contain a video as the ad creative itself.
dataNoValue object for ratings, prices etc.
linkNoLink object for call to actions. This field is to be associated to the other populated field within the object.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Title Object

This object corresponds to the Title Object in the request updated with the values.

                

ParameterMandatoryDescription
textYesThe text associated with the text element.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Image Object

This object corresponds to the Image Object in the request. The Image object is to be used for all image elements of the Native ad such as Icons, Main Image, etc.

                          

ParameterMandatoryDescription
urlYesURL of the image asset.
wNo, but recommendedWidth of the image in pixels.
hNo, but recommendedHeight of the image in pixels.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Data Object

This object corresponds to the Data Object in the request updated with the values. The Data Object is to be used for all miscellaneous elements of the native unit such as Ratings, Review Count, Stars, Downloads, Price count etc.

                       

ParameterMandatoryDescription
labelNoThe optional formatted string name of the data type to be displayed.
valueYesThe 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."
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Video Object

This object corresponds to the Video Object in the request, containing a value of a conforming VAST tag as a value.

           

ParameterMandatoryDescription
vasttagYesVAST XML

Link Object

This object is used for "call to action" assets or other links from the Native ad. This Object should be associated to its peer object in the parent Asset Object. When that peer object is activated (clicked), the action should take the user to the location of the link.

                          

ParameterMandatoryDescription
urlYesLanding URL of the clickable link.
clicktrackers[]NoList of third-party tracker URLs to be fired on click of the URL.
fallbackNoFallback URL for deeplink. To be (URL) used if the URL given in clk is not supported by the device.
extNoThis object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification