Skip to content
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.

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

New bidder Adapter - MediaConsortium #5546

Merged
Changes from all commits
Commits
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
74 changes: 74 additions & 0 deletions dev-docs/bidders/mediaConsortium.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
layout: bidder
title: Media Consortium
description: Prebid Media Consortium Bidder Adapter
biddercode: mediaConsortium
media_types: banner, video
pbjs: true
userId: all
multiformat_supported: will-bid-on-any
sidebarType: 1
---

MediaConsortium doesn't require inventory parameters - we'll match your inventory using a combination of ad unit code and domain.

### Prebid JS configuration

To get access to the full feature set of the adapter you'll need to allow localstorage usage in the `bidderSettings`.

```javascript
pbjs.bidderSettings = {
mediaConsortium: {
storageAllowed: true
}
}
```

MediaConsortium uses the [1plusX](https://www.1plusx.com/) user id (fpid) and profile API to retrieve audience and site specific segments. You can manage 1plusX usage with the settings outlined below.

#### Managing 1plusX profile API usage and fpid retrieval

You can use the `setBidderConfig` function to enable or disable 1plusX profile API usage and fpid retrieval.

If the keys found below are not defined, their values will default to `false`.

```javascript
pbjs.setBidderConfig({
bidders: ['mediaConsortium'],
config: {
// Controls the 1plusX profile API usage
useProfileApi: true,
// Controls the 1plusX fpid retrieval
readOnePlusXId: true
}
});
```

#### Required pbjs ad unit video parameters

| Name | Scope | Description | Example | Type |
|------------|----------|-------------------------------------------|----------------|----------------------|
| playerSize | required | Array of sizes accepted by the player | `[[300, 250]]` | `[number, number][]` |
| context | required | Video context, must always be `outstream` | `outstream` | `string` |

##### Example ad unit

```javascript
const adUnits = [
{
code: 'div-prebid-video',
mediaTypes:{
video: {
playerSize: [[300, 250]],
context: 'outstream'
}
},
bids:[
{
bidder: 'mediaConsortium',
params: {}
}
]
}
];
```