List of supported OpenRTB bid request fields for native ads for DSPs (Beta)

Index Exchange (Index) sends Native bid requests to DSPs who support the Native ad format. The request must conform to the OpenRTB Dynamic Native Ads API Specification Version 1.2 which defines the request parameters markup structure of Native ad units.

Request object

The native.request object defines the native advertising opportunity available for a bid through this bid request. It is included directly in the impression object if the impression offered for the auction is a native ad format.

Field Type Description

ver

String; optional

The version of the native markup in use.

layout

Integer; optional

The layout ID of the native ad unit. For more information about the supported layout IDs, see List of references for native ads (Beta).
Note: This field was deprecated in Native ads API specification version 1.1.
adunit Integer; optional The ad unit ID of the native ad unit. For more information about the supported ad unit IDs, see List of references for native ads (Beta).
Note: This field was deprecated in Native ads API specification version 1.1.
context Integer; optional The context in which the ad appears. For more information about the supported context type IDs, see List of references for native ads (Beta).
contextsubtype Integer; optional A more detailed context in which the ad appears. For more information about the supported context subtype IDs, see List of references for native ads (Beta).
plcmttype Integer; optional The design, format, and layout of the ad unit being offered. For more information about the supported placement type IDs, see List of references for native ads (Beta).
plcmtcnt Integer; optional The number of identical placements in this layout.
seq

Integer; optional

Specifies the ad layout sequence, where 0 is the first ad, 1 is the second ad, and so on.

Note: This field is generally not used in combination with plcmtcnt. This would indicate that you are auctioning multiple identical placements (plcmtcnt > 1, seq = 0) or you are holding separate auctions for distinct items in the feed (plcmtcnt = 1, seq >= 1).

assets Object array; required An array of asset objects. Any bid must comply with the array of elements expressed in the bid request.
aurlsupport Integer; optional Specifies whether the supply source supports returning an assetsurl instead of an asset object; where 0 or the absence of the field indicates no support.
durlsupport Integer; optional Specifies whether the supply source supports returning a dco url instead of an asset object; where 0 or the absence of the field indicates no support.
eventtrackers Object array; optional Specifies the type of event tracking supported.
privacy Integer; optional

Specifies whether the native ad supports privacy; where:

  • 1 = the native ad supports buyer-specific privacy notice.
  • 0 = the native ad does not support custom privacy links or support is unknown.

Assets request object

This is the main container object for each asset requested or supported on behalf of the rendering client. Only one of the {title,img,video,data} objects should be present in each object. All others should be null or absent. The id must be unique within the asset array so that the response can be aligned.

Field Type Description

id

Integer; required

Unique asset ID for the request. Typically, a counter for the array.

required

Integer; optional

Specifies whether the asset is required to be present in the bid response; where:

  • 1 = asset is required to be present in the bid response
  • 0 = asset is not required to be present in the bid response
title Object; optional The title object for title assets.
img Object; optional The image object for image assets.
video Object; optional The video object for video assets.
data Object; optional The data object for ratings and prices.

Title request object

Use the title object for the title element of the native ad.

Field Type Description

len

Integer; required

The maximum length of the text in the title element. Recommended values are 25, 90, or 140.

Image request object

Use the img object for all of the image elements of the native ad such as icons or main image.

Field Type Description

type

Integer; optional

The type ID of the image element that is supported by the publisher. The publisher can display this information in an appropriate format. For more information about the supported image asset types, see List of references for native ads (Beta).

w

Integer; optional

The width of the image in pixels.
h Object; optional The height of the image in pixels.
wmin Object; optional The 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 only w is included, it should be considered an exact requirement.
hmin Object; optional The 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 only h is included, it should be considered an exact requirement.
mimes String array; optional Allowed list of content MIME types supported. If blank, assume all types are allowed.

Video object

Use the video object for all video elements supported in the native ad. This corresponds to the OpenRTB video object. The following table lists the required attributes of the video object for native ads. For more information about the optional attributes, see the OpenRTB Specification (version 2.5).

Field Type Description
mimes String array; required The content MIME types supported.

minduration

Integer; required

The minimum video ad duration in seconds.

maxduration

Integer; required

The maximum video ad duration in seconds.
protocols Integer array; required

An array of supported video protocols. At least one supported protocol must be specified, where:

  • 2 = VAST 2.0
  • 3 = VAST 3.0
  • 5 = VAST 2.0 wrapper
  • 6 = VAST 3.0 wrapper

Data request object

Use the data object for all non-core elements of the native unit such as ratings, review count, stars, download count, and descriptions. It is also generic for future native ad elements.

Field Type Description

type

Integer; required

The type ID of the element supported by the publisher. The publisher can display this information in an appropriate format. For more information about the supported data asset types, see List of references for native ads (Beta).

len

Integer; optional

The maximum length of the text in the element's response.

Event trackers request object

The eventtrackers object specifies the type of events the bidder can request to be tracked in the bid response and specifies which types of tracking are available for each event type. It is included as an array in the request.

Field Type Description

event

Integer; required

The type of event available for tracking. For more information about the supported event types, see List of references for native ads (Beta).

methods

Integer array; required

An array of the types of tracking available for a given event. For more information about the supported event tracking methods, see List of references for native ads (Beta).