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.

Sign up for GitHub

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

Jump to bottom

Feature: allowSendAllTargetingKeys #2985

Merged
merged 3 commits into from
Jun 10, 2021
Merged

Feature: allowSendAllTargetingKeys #2985

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0370afc
added info about allowSendAllTargetingKeys
RRSchweitzer May 24, 2021
1215f93
added a note about hb_bidder_biddercode
RRSchweitzer Jun 9, 2021
8ace81b
fixed typo
RRSchweitzer Jun 10, 2021
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
14 changes: 14 additions & 0 deletions dev-docs/publisher-api-reference/setConfig.md
View file
Open in desktop
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,19 @@ 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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps helpful to note here that prebid sends hb_bidder_BIDDER and this is useless

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