Prebid 7: update docs for allowAlternateBidderCodes and related fie…

…lds (#3762) * Prebid 7: update docs for `allowAlternateBidderCodes` and related fields PBJS PR: prebid/Prebid.js#8373 * Reintroduce 6.x - 7.x difference in default for `allowAlternateBidderCodes`
prebid · Jun 17, 2022 · 32177c0 · 32177c0
1 parent 57e08b6
commit 32177c0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 6 deletions.
diff --git a/dev-docs/bidder-adaptor.md b/dev-docs/bidder-adaptor.md
@@ -424,6 +424,7 @@ The parameters of the `bidResponse` object are:
 | `vastUrl`    | Either this or `vastXml` required for video | URL where the VAST document can be retrieved when ready for display.                                                                          | `"https://vid.example.com/9876`       |
 | `vastImpUrl` | Optional; only usable with `vastUrl` and requires prebid cache to be enabled | An impression tracking URL to serve with video Ad                                                                                             | `"https://vid.exmpale.com/imp/134"`   |
 | `vastXml`    | Either this or `vastUrl` required for video | XML for VAST document to be cached for later retrieval.                                                                                       | `<VAST version="3.0">...`            |
+| `bidderCode` | Optional                                    | Bidder code to use for the response - for adapters that wish to reply on behalf of other bidders. Defaults to the code registered with [`registerBidder`](#bidder-adaptor-Overview); note that any other code will need to be [explicitly allowed by the publisher](/dev-docs/publisher-api-reference/bidderSettings.html#allowAlternateBidderCodes). | 'exampleBidder' |  
 | `dealId`     | Optional                                    | Deal ID                                                                                                                                       | `"123abc"`                           |
 | `meta`     | Optional                                    | Object containing metadata about the bid                                                                                                                                       |                           |
 | `meta.networkId`     | Optional                                    | Bidder-specific Network/DSP Id               | 1111             |

diff --git a/dev-docs/publisher-api-reference/bidderSettings.md b/dev-docs/publisher-api-reference/bidderSettings.md
@@ -46,7 +46,7 @@ Some sample scenarios where publishers may wish to alter the default settings:
 | allowZeroCpmBids | standard or adapter-specific | 6.2.0 | false | Would allow bids with a 0 CPM to be accepted by Prebid.js and could be passed to the ad server. |
 | storageAllowed | standard or adapter-specific | 6.13.0 | true | Allow use of cookies and local storage. |  
 | allowAlternateBidderCodes | standard or adapter-specific | 6.23.0 | true in v6.x <br /> false from v7.0| Allow adapters to bid with alternate bidder codes. |  
-| allowedAlternateBidderCodes | standard or adapter-specific | 6.23.0 | n/a | Array of bidder names for which an adapter can bid. <br />`undefined` or `['*']` will allow adapter to bid with any bidder code. |  
+| allowedAlternateBidderCodes | standard or adapter-specific | 6.23.0 | n/a | Array of bidder codes for which an adapter can bid. <br />`undefined` or `['*']` will allow adapter to bid with any bidder code. |  
 
 ##### 2.1. adserverTargeting
 
@@ -236,17 +236,13 @@ Note that:
  - [Disabling device access](/dev-docs/publisher-api-reference/setConfig.html#setConfig-deviceAccess) will prevent access to storage regardless of this setting;  
  - `storageAllowed` will only affect bid adapters and not any other type of module (such as analytics or RTD).
 
+<a id="allowAlternateBidderCodes" />
 ##### 2.7. allowAlternateBidderCodes
 
 If this flag is set to `true`, bidders that have not been explicitly requested in [`adUnit.bids`](../adunit-reference.html#adunitbids) may take part in the auction.
 <br />Default value is `true` in version 6.x
 <br />Default value will be `false` from version 7.0
 
-{: .alert.alert-warning :}
-Note that the `bidResponse.bidderCode` needs to be set as the bidder of the bid.
-<br />i.e: if `pubmatic` is the adapter bidding for `groupm`. `bidResponse.bidderCode` should be `groupm`.
-<br />Another field is introduced in `bidResponse` object i.e:`bidResponse.adapterCode` (this will be set by Prebid). This field indicates the bidder code that was in the adunit. This might be an alias of an underlying bid adapter. In above example, value of `bidResponse.adapterCode` will be `pubmatic`.
-
 
 ##### 2.8. allowedAlternateBidderCodes