Audio Object¶
Note
Fields marked with an asterisk (*) are optional.
Value |
Type |
Description |
---|---|---|
mimes |
array of strings |
(Required) Content MIME types supported, for example
|
minduration |
integer |
(Recommended) Minimum audio ad duration in seconds. This field is mutually
exclusive with |
maxduration |
integer |
(Recommended) Maximum audio ad duration in seconds. This field is mutually
exclusive with |
poddur* |
integer |
(Recommended) Indicates the total amount of time that advertisers may fill for a dynamic audio ad pod, or the dynamic portion of a hybrid ad pod. This field is required only for the dynamic portion(s) of audio ad pods. This field refers to the length of the entire ad break, whereas minduration, maxduration, and rqddurs are constraints relating to the slots that make up the pod. |
protocols |
array of integers |
(Recommended) Accepted audio bid response protocols as defined in OpenRTB,
for example
|
startdelay* |
integer |
(Recommended) Indicates the start delay in seconds e.g.
|
rqddurs* |
array of integer |
Precise acceptable durations for audio creatives in seconds, e.g. |
podid* |
integer |
Unique identifier indicating that an impression opportunity belongs to an audio
ad pod. If multiple impression opportunities within a bid request share the same
|
podseq* |
integer |
The sequence (position) of the audio ad pod within a content stream, the default value is 0. For the most up to date list, see the IAB Adcom spec
|
sequence* |
integer |
DEPRECATED If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives. |
slotinpod* |
integer |
For audio ad pods, this value indicates that the seller can guarantee delivery against the indicated sequence. For the most up to date list, see the IAB Adcom spec
|
mincpmpersec* |
float |
Minimum CPM per second. This is a price floor for the dynamic portion of an audio ad pod, relative to the duration of bids an advertiser may submit. The |
battr* |
array of integers |
Blocked creative attributes as defined in OpenRTB,
for example, |
minbitrate* |
integer |
Minimum bit rate in Kbps, for example |
maxbitrate* |
integer |
Maximum bit rate in Kbps, for example |
api* |
array of integers |
List of supported API frameworks for this impression as defined in the
OpenRTB guide, for example, |
maxextended* |
integer |
Maximum extended audio ad duration if extension is allowed.
|
delivery* |
array of integers |
Supported delivery methods (e.g., streaming, progressive) as defined
in OpenRTB. If none specified, assume all are supported,
for example, |
maxseq* |
integer |
The maximum number of ads that can be played in an ad pod,
for example, |
feed* |
integer |
Type of audio feed, e.g.
|
sequence* |
integer |
If multiple ad impressions are offered in the same bid request,
the sequence number will allow for the coordinated delivery of
multiple creatives, for example, |
stitched* |
integer |
Indicates if the ad is stitched with audio content or delivered
independently, for example, |
nvol* |
integer |
Volume normalization mode as defined in OpenRTB, for example, |
companionad* |
array of objects |
Array of Banner objects if companion ads are available. See the Banner Object section for more information. |
companiontype* |
array of integers |
Supported DAAST companion ad types, for example
|
ext* |
object |
Audio extension object |
Extension Object¶
Value |
Type |
Description |
---|---|---|
format |
int |
Specifies in which field BidSwitch expects the creative URL to be placed in the bid response. This field exists due to how some Suppliers handle audio as audio and others handle it like video. Takes the following values.
|
Audio Object Example¶
{
"id":"1",
"bidfloor":0.03,
"audio":{
"startdelay":0,
"rqddurs":[
20,
20,
20
],
"poddur":60,
"podid":1,
"mincpmpersec":0.5,
"minbitrate":300,
"maxbitrate":1500,
"api":[
1,
2
],
"protocols":[
9,
10
],
"mimes":[
"audio/aac",
"audio/mp4",
"audio/mpeg"
],
"delivery":[
2
],
"btype":[
4,
21
],
"battr":[
13,
14
],
"companionad":[
{
"id":"1234567893-1",
"w":300,
"h":250,
"pos":1,
"battr":[
13,
14
]
},
{
"id":"1234567893-2",
"w":728,
"h":90,
"pos":1,
"battr":[
13,
14
]
}
],
"companiontype":[
1,
2
]
}
}