Skip to content

Commit

Permalink
Feature: allowSendAllTargetingKeys (#2985)
Browse files Browse the repository at this point in the history
* added info about allowSendAllTargetingKeys

* added a note about hb_bidder_biddercode

* fixed typo
  • Loading branch information
Ryan Schweitzer authored Jun 10, 2021
1 parent e3e5bd4 commit 9f5ad76
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions dev-docs/publisher-api-reference/setConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -713,6 +713,7 @@ The `targetingControls` object passed to `pbjs.setConfig` provides some options
| auctionKeyMaxChars | integer | Specifies the maximum number of characters the system can add to ad server targeting. |
| alwaysIncludeDeals | boolean | If [enableSendAllBids](#setConfig-Send-All-Bids) is false, set this value to `true` to ensure that deals are sent along with the winning bid |
| allowTargetingKeys | Array of Strings | Selects supported default targeting keys. |
| allowSendAllBidsTargetingKeys | Array of Strings | Selects supported default targeting keys. |

{: .alert.alert-info :}
Note that this feature overlaps and can be used in conjunction with [sendBidsControl.bidLimit](#setConfig-Send-Bids-Control).
Expand Down Expand Up @@ -824,6 +825,20 @@ config.setConfig({
});
```

##### Details on the allowSendAllBidsTargetingKeys setting

The `allowSendAllBidsTargetingKeys` is similar to `allowTargetingKeys` except it limits any default bidder specific keys sent to the adserver when sendAllBids is enabled. Any default bidder specific keys that do not match the mask will not be sent to the adserver. This setting can be helpful if you find that your default Prebid.js implementation is sending key values that your adserver isn't configured to process; extraneous key values may lead to the ad server request being truncated, which can cause potential issues with the delivery or rendering ads. An example of an extraneous key value many publishers may find redundant and want to remove is `hb_bidder_biddercode = biddercode`.

Below is an example config of `allowSendAllBidsTargetingKeys` excluding all default send all bids targeting keys except `hb_adid_biddercode`, `hb_pb_biddercode`:

```javascript
config.setConfig({
targetingControls: {
allowSendAllBidsTargetingKeys: ['AD_ID', 'PRICE_BUCKET'],
},
});
```


<a name="setConfig-Configure-Responsive-Ads" />

Expand Down

0 comments on commit 9f5ad76

Please sign in to comment.