From 88f23c4e851a6b3b6324940c8d27a8b843e7720c Mon Sep 17 00:00:00 2001 From: Matt Kendall Date: Tue, 19 Dec 2017 16:32:26 -0500 Subject: [PATCH] add some hb_source docs --- adops.md | 2 ++ dev-docs/publisher-api-reference.md | 7 ++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/adops.md b/adops.md index 67648b5f41..3ecee11662 100644 --- a/adops.md +++ b/adops.md @@ -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` | + diff --git a/dev-docs/publisher-api-reference.md b/dev-docs/publisher-api-reference.md index a625061246..9b889df3ed 100644 --- a/dev-docs/publisher-api-reference.md +++ b/dev-docs/publisher-api-reference.md @@ -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; + } }] } }