ORTB
中 / EN

Audio§3.2.8 · Bid Request

2.32.42.52.63.0Version Diff

This object represents an audio type impression. Many of the fields are non-essential for minimally viable transactions, but are included to offer fine control when needed. Audio in OpenRTB generally assumes compliance with the DAAST standard. As such, the notion of companion ads is supported by optionally including an array of Banner objects (refer to the Banner object in Section 3.2.6) that define these companion ads. The presence of a Audio as a subordinate of the Imp object indicates that this impression is offered as an audio type impression. At the publisher's discretion, that same impression may also be offered as banner, video, and/or native by also including as Imp subordinates objects of those types. However, any given bid for the impression must conform to one of the offered types.

AttributeTypeDescription
mimes
required
string[]Content MIME types supported (e.g., "audio/mp4").
minduration
integerMinimum audio ad duration in seconds.
maxduration
integerMaximum audio ad duration in seconds.
protocols
integer[]Array of supported audio protocols. Refer to List 5.8.
Enum Creative Subtypes - Audio/Video · 16 values
1VAST 1.0
2VAST 2.0
3VAST 3.0
4VAST 1.0 Wrapper
5VAST 2.0 Wrapper
6VAST 3.0 Wrapper
7VAST 4.0
8VAST 4.0 Wrapper
9DAAST 1.0
10DAAST 1.0 Wrapper
11VAST 4.1
12VAST 4.1 Wrapper
4 more values in the enumerations overview →
startdelay
integerIndicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to List 5.12.
Enum Start Delay Modes · 4 values
>0Mid-Roll (value indicates start delay in second)
0Pre-Roll
-1Generic Mid-Roll
-2Generic Post-Roll
sequence
integerIf multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
battr
integer[]Blocked creative attributes. Refer to List 5.3.
Enum Creative Attributes · 24 values
1Audio Ad (Autoplay)
2Audio Ad (User Initiated)
3Expandable (Automatic)
4Expandable (User Initiated - Click)
5Expandable (User Initiated - Rollover)
6In-Banner Video Ad (Autoplay)
7In-Banner Video Ad (User Initiated)
8Pop (e.g., Over, Under, or Upon Exit)
9Provocative or Suggestive Imagery
10Shaky, Flashing, Flickering, Extreme Animation, Smileys
11Surveys
12Text Only
12 more values in the enumerations overview →
maxextended
integerMaximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.
minbitrate
integerMinimum bit rate in Kbps.
maxbitrate
integerMaximum bit rate in Kbps.
delivery
integer[]Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. Refer to List 5.15.
Enum Delivery Methods · 3 values
1Streaming
2Progressive
3Download
companionad
object[]Array of Banner objects (Section 3.2.6) if companion ads are available.
api
integer[]List of supported API frameworks for this impression. Refer to List 5.6. If an API is not explicitly listed, it is assumed not to be supported.
Enum API Frameworks · 10 values
1VPAID 1.0
2VPAID 2.0
3MRAID 1.0
4ORMMA
5MRAID 2.0
6MRAID 3.0
7OMID 1.0
8SIMID 1.0
9SIMID 1.1
500+Vendor-specific codes.
companiontype
integer[]Supported DAAST companion ad types. Refer to List 5.14. Recommended if companion Banner objects are included via the companionad array.
Enum Companion Types · 3 values
1Static Resource
2HTML Resource
3iframe Resource
maxseq
integerThe maximum number of ads that can be played in an ad pod.
feed
integerType of audio feed. Refer to List 5.16.
Enum Feed Types · 8 values
1AOD Music streaming service
2LIVE FM/AM broadcast (live content broadcast over the air but also available via online streaming)
3AOD Podcast (original, pre-recorded content distributed as episodes in a series)
4AOD Catch-up radio (recorded segment of a radio show that was originally broadcast live)
5LIVE Web radio (live content only available via online streaming, not as AM/FM broadcast)
6MISC Video game (background audio in video games)
7MISC Text to speech (audio books, website plugin that can read article)
500+MISC Vendor-specific codes.
stitched
integerIndicates if the ad is stitched with audio content or delivered independently, where 0 = no, 1 = yes.
nvol
integerVolume normalization mode. Refer to List 5.17.
Enum Volume Normalization Modes · 5 values
0None
1Ad Volume Average Normalized to Content
2Ad Volume Peak Normalized to Content
3Ad Loudness Normalized to Content
4Custom Volume Normalization
ext
objectPlaceholder for exchange-specific extensions to OpenRTB.

Field descriptions reconciled against the official 2.6 draft; 2.5-specific fields come from a third-party Go implementation source (Apache 2.0), proofread against the official PDF · first-draft proofreading