forked from prebid/prebid.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update OpenWeb Bidder Docs (prebid#5247)
* updated openweb bidder docs * Update openweb.md safeframes_ok as requested in the PR: prebid#5247 adding safeframes_ok: false --------- Co-authored-by: Alexander Plotnikov <[email protected]>
- Loading branch information
1 parent
03e8f88
commit 4d33d71
Showing
1 changed file
with
67 additions
and
47 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 |
|---|---|---|
|
|
@@ -2,70 +2,90 @@ | |
| layout: bidder | ||
| title: OpenWeb | ||
| description: Prebid OpenWeb Bidder Adapter | ||
| pbjs: true | ||
| biddercode: openweb | ||
| media_types: banner | ||
| tcfeu_supported: true | ||
| userIds: britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId | ||
| media_types: banner, video | ||
| multiformat_supported: will-bid-on-any | ||
| schain_supported: true | ||
| coppa_supported: true | ||
| tcfeu_supported: true | ||
| gpp_supported: true | ||
| gpp_sids: tcfeu, usstate_all, usp | ||
| usp_supported: true | ||
| safeframes_ok: true | ||
| prebid_member: true | ||
| pbjs: true | ||
| pbs: true | ||
| safeframes_ok: false | ||
| pbs: false | ||
| floors_supported: true | ||
| userIds: all | ||
| fpd_supported: true | ||
| gvl_id: 280 | ||
| sidebarType: 1 | ||
| --- | ||
|
|
||
| ### Prebid Server Notes | ||
|
|
||
| {% include dev-docs/pbjs-adapter-required-for-pbs.md %} | ||
| ### Note | ||
|
|
||
| ### Bid params | ||
| The OpenWeb adapter requires setup and approval. Please reach out to <[email protected]> to setup an OpenWeb account. | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
| | Name | Scope | Description | Example | Type | | ||
| |-------|----------|---------------------------------|----------|-----------| | ||
| | `aid` | required | The source ID from OpenWeb. | `650342` | `integer` | | ||
| ### Bid Parameters | ||
|
|
||
| ### Description | ||
| #### Banner, Video | ||
|
|
||
| OpenWeb.com official prebid adapter. Available in both client and server side versions. | ||
| OpenWeb header bidding adapter provides solution for accessing banner demand. | ||
| {: .table .table-bordered .table-striped } | ||
| | Name | Scope | Type | Description | Example | ||
| | ---- | ----- | ---- | ----------- | ------- | ||
| | `org` | required | String | OpenWeb publisher Id provided by your OpenWeb representative | "1234567890abcdef12345678" | ||
| | `floorPrice` | optional | Number | Minimum price in USD. <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 2.00 | ||
| | `placementId` | optional | String | A unique placement identifier | "12345678" | ||
| | `testMode` | optional | Boolean | This activates the test mode | false | ||
|
|
||
| ### Test Parameters | ||
| ## Example | ||
|
|
||
| ```javascript | ||
| var adUnits = [ | ||
| // Banner adUnit | ||
| { | ||
| mediaTypes: { | ||
| var adUnits = [{ | ||
| code: 'banner-div', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250]] | ||
| sizes: [ | ||
| [300, 250], | ||
| [728, 90] | ||
| ] | ||
| } | ||
| }, | ||
| code: 'div-test-div', | ||
| bids: [{ | ||
| bidder: 'openweb', | ||
| params: { | ||
| aid: 650342 | ||
| } | ||
| }] | ||
| }, | ||
| // Prebid server | ||
| { | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250]] | ||
| }, | ||
| bids: [{ | ||
| bidder: 'openweb', | ||
| params: { | ||
| org: '1234567890abcdef12345678', // Required | ||
| floorPrice: 0.05, // Optional | ||
| placementId: '12345678', // Optional | ||
| testMode: false // Optional | ||
| } | ||
| }] | ||
| }, | ||
| { | ||
| code: 'dfp-video-div', | ||
| sizes: [ | ||
| [640, 480] | ||
| ], | ||
| mediaTypes: { | ||
| video: { | ||
| playerSize: [ | ||
| [640, 480] | ||
| ], | ||
| context: 'instream' | ||
| } | ||
| }, | ||
| code: 'div-test-div', | ||
| bids: [{ | ||
| bidder: 'openweb', | ||
| params: { | ||
| aid: 650346 | ||
| } | ||
| }] | ||
| } | ||
| }, | ||
| bids: [{ | ||
| bidder: 'openweb', | ||
| params: { | ||
| org: '1234567890abcdef12345678', // Required | ||
| floorPrice: 5.00, // Optional | ||
| placementId: '12345678', // Optional | ||
| testMode: false // Optional | ||
| } | ||
| }] | ||
| } | ||
| ]; | ||
| ``` | ||
|
|
||
| ### Configuration | ||
|
|
||
| OpenWeb recommends setting UserSync by iframe for monetization. | ||