Skip to content

Add audio mediaType #6183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
muuki88 merged 5 commits into from
Oct 15, 2025
Merged

Add audio mediaType #6183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab67bbc
Add audio mediaType
Jul 30, 2025
9c9d3e0
Update dev-docs/adunit-reference.md
mkomorski Oct 1, 2025
d0e0409
Update dev-docs/adunit-reference.md
muuki88 Oct 2, 2025
072225e
Update dev-docs/adunit-reference.md
mkomorski Oct 13, 2025
146c3ef
missing link
Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion dev-docs/adunit-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebarType: 1

The ad unit object is where you configure what kinds of ads you will show in a given ad slot on your page, including:

* Allowed media types (e.g., banner, native, and/or video)
* Allowed media types (e.g., banner, native, video and/or audio)
* Allowed sizes
* AdUnit-specific first party data

Expand Down Expand Up @@ -74,6 +74,7 @@ See the table below for the list of properties in the `mediaTypes` object of the
| [`banner`](#adUnit.mediaTypes.banner) | At least one of the `banner`, `native`, or `video` objects are required. | Object | Defines properties of a banner ad. For examples, see [`adUnit.mediaTypes.banner`](#adUnit.mediaTypes.banner). |
| [`native`](#adUnit.mediaTypes.native) | At least one of the `banner`, `native`, or `video` objects are required. | Object | Defines properties of a native ad. For properties, see [`adUnit.mediaTypes.native`](#adUnit.mediaTypes.native). |
| [`video`](#adUnit.mediaTypes.video) | At least one of the `banner`, `native`, or `video` objects are required. | Object | Defines properties of a video ad. For examples, see [`adUnit.mediaTypes.video`](#adUnit.mediaTypes.video). |
| [`audio`](#adUnit.mediaTypes.audio) | At least one of the `banner`, `native`, `video` or `audio` objects are required. | Object | Defines properties of a audio ad. For examples, see [`adUnit.mediaTypes.audio`](#adUnit.mediaTypes.audio). |

<a name="adUnit.mediaTypes.banner"></a>

Expand Down Expand Up @@ -160,6 +161,27 @@ When using the Video Module, the mediaTypes.video properties get filled out auto
| `adServer.baseAdTagUrl` | required if `adServer.params` is not defined | string | Your AdServer Ad Tag. The targeting params of the winning bid will be appended. |
| `adServer.params` | required if `adServer.baseAdTagUrl` is not defined | object | Querystring parameters that will be used to construct the video ad tag URL. |

<a name="adUnit.mediaTypes.audio"></a>

#### adUnit.mediaTypes.audio

{: .table .table-bordered .table-striped }
| Name | Scope | Type | Description |
|------------------+-------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `context` | Recommended | String | The audio context. Defaults to 'instream'. |
| `useCacheKey` | Optional | Boolean | Defaults to `false`. If set to `true`, the cache url defined in the global options will also be used for outstream responses. |
| `api` | Recommended | Array[Integer] | List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. For list, see [OpenRTB 2.5 spec][openRTB]. If your player supports [Open Measurement][OpenMeasurement], **recommended** to set `7` for OMID-1|
| `mimes` | Recommended | Array[String] | Content MIME types supported, e.g. `"audio/mp3"`. **Required by OpenRTB when using [Prebid Server][pbServer]**. |
| `minduration` | Recommended | Integer | Minimum audio ad duration in seconds, see [OpenRTB 2.5 spec][openRTB]. |
| `maxduration` | Recommended | Integer | Maximum audio ad duration in seconds, see [OpenRTB 2.5 spec][openRTB]. |
| `startdelay` | Recommended | Integer | Indicates the start delay in seconds, see [OpenRTB 2.5 spec][openRTB]. |
| `minbitrate` | Optional | Integer | Minimum bit rate in Kbps., see [OpenRTB 2.5 spec][openRTB]. |
| `maxbitrate` | Optional | Integer | Maximum bit rate in Kbps., see [OpenRTB 2.5 spec][openRTB]. |
| `delivery` | Optional | Array[Integer] | Supported delivery methods (e.g., streaming, progressive), see [OpenRTB 2.5 spec][openRTB]. |
| `companionad` | Optional | Array[Object] | Array of Banner objects (Section 3.2.6) if companion ads are available, see [OpenRTB 2.5 spec][openRTB]. |
| `feed` | Optional | Integer | Type of audio feed, see [OpenRTB 2.5 spec][openRTB]. |
| `nvol` | Optional | Integer | Volume normalization mode, see [OpenRTB 2.5 spec][openRTB]. |

## Examples

* [Banner](#adUnit-banner-example)
Expand Down
4 changes: 2 additions & 2 deletions dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ A high level example of the structure:
import * as utils from 'src/utils';
import { registerBidder } from 'src/adapters/bidderFactory';
import { config } from 'src/config';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.ts';
import {BANNER, VIDEO, NATIVE, AUDIO} from 'src/mediaTypes.ts';
const BIDDER_CODE = 'example';
export const spec = {
code: BIDDER_CODE,
Expand All @@ -238,7 +238,7 @@ export const spec = {
onSetTargeting: function(bid) {},
onBidderError: function({ error, bidderRequest }) {},
onAdRenderSucceeded: function(bid) {},
supportedMediaTypes: [BANNER, VIDEO, NATIVE]
supportedMediaTypes: [BANNER, VIDEO, NATIVE, AUDIO]
}
registerBidder(spec);

Expand Down