Native Display

The request.item.spec.placement.display.nativefmt object defines a display placement to be specifically a native display placement. It serves as the root of a structure that includes the specifications for each of the assets that comprise the native placement.

Native Request Object
Value Type Description
asset array of objects An array of Asset Objects which specify the set of native assets and their permitted formats, see Native Asset Object

Native Asset Object

Native Asset Object Properties
Value Type Description
id integer (Required) Unique asset ID, for example 2
req integer Set to 1 if the asset is required, i.e. the exchange will not accept a bid without it, the default is 0.
title* object (Required) Native title object, see the Native Asset Title Object for more details.
img* object (Required) Native image object, see the Native Asset Image Object for more details.
video* object (Required) Native video object, see the Native Asset Video Object for more details.
data* object (Required) Native asset data object, see the Native Asset Data Object section for more details.

Note

(*) Exactly one of the fields marked with an asterisk is required in the asset object.

Native Asset Title Object

Native Asset Title Object
Value Type Description
len integer Maximum length of the text in the title element, for example, 25. Recommended lengths in the IAB Open RTB spec are 25, 90, or 140.

Native Asset Image Object

The image asset object may contain the exact image size, the minimum image size, or both. If only the exact image size is specified then the image in the bid response should have the corresponding size. If the minimum size is specified then the image asset in the bid response should comply with the following restrictions.

  • The size of the image should be equal to or larger than the minimum specified
  • The image asset in the bid response should contain the w and h fields.

Note

It is recommended that the aspect ratio of the image should be close to the one specified by the exact size or by the minimum size; the acceptable aspect ratio deviation is from \(0.8 * (w/h)\) to \(1.25 * (w/h)\)

Native Asset Image Object
Value Type Description
type* integer

Image asset type, for example 3. Takes the following values:

  • 1 An icon image. It must have a maximum height of at least 50 device independent pixels (DIPS) with an aspect ratio of 1:1.
  • 3 The main image preview for the ad. At least one of 2 size variants is required:
    • Large: It must have a maximum height of at least 627 DIPS, and a maximum width of at least 627, 836, or 1198 DIPS (i.e., aspect ratios of 1:1, 4:3, or 1.91:1, respectively).
    • Small: It must have a maximum height of at least 200 DIPS; and a maximum width at least 200, 267, or 382 DIPS (i.e., aspect ratios of 1:1, 4:3, or 1.91:1, respectively).
w* integer Width of the image in pixels, for example, 300
wmin* integer The minimum requested width of the image in pixels, for example, 100
h* integer Height of the image in pixels, for example, 250
hmin* integer The minimum requested height of the image in pixels, for example, 100
mime* array of strings Whitelist of content MIME types supported, for example, ["image/gif"]. If blank, assume all types are allowed.

Native Asset Video Object

Video Object Properties
Value Type Description
mime array of strings

(Required) Content MIME types supported.

Note: For Google bids all the specified MIME type media files are required in the VAST response, for example, ["video/mpeg", "video/mp4"]

ptype integer

Placement type for the impression, for example 2. This can take the following values:

  • 1: In-stream. Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll).
  • 2: In-banner. Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
  • 3: In-article. Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
  • 4: In-feed. Found in content, social, or product feeds.
  • 5: Interstitial/Slider/Floating. Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view).
pos integer

Ad Position as defined in OpenRTB, for example 1

  • 1 Above The Fold
  • 2 Locked (i.e., fixed position)
  • 3 Below The Fold
  • 4 Header
  • 5 Footer
  • 6 Sidebar
  • 7 Fullscreen
delay integer

Indicates the start delay in seconds. If the start delay value is greater than 0, then the position is mid-roll and the value indicates the start delay.

  • > 0: Mid-Roll (value indicates start delay in second)
  • 0: Pre-roll
  • -1: Generic mid-roll
  • -2: Generic post-roll
skip integer Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.
skipmin integer Videos of a total duration greater than this value (seconds) can be skippable; only applicable if the ad is skippable.
skipafter integer Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
playmethod array of integers

Allowed playback methods as defined in the OpenRTB, for example [1, 2]. If none are specified, it is assumed all are allowed.

  • 1 Initiates on Page Load with Sound On
  • 2 Initiates on Page Load with Sound Off by Default
  • 3 Initiates on Click with Sound On
  • 4 Initiates on Mouse-Over with Sound On
  • 5 Initiates on Entering Viewport with Sound On
  • 6 Initiates on Entering Viewport with Sound Off by Default
playend integer

The event that causes playback to end, for example 2. This field can take the following values:

  • 1: On Video Completion or when Terminated by User.
  • 2: On Leaving Viewport or when Terminated by User.
  • 3: On Leaving Viewport Continues as a Floating/Slider Unit until Video Completion or when Terminated by User.
api* array of integers

List of supported API frameworks for this impression as defined in OpenRTB, for example, [1,2]. If an API is not explicitly listed, it is assumed not to be supported.

  • 1 VPAID 1.0
  • 2 VPAID 2.0
  • 3 MRAID 1.0
  • 4 ORMMA
  • 5 MRAID 2.0
  • 6 MRAID 3.0
  • 7 OMID 1.0
ctype integers

Creative subtypes permitted.

  • 1 VAST 1.0
  • 2 VAST 2.0
  • 3 VAST 3.0
  • 4 VAST 1.0 Wrapper
  • 5 VAST 2.0 Wrapper
  • 6 VAST 3.0 Wrapper
  • 7 VAST 4.0
  • 8 VAST 4.0 Wrapper
  • 9 DAAST 1.0
  • 10 DAAST 1.0 Wrapper
  • 11 VAST 4.1
  • 12 VAST 4.1 Wrapper
w integer Width of the player in pixels, for example, 600
h integer Height of the player in pixels, for example 400
mindur integer Minimum video ad duration in seconds, for example, 2
maxdur integer Maximum video ad duration in seconds, for example, 15
minbitr integer Minimum bit rate in Kbps, for example 680
maxbitr integer Maximum bit rate in Kbps, for example 990
delivery array of integers

Supported delivery methods (e.g., streaming, progressive) as defined in OpenRTB. If none specified, assume all are supported, for example, [1, 2]

  • 1 Streaming
  • 2 Progressive
  • 3 Download
linear integer

Indicates if the impression must be linear or nonlinear, for example, 1. If none is specified, it is assumed all are allowed

  • 1: Linear/In-stream
  • 2: Non-Linear/Overlay
boxing integer

Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed:

  • 0 = no
  • 1 = yes.
comp object array Array of Banner objects if companion ads are available. See the Companion Ad section for more information.
comptype array of integers

List of allowed companion ad types, for example [1, 2] Possible values:

  • 1: Static Resource
  • 2: HTML Resource
  • 3: iframe Resource

Native Asset Data Object

Native Asset Data Object
Value Type Description
type integer

Data asset type as described in OpenRTB Native specification, for example, 1

  • 1 sponsored: “Sponsored By” message which should contain the brand name of the sponsor. Recommended maximum length of at least 25 characters.
  • 2 desc: Descriptive text associated with the product or service being advertised. Long text lengths may be truncated or ellipsed when rendered. Recommended maximum length of at least 140 characters.
  • 3 rating: Numeric rating of the product (e.g., an app’s rating). Recommended integer range of 0-5.
  • 4 likes: Number of social ratings or “likes” of the product.
  • 5 downloads: Number downloads and/or installs of the product.
  • 6 price: Price of the product, app, or in-app purchase. Value should include currency symbol in localized format (e.g., “$10”).
  • 7 saleprice: Sale price that can be used together with “price” to indicate a comparative discounted price. Value should include currency symbol in localized format (e.g., “$8.50”).
  • 8 phone: A formatted phone number.
  • 9 address: A formatted address.
  • 10 desc2: Additional descriptive text associated with the product.
  • 11 displayurl: Display URL for the ad. To be used when sponsoring entity doesn’t own the content (e.g., “Sponsored by Brand on Site”, where Site is specified in this data asset).
  • 12 ctatext: Description of the call to action (CTA) button for the destination URL. Recommended maximum length of at least 15 characters.
  • 500+ Vendor-specific codes.
len* integer The maximum allowed length of the data value, for example, 25