From 267a8310b29f09954da017acdcc387d68b8469be Mon Sep 17 00:00:00 2001 From: bretg Date: Tue, 9 Mar 2021 16:46:12 -0500 Subject: [PATCH] Bidder params fix (#2767) * renaming files to match bidder codes * adding pbjs: true * adding aliases to edge case bidders * fixing aliasCode --- dev-docs/bidder-adaptor.md | 5 ++- .../bidders/{adastaMedia.md => adasta.md} | 0 dev-docs/bidders/{Advertly => advertly.md} | 2 +- dev-docs/bidders/{amx-rtb.md => amx.md} | 0 .../{automatadBidAdapter.md => automatad.md} | 0 dev-docs/bidders/{avocet.md => avct.md} | 1 + dev-docs/bidders/brainy.md | 34 +++++++++--------- dev-docs/bidders/brightroll.md | 2 +- dev-docs/bidders/districtmDMX.md | 36 +++++++++++++++++++ .../{evolution_tech.md => e_volution.md} | 0 .../{freewheel.md => freewheel-ssp.md} | 0 dev-docs/bidders/giants.md | 32 ++++++++--------- .../{glimpseProtocol.md => glimpse.md} | 0 dev-docs/bidders/{indexExchange.md => ix.md} | 0 .../bidders/{jcartermarketing.md => jcm.md} | 0 .../bidders/{nobidBidAdapter.md => nobid.md} | 0 ...{proxistoreBidAdapter.md => proxistore.md} | 34 +++++++++--------- dev-docs/bidders/{pubwise.md => pwbid.md} | 1 + dev-docs/bidders/pxyz.md | 1 - dev-docs/bidders/safereach.md | 16 +++++++++ dev-docs/bidders/{sekindo.md => sekindoUM.md} | 0 dev-docs/bidders/sharethrough.md | 23 ++++++------ .../{showheroes.md => showheroes-bs.md} | 0 .../bidders/{sspBCBidAdapter.md => sspBC.md} | 0 dev-docs/bidders/theAdx.md | 18 ++++++++++ dev-docs/bidders/tribeos.md | 18 ++++++++++ dev-docs/bidders/viewdeos.md | 15 -------- .../bidders/{waardexak.md => waardex_ak.md} | 0 dev-docs/bidders/{xaxis.md => xhb.md} | 0 .../bidders/{zetaGlobal.md => zeta_global.md} | 0 30 files changed, 157 insertions(+), 81 deletions(-) rename dev-docs/bidders/{adastaMedia.md => adasta.md} (100%) rename dev-docs/bidders/{Advertly => advertly.md} (98%) rename dev-docs/bidders/{amx-rtb.md => amx.md} (100%) rename dev-docs/bidders/{automatadBidAdapter.md => automatad.md} (100%) rename dev-docs/bidders/{avocet.md => avct.md} (98%) create mode 100644 dev-docs/bidders/districtmDMX.md rename dev-docs/bidders/{evolution_tech.md => e_volution.md} (100%) rename dev-docs/bidders/{freewheel.md => freewheel-ssp.md} (100%) rename dev-docs/bidders/{glimpseProtocol.md => glimpse.md} (100%) rename dev-docs/bidders/{indexExchange.md => ix.md} (100%) rename dev-docs/bidders/{jcartermarketing.md => jcm.md} (100%) rename dev-docs/bidders/{nobidBidAdapter.md => nobid.md} (100%) rename dev-docs/bidders/{proxistoreBidAdapter.md => proxistore.md} (97%) rename dev-docs/bidders/{pubwise.md => pwbid.md} (99%) create mode 100644 dev-docs/bidders/safereach.md rename dev-docs/bidders/{sekindo.md => sekindoUM.md} (100%) rename dev-docs/bidders/{showheroes.md => showheroes-bs.md} (100%) rename dev-docs/bidders/{sspBCBidAdapter.md => sspBC.md} (100%) create mode 100644 dev-docs/bidders/theAdx.md create mode 100644 dev-docs/bidders/tribeos.md delete mode 100644 dev-docs/bidders/viewdeos.md rename dev-docs/bidders/{waardexak.md => waardex_ak.md} (100%) rename dev-docs/bidders/{xaxis.md => xhb.md} (100%) rename dev-docs/bidders/{zetaGlobal.md => zeta_global.md} (100%) diff --git a/dev-docs/bidder-adaptor.md b/dev-docs/bidder-adaptor.md index b37781f78f..20075b7d98 100644 --- a/dev-docs/bidder-adaptor.md +++ b/dev-docs/bidder-adaptor.md @@ -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`. @@ -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 diff --git a/dev-docs/bidders/adastaMedia.md b/dev-docs/bidders/adasta.md similarity index 100% rename from dev-docs/bidders/adastaMedia.md rename to dev-docs/bidders/adasta.md diff --git a/dev-docs/bidders/Advertly b/dev-docs/bidders/advertly.md similarity index 98% rename from dev-docs/bidders/Advertly rename to dev-docs/bidders/advertly.md index 6d638e74e5..02b989c7d8 100644 --- a/dev-docs/bidders/Advertly +++ b/dev-docs/bidders/advertly.md @@ -2,7 +2,7 @@ layout: bidder title: advertly description: Prebid ADVERTLY Bidder Adapter - +pbjs: true biddercode: advertly --- diff --git a/dev-docs/bidders/amx-rtb.md b/dev-docs/bidders/amx.md similarity index 100% rename from dev-docs/bidders/amx-rtb.md rename to dev-docs/bidders/amx.md diff --git a/dev-docs/bidders/automatadBidAdapter.md b/dev-docs/bidders/automatad.md similarity index 100% rename from dev-docs/bidders/automatadBidAdapter.md rename to dev-docs/bidders/automatad.md diff --git a/dev-docs/bidders/avocet.md b/dev-docs/bidders/avct.md similarity index 98% rename from dev-docs/bidders/avocet.md rename to dev-docs/bidders/avct.md index 627314acd6..8d0e78147d 100644 --- a/dev-docs/bidders/avocet.md +++ b/dev-docs/bidders/avct.md @@ -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 diff --git a/dev-docs/bidders/brainy.md b/dev-docs/bidders/brainy.md index 6ff8e44545..39ee2f3be3 100644 --- a/dev-docs/bidders/brainy.md +++ b/dev-docs/bidders/brainy.md @@ -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` | diff --git a/dev-docs/bidders/brightroll.md b/dev-docs/bidders/brightroll.md index 05ec0795bc..9d306f3292 100644 --- a/dev-docs/bidders/brightroll.md +++ b/dev-docs/bidders/brightroll.md @@ -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 diff --git a/dev-docs/bidders/districtmDMX.md b/dev-docs/bidders/districtmDMX.md new file mode 100644 index 0000000000..6af35635eb --- /dev/null +++ b/dev-docs/bidders/districtmDMX.md @@ -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` | + diff --git a/dev-docs/bidders/evolution_tech.md b/dev-docs/bidders/e_volution.md similarity index 100% rename from dev-docs/bidders/evolution_tech.md rename to dev-docs/bidders/e_volution.md diff --git a/dev-docs/bidders/freewheel.md b/dev-docs/bidders/freewheel-ssp.md similarity index 100% rename from dev-docs/bidders/freewheel.md rename to dev-docs/bidders/freewheel-ssp.md diff --git a/dev-docs/bidders/giants.md b/dev-docs/bidders/giants.md index c51189b0d0..11dbdad564 100644 --- a/dev-docs/bidders/giants.md +++ b/dev-docs/bidders/giants.md @@ -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` | diff --git a/dev-docs/bidders/glimpseProtocol.md b/dev-docs/bidders/glimpse.md similarity index 100% rename from dev-docs/bidders/glimpseProtocol.md rename to dev-docs/bidders/glimpse.md diff --git a/dev-docs/bidders/indexExchange.md b/dev-docs/bidders/ix.md similarity index 100% rename from dev-docs/bidders/indexExchange.md rename to dev-docs/bidders/ix.md diff --git a/dev-docs/bidders/jcartermarketing.md b/dev-docs/bidders/jcm.md similarity index 100% rename from dev-docs/bidders/jcartermarketing.md rename to dev-docs/bidders/jcm.md diff --git a/dev-docs/bidders/nobidBidAdapter.md b/dev-docs/bidders/nobid.md similarity index 100% rename from dev-docs/bidders/nobidBidAdapter.md rename to dev-docs/bidders/nobid.md diff --git a/dev-docs/bidders/proxistoreBidAdapter.md b/dev-docs/bidders/proxistore.md similarity index 97% rename from dev-docs/bidders/proxistoreBidAdapter.md rename to dev-docs/bidders/proxistore.md index 800d3d27bd..172c18cc8b 100644 --- a/dev-docs/bidders/proxistoreBidAdapter.md +++ b/dev-docs/bidders/proxistore.md @@ -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` | diff --git a/dev-docs/bidders/pubwise.md b/dev-docs/bidders/pwbid.md similarity index 99% rename from dev-docs/bidders/pubwise.md rename to dev-docs/bidders/pwbid.md index 75c5d8e268..3929d5db04 100644 --- a/dev-docs/bidders/pubwise.md +++ b/dev-docs/bidders/pwbid.md @@ -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 diff --git a/dev-docs/bidders/pxyz.md b/dev-docs/bidders/pxyz.md index 5155e05408..3f35ab073a 100644 --- a/dev-docs/bidders/pxyz.md +++ b/dev-docs/bidders/pxyz.md @@ -7,7 +7,6 @@ usp_supported: true pbjs: true biddercode: pxyz prevBiddercode: playgroundxyz -aliasBiddercode: playgroundxyz --- ### Bid Params diff --git a/dev-docs/bidders/safereach.md b/dev-docs/bidders/safereach.md new file mode 100644 index 0000000000..1c2ff90c6b --- /dev/null +++ b/dev-docs/bidders/safereach.md @@ -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` | diff --git a/dev-docs/bidders/sekindo.md b/dev-docs/bidders/sekindoUM.md similarity index 100% rename from dev-docs/bidders/sekindo.md rename to dev-docs/bidders/sekindoUM.md diff --git a/dev-docs/bidders/sharethrough.md b/dev-docs/bidders/sharethrough.md index 4be3502df6..bbf1099d9e 100644 --- a/dev-docs/bidders/sharethrough.md +++ b/dev-docs/bidders/sharethrough.md @@ -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: diff --git a/dev-docs/bidders/showheroes.md b/dev-docs/bidders/showheroes-bs.md similarity index 100% rename from dev-docs/bidders/showheroes.md rename to dev-docs/bidders/showheroes-bs.md diff --git a/dev-docs/bidders/sspBCBidAdapter.md b/dev-docs/bidders/sspBC.md similarity index 100% rename from dev-docs/bidders/sspBCBidAdapter.md rename to dev-docs/bidders/sspBC.md diff --git a/dev-docs/bidders/theAdx.md b/dev-docs/bidders/theAdx.md new file mode 100644 index 0000000000..a45925ca7e --- /dev/null +++ b/dev-docs/bidders/theAdx.md @@ -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` | diff --git a/dev-docs/bidders/tribeos.md b/dev-docs/bidders/tribeos.md new file mode 100644 index 0000000000..1fb5d025d0 --- /dev/null +++ b/dev-docs/bidders/tribeos.md @@ -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` | diff --git a/dev-docs/bidders/viewdeos.md b/dev-docs/bidders/viewdeos.md deleted file mode 100644 index 9dbbe667db..0000000000 --- a/dev-docs/bidders/viewdeos.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: bidder -title: Viewdeos -description: Prebid Viewdeos Bidder Adaptor -pbjs: true -biddercode: viewdeosDX -media_types: banner, video ---- - -### Bid params - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|-------------------|----------|---------------------------------------------------------------|----------------------|----------| -| `supplyPartnerId` | required | ID of the supply partner | `'12345'` | `string` | diff --git a/dev-docs/bidders/waardexak.md b/dev-docs/bidders/waardex_ak.md similarity index 100% rename from dev-docs/bidders/waardexak.md rename to dev-docs/bidders/waardex_ak.md diff --git a/dev-docs/bidders/xaxis.md b/dev-docs/bidders/xhb.md similarity index 100% rename from dev-docs/bidders/xaxis.md rename to dev-docs/bidders/xhb.md diff --git a/dev-docs/bidders/zetaGlobal.md b/dev-docs/bidders/zeta_global.md similarity index 100% rename from dev-docs/bidders/zetaGlobal.md rename to dev-docs/bidders/zeta_global.md