-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add mediaconsortium adapter documentation (#5546)
Co-authored-by: Maxime Lequain <[email protected]>
- Loading branch information
Showing
1 changed file
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: {} | ||
} | ||
] | ||
} | ||
]; | ||
``` |