Skip to content

Commit

Permalink
add some hb_source docs (#513)
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Kendall authored and rmloveland committed Jan 2, 2018

Verified

This commit was signed with the committer’s verified signature.
kezhenxu94 kezhenxu94
1 parent cf0e25b commit ee05033
Showing 2 changed files with 8 additions and 1 deletion.
2 changes: 2 additions & 0 deletions adops.md
Original file line number Diff line number Diff line change
@@ -64,6 +64,8 @@ Voila, you have dynamic allocation-like functionality for the major SSPs and exc
| hb_bidder | Required | The bidder code. Useful for logging and reporting to learn about which bidder has higher fill rate/CPM. | `rubicon` |
| hb_size | Optional | The width and height concatenated. | `300x250` |
| hb_cpm | Optional | The exact price the bidder bids for. It offers more accuracy than `hb_pb` and can be used by the line item to target. | `2.11` |
| hb_source | Optional | Returns the source of the bid, either "client" or "s2S" for server bid responses | `client` |



<a name="price-bucket-def"></a>
7 changes: 6 additions & 1 deletion dev-docs/publisher-api-reference.md
Original file line number Diff line number Diff line change
@@ -803,7 +803,7 @@ per adapter as needed. Both scenarios are described below.

**Keyword targeting for all bidders**

The below code snippet is the *default* setting for ad server targeting. For each bidder's bid, Prebid.js will set 4 keys (`hb_bidder`, `hb_adid`, `hb_pb`, `hb_size`) with their corresponding values. The key value pair targeting is applied to the bid's corresponding ad unit. Your ad ops team will have the ad server's line items target these keys.
The below code snippet is the *default* setting for ad server targeting. For each bidder's bid, Prebid.js will set 5 keys (`hb_bidder`, `hb_adid`, `hb_pb`, `hb_size`, `hb_source`) with their corresponding values. The key value pair targeting is applied to the bid's corresponding ad unit. Your ad ops team will have the ad server's line items target these keys.

If you'd like to customize the key value pairs, you can overwrite the settings as the below example shows. *Note* that once you updated the settings, let your ad ops team know about the change, so they can update the line item targeting accordingly. See the [Ad Ops](../adops.html) documentation for more information.

@@ -837,6 +837,11 @@ pbjs.bidderSettings = {
val: function (bidResponse) {
return bidResponse.size;
}
}, {
key: 'hb_source',
val: function (bidResponse) {
return bidResponse.source;
}
}]
}
}

0 comments on commit ee05033

Please sign in to comment.