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

Bidder params fix #2767

Merged
merged 4 commits into from
Mar 9, 2021
Merged
Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -1034,7 +1034,9 @@ registerBidder(spec);
- [Write unit tests](https://github.com/prebid/Prebid.js/blob/master/CONTRIBUTING.md)
- Create a docs pull request against [prebid.github.io](https://github.com/prebid/prebid.github.io)
- Fork the repo
- Copy a file in [dev-docs/bidders](https://github.com/prebid/prebid.github.io/tree/master/dev-docs/bidders) and modify. Add the following metadata to the header of your .md file:
- Copy a file in [dev-docs/bidders](https://github.com/prebid/prebid.github.io/tree/master/dev-docs/bidders) and name it to exactly the same as your biddercode. Add the following metadata to the header of your .md file:
- Add 'biddercode' and set it to the code that publishers should be using to reference your bidder in an AdUnit. This needs to be the same name as the docs file!
- Add 'aliasCode' if your biddercode is not the same name as your PBJS implementation file. e.g. if your biddercode is "ex", but the file in the PBJS repo is exampleBidAdapter.js, this value needs to be "example".
- Add `pbjs: true`. If you also have a [Prebid Server bid adapter](/prebid-server/developers/add-new-bidder-go.html), add `pbs: true`. Default is false for both.
- If you support the GDPR consentManagement module and TCF1, add `gdpr_supported: true`. Default is false.
- If you're on the IAB Global Vendor List, add your ID number in `gvl_id`.
Expand All @@ -1057,6 +1059,7 @@ layout: bidder
title: example
description: Prebid example Bidder Adapter
biddercode: example
aliasCode: fileContainingPBJSAdapterCodeIfDifferentThenBidderCode
gdpr_supported: true/false
tcf2_supported: true/false
gvl_id: 111
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion dev-docs/bidders/Advertly → dev-docs/bidders/advertly.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: bidder
title: advertly
description: Prebid ADVERTLY Bidder Adapter

pbjs: true
biddercode: advertly
---

Expand Down
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions dev-docs/bidders/avocet.md → dev-docs/bidders/avct.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Prebid Avocet Bidder Adapter
pbjs: true
pbs: true
biddercode: avct
aliasCode: avocet
gdpr_supported: true
media_types: banner, video
schain_supported: true
Expand Down
34 changes: 17 additions & 17 deletions dev-docs/bidders/brainy.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: bidder
title: brainy
description: Prebid brainy Bidder Adaptor
pbjs: true
biddercode: brainy
---
### Bid Params
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|----------------------------|---------|----------|
| `accountID` | required | `accountID of the ad unit` | | `string` |
| `slotID` | required | `slotID of the ad unit` | | `string` |
| `width` | required | `width of ad slot` | | `string` |
| `height` | required | `height of ad slot` | | `string` |
---
layout: bidder
title: brainy
description: Prebid brainy Bidder Adaptor
pbjs: true
biddercode: brainy
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|----------------------------|---------|----------|
| `accountID` | required | `accountID of the ad unit` | | `string` |
| `slotID` | required | `slotID of the ad unit` | | `string` |
| `width` | required | `width of ad slot` | | `string` |
| `height` | required | `height of ad slot` | | `string` |
2 changes: 1 addition & 1 deletion dev-docs/bidders/brightroll.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Brightroll
description: Prebid Brightroll(Verizon Media) S2S Bidder Adaptor
pbs: true
media_types: display, video
biddercode: Brightroll
biddercode: brightroll
prebid_member: true
gdpr_supported: true
tcf2_supported: true
Expand Down
36 changes: 36 additions & 0 deletions dev-docs/bidders/districtmDMX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: bidder
title: DistrictmDMX
description: Prebid DistrictmDMX Bidder Adaptor
pbjs: true
biddercode: districtmDMX
gdpr_supported: true
schain_supported: true
getFloor: true
usp_supported: true
coppa_supported: true
userIds: britepoolId, criteo, id5Id, identityLink, intentiq, liveIntentId, netId, parrableId, pubCommonId, unifiedId
---



### Bid Params

##### Prebid version 1.0 and above.

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|---------------------|------------------|-----------|
| `dmxid` | required | Placement Id | `100001` | `integer` |
| `memberid` | required | Account id | `100003` | `integer` |

##### Prebid 0.34~ legacy

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|-------------------------|------------------|-----------|
| `id` | required | Placement ID | `123456789` | `integer` |
| `floor` | optional | Bid floor price | `"1.00"` | `string` |
| `revShare` | optional | Publisher Revenue Share | `"0.85"` | `string` |
| `currency` | optional | Currency code | `"usd"` | `string` |

File renamed without changes.
File renamed without changes.
32 changes: 16 additions & 16 deletions dev-docs/bidders/giants.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
layout: bidder
title: IPAX
description: Prebid IPAX Bidder Adaptor
pbjs: true
biddercode: giants
media_types: video
---
### Bid Params
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------|----------|-------------|--------------|-----------|
| `zoneId` | required | Zone ID | `584072408` | `integer` |
---
layout: bidder
title: IPAX
description: Prebid IPAX Bidder Adaptor
pbjs: true
biddercode: giants
media_types: video
---

### Bid Params

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
|----------|----------|-------------|--------------|-----------|
| `zoneId` | required | Zone ID | `584072408` | `integer` |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: bidder
title: Proxistore
description: Prebid Proxistore Bidder Adapter
pbjs: true
biddercode: proxistore
gdpr_supported: true
---
### Bid Params
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------------------------------------------------------------------------------------------------------|------------|----------|
| `website` | required | Publisher referrer | `'example.com'` | `string` |
| `language` | required | Publisher language for the advertisement | `'fr'` | `string` |
---
layout: bidder
title: Proxistore
description: Prebid Proxistore Bidder Adapter
pbjs: true
biddercode: proxistore
gdpr_supported: true
---


### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------------------------------------------------------------------------------------------------------|------------|----------|
| `website` | required | Publisher referrer | `'example.com'` | `string` |
| `language` | required | Publisher language for the advertisement | `'fr'` | `string` |
1 change: 1 addition & 0 deletions dev-docs/bidders/pubwise.md → dev-docs/bidders/pwbid.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: PubWise
description: PubWise Bidder Adaptor
pbjs: true
biddercode: pwbid
aliasCode: pubwise
media_types: banner, native
gdpr_supported: true
usp_supported: true
Expand Down
1 change: 0 additions & 1 deletion dev-docs/bidders/pxyz.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ usp_supported: true
pbjs: true
biddercode: pxyz
prevBiddercode: playgroundxyz
aliasBiddercode: playgroundxyz
---

### Bid Params
Expand Down
16 changes: 16 additions & 0 deletions dev-docs/bidders/safereach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
layout: bidder
title: SafeReach
description: Prebid Safe Reach Bidder Adaptor
pbjs: true
biddercode: safereach
aliasCode : aardvark
---

### bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------|----------|--------------------|----------|----------|
| `ai` | required | The auction ID | `'XBC1'` | `string` |
| `sc` | required | The adshortcode | `'AF2g'` | `string` |
File renamed without changes.
23 changes: 11 additions & 12 deletions dev-docs/bidders/sharethrough.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
---
biddercode : sharethrough
description : Prebid Sharethrough Adaptor
gdpr_supported : true
hide : true
layout : bidder
media_types : native
layout: bidder
title: Sharethrough
biddercode: sharethrough
description: Prebid Sharethrough Adaptor
gdpr_supported: true
media_types: native
schain_supported: true
tcf2_supported : true
title : Sharethrough
userIds : pubCommonId, unifiedId, identityLink, id5Id, sharedId, liveIntentId
usp_supported : true
pbjs : true
pbs : true
tcf2_supported: true
userIds: pubCommonId, unifiedId, identityLink, id5Id, sharedId, liveIntentId
usp_supported: true
pbjs: true
pbs: true
---

### Note:
Expand Down
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions dev-docs/bidders/theAdx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: bidder
title: TheAdx
description: Prebid TheAdx Bidder Adapter
pbjs: true
biddercode: theAdx
gdpr_supported: false
---


### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|-----------------------------------------------------------------------|------------|-------|
| `pid` | required | Publisher GUID from TheAdx.com | `'1000'` | `int` |
| `wid` | required | Web Site ID from TheAdx.com | `'2000'` | `int` |
| `tagId` | required | Tag ID from TheAdx.com | `'3000'` | `int` |
18 changes: 18 additions & 0 deletions dev-docs/bidders/tribeos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: bidder
title: tribeOS
description: Prebid tribeOS Bidder Adapter
pbjs: true
biddercode: tribeos
---

### Note

Please contact your account manager before using this adapter.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|------------------|------------------------------------------|-------------------|
| `placementId` | required | tribeOS's placement id | `'3gl2jk225'` | `string` |
15 changes: 0 additions & 15 deletions dev-docs/bidders/viewdeos.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.