Native Ad Format

InMobi supports IAB Dynamic Native Ads 1.2 specifications. For more information, see OpenRTB Dynamic Native Ads API (version 2.5).

Native Format Ad Request Markup details

OBJECT: Bidrequest.Imp.Native.Request

Attribute

Type

Description

ver

string; default 1; optional

Version of the Native Markup version in use.

plcmtcnt

integer; default 1; optional

The number of identical placements in this Layout.

Multiplacement bid requests are currently not supported. InMobi will return a maximum of one bid.

assets

object array; required

An array of Asset Objects. Any bid must comply with the array of elements expressed here.

seq

Integer; default 0; optional

xx (see the IAB Core Six layout types). 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.

plcmttype

Integer; recommended

The design/format/layout of the ad unit being offered. Refer IAB Dynamic Native Ads 1.2 specifications

eventtrackers

array of objects; optional

Specifies what type of event tracking is supported – see Event Trackers Request Object.

privacy

Integer; recommended

Set to 1 when the native ad supports buyer-specific privacy notice. The field is absent when the native ad doesn’t support custom privacy links or if support is unknown.

OBJECT: Bidrequest.Imp.Native.Request.Assets

This is the main container object for each asset requested or supported by Exchange on behalf of the rendering client. You must flag the object you require. Also, you must add only one of the {title,img,data} objects.

Attribute

Type

Description

id

Integer; required

Unique asset ID. Denotes the counter for the array.

required

integer; default 0; required

Set to 1 if the asset is required (The InMobi RTB Platform will not accept a bid without it)

title

object; optional; recommended

Title object for title assets. See Title Object definition below.

img

object; optional; recommended

Image object for image assets. See Image Object definition below.

video

Object; optional

Video object for video assets.

data

object; optional

Data object for ratings, prices, and so on. See the Data Object definition below.

OBJECT: Bidrequest.Imp.Native.Request.Assets.Title

You must use the Title object for the title element of the Native ad.

Attribute

Type

Description

len

Integer; required

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

OBJECT: Bidrequest.Imp.Native.Request.Assets.Image

You must use the Image object for all image elements of the Native ad such as Icons, Main Image, and so on.

Attribute

Type

Description

type

Integer; optional

Type ID of the image element supported by the publisher. The publisher can display this information in an appropriate format. Refer IAB Dynamic Native Ads 1.2 specifications

wmin

Integer; required

The minimum requested width of the image in pixels.

hmin

Integer; required

The minimum requested height of the image in pixels.

w

Integer; optional

Width in device independent pixels (DIPS)

h

Integer; optional

Height in device independent pixels (DIPS)

ext

Object; optional

Refer to Section 4.1.4.1 for Image Object Extension

OBJECT: Bidrequest.Imp.Native.Request.Assets.Video

Attribute

Type

Description

mimes

Required; Array of string

Content MIME types supported.

minduration

Required; integer

Minimum video ad duration in seconds

maxduration

Integer

Maximum video ad duration in seconds

protocols

Array of integers

An array of video protocols the publisher can accept in the bid response. For more information, see OpenRTB Dynamic Native Ads API (version 2.5).

OBJECT: Bidrequest.Imp.Native.Request.Assets.Data

You must use the  Data Object for all the non-core elements of the native unit such as Brand Name, Ratings, Review Count, Stars, Download count, descriptions, and so on.

Attribute

Type

Description

type

Integer; required

Type ID of the element supported by the publisher. The publisher can display this information in an appropriate format. Refer IAB Dynamic Native Ads 1.2 specifications

len

integer; optional

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

OBJECT: Event Tracker's Request

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

Attribute

Type

Description

event

Integer; required

Type of event available for tracking. See Event Types table. InMobi supports 1 = Impression tracking

methods

array of integers; required

Array of the types of tracking available for the given event. See Event Tracking Methods table. InMobi supports 1 = img pixel

Native Ad Response Markup Details

OBJECT: Bid.adm.native

The native object is the top-level JSON object which identifies a native response.
Note that bid.adm is a string field. The content of the adm field will be a JSON encoded string (stringified JSON).

Attribute

Type

Description

ver

integer; default 1; recommended

The version of the Native Markup version in use.

assets

object array; required

List of native ad’s assets.

link

object; required

Destination Link. This is the default link object for the ad.

eventtrackers

an array of objects; optional

An array of tracking objects to run with the ad, in response to the declared supported methods in the request.

privacy

String; optional

If support was indicated in the request, the URL of a page informing the user about the buyer’s targeting activity

OBJECT: Bid.adm.native.assets

Corresponds to the Asset Object in the request. The main container object for each asset requested or supported by Exchange on behalf of the rendering client. Any object that is required is to be flagged as such. Only one of the {title,img,data} objects should be present in each object. All others should be null/absent. The id is to be unique within the AssetObject array so that the response can be aligned.

Attribute

Type

Description

id

integer; required

Unique asset id assigned by the exchange.

required

Integer; default 0

Set to 1 if the asset is required (will not accept a bid without it).

title

Object; optional

Title object for title assets. See Title Object definition. (Section 5.1.2). Refer IAB Dynamic Native Ads 1.2 specifications

img

Object; optional

Image object for image assets. See Image Object definition (Section 5.1.3). Refer IAB Dynamic Native Ads 1.2 specifications

data

Object; optional

Data object for ratings, prices, and so on. See the Data Object definition (Section 6.7.5). Refer IAB Dynamic Native Ads 1.2 specifications

link

Object; optional

Refer to Section 5.1.6 Refer IAB Dynamic Native Ads 1.2 specifications

OBJECT: Bid.adm.native.assets.title

Corresponds to the Title Object in the request, with the value filled in.   

Attribute

Type

Description

text

string; required

The text to be placed in the text element.

OBJECT: Bid.adm.native.assets.img

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

Attribute

Type

Description

url

string; required

URL of the image asset.

w

integer; recommended

Width of the image in pixels.

h

integer; recommended

Height of the image in pixels.

OBJECT: Bid.adm.native.assets.data

Corresponds to the Data Object in the request, with the value filled in. The Data Object is to be used for all miscellaneous elements of the native unit such as Brand Name, Ratings, Review Count, Stars, Downloads, Price count etc. 

Attribute

Type

Description

label

String; optional

The optional formatted string name of the data type to be displayed.

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”.

OBJECT: Bid.adm.native.assets.link

This is used for ‘call to action’ assets, or other links from the Native ad.

Attribute

Type

Description

url

string; required

Landing URL of the clickable link.

clicktrackers

string array

List of third-party tracker URLs to be fired on click of the URL.

InMobi Click tracker should be inserted here

fallback

string

Fallback URL for deeplink. To be used if the URL given in the "url" property is not supported by the device.

OBJECT: EVENT TRACKER

This is where the InMobi impression beacon will be inserted

Attribute

Type

Description

event

Integer; required

Since InMobi impression tracker is a  1x1 img pixel, this is ‘1’ for InMobi impression counting. However, advertiser specific events can have other event types as well. Refer IAB Dynamic Native Ads 1.2 specifications

method

Integer; required

For impression counting, this will be ‘1’. Refer IAB Dynamic Native Ads 1.2 specifications

url

Text; optional

All event URLs will be present here.

On This Page

Last Updated on: 06 Sep, 2021