Remove hard coded targeting keys

endpoints/auction.go

@@ -33,13 +33,6 @@ type bidResult struct {
 
 const defaultPriceGranularity = "med"
 
-// Constant keys for ad server targeting for responses to Prebid Mobile
-const hbpbConstantKey = "hb_pb"
-const hbBidderConstantKey = "hb_bidder"
-const hbCacheIdConstantKey = "hb_cache_id"
-const hbDealIdConstantKey = "hb_deal"
-const hbSizeConstantKey = "hb_size"
-
 func min(x, y int) int {
 	if x < y {
 		return x
@@ -445,16 +438,16 @@ func sortBidsAddKeywordsMobile(bids pbs.PBSBidSlice, pbs_req *pbs.PBSRequest, pr
 				hbSize = width + "x" + height
 			}
 
-			hbPbBidderKey := hbpbConstantKey + "_" + bid.BidderCode
-			hbBidderBidderKey := hbBidderConstantKey + "_" + bid.BidderCode
-			hbCacheIdBidderKey := hbCacheIdConstantKey + "_" + bid.BidderCode
-			hbDealIdBidderKey := hbDealIdConstantKey + "_" + bid.BidderCode
-			hbSizeBidderKey := hbSizeConstantKey + "_" + bid.BidderCode
+			hbPbBidderKey := string(openrtb_ext.HbpbConstantKey) + "_" + bid.BidderCode
+			hbBidderBidderKey := string(openrtb_ext.HbBidderConstantKey) + "_" + bid.BidderCode
+			hbCacheIDBidderKey := string(openrtb_ext.HbCacheKey) + "_" + bid.BidderCode
+			hbDealIDBidderKey := string(openrtb_ext.HbDealIDConstantKey) + "_" + bid.BidderCode
+			hbSizeBidderKey := string(openrtb_ext.HbSizeConstantKey) + "_" + bid.BidderCode
 			if pbs_req.MaxKeyLength != 0 {
 				hbPbBidderKey = hbPbBidderKey[:min(len(hbPbBidderKey), int(pbs_req.MaxKeyLength))]
 				hbBidderBidderKey = hbBidderBidderKey[:min(len(hbBidderBidderKey), int(pbs_req.MaxKeyLength))]
-				hbCacheIdBidderKey = hbCacheIdBidderKey[:min(len(hbCacheIdBidderKey), int(pbs_req.MaxKeyLength))]
-				hbDealIdBidderKey = hbDealIdBidderKey[:min(len(hbDealIdBidderKey), int(pbs_req.MaxKeyLength))]
+				hbCacheIDBidderKey = hbCacheIDBidderKey[:min(len(hbCacheIDBidderKey), int(pbs_req.MaxKeyLength))]
+				hbDealIDBidderKey = hbDealIDBidderKey[:min(len(hbDealIDBidderKey), int(pbs_req.MaxKeyLength))]
 				hbSizeBidderKey = hbSizeBidderKey[:min(len(hbSizeBidderKey), int(pbs_req.MaxKeyLength))]
 			}
 
@@ -466,24 +459,24 @@ func sortBidsAddKeywordsMobile(bids pbs.PBSBidSlice, pbs_req *pbs.PBSRequest, pr
 
 			kvs[hbPbBidderKey] = roundedCpm
 			kvs[hbBidderBidderKey] = bid.BidderCode
-			kvs[hbCacheIdBidderKey] = bid.CacheID
+			kvs[hbCacheIDBidderKey] = bid.CacheID
 
 			if hbSize != "" {
 				kvs[hbSizeBidderKey] = hbSize
 			}
 			if bid.DealId != "" {
-				kvs[hbDealIdBidderKey] = bid.DealId
+				kvs[hbDealIDBidderKey] = bid.DealId
 			}
 			// For the top bid, we want to add the following additional keys
 			if i == 0 {
-				kvs[hbpbConstantKey] = roundedCpm
-				kvs[hbBidderConstantKey] = bid.BidderCode
-				kvs[hbCacheIdConstantKey] = bid.CacheID
+				kvs[string(openrtb_ext.HbpbConstantKey)] = roundedCpm
+				kvs[string(openrtb_ext.HbBidderConstantKey)] = bid.BidderCode
+				kvs[string(openrtb_ext.HbCacheKey)] = bid.CacheID
 				if bid.DealId != "" {
-					kvs[hbDealIdConstantKey] = bid.DealId
+					kvs[string(openrtb_ext.HbDealIDConstantKey)] = bid.DealId
 				}
 				if hbSize != "" {
-					kvs[hbSizeConstantKey] = hbSize
+					kvs[string(openrtb_ext.HbSizeConstantKey)] = hbSize
 				}
 			}
 		}

endpoints/auction_test.go

@@ -148,56 +148,56 @@ func TestSortBidsAndAddKeywordsForMobile(t *testing.T) {
 			t.Error("Ad server targeting should not be nil")
 		}
 		if bid.BidderCode == "audienceNetwork" {
-			if bid.AdServerTargeting["hb_size"] != "300x250" {
-				t.Error("hb_size key was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbSizeConstantKey)] != "300x250" {
+				t.Error(string(openrtb_ext.HbSizeConstantKey) + " key was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_pb"] != "2.00" {
-				t.Error("hb_pb key was not parsed correctly ", bid.AdServerTargeting["hb_pb"])
+			if bid.AdServerTargeting[string(openrtb_ext.HbpbConstantKey)] != "2.00" {
+				t.Error(string(openrtb_ext.HbpbConstantKey)+" key was not parsed correctly ", bid.AdServerTargeting[string(openrtb_ext.HbpbConstantKey)])
 			}
 
-			if bid.AdServerTargeting["hb_cache_id"] != "test_cache_id1" {
-				t.Error("hb_cache_id key was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbCacheKey)] != "test_cache_id1" {
+				t.Error(string(openrtb_ext.HbCacheKey) + " key was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_bidder"] != "audienceNetwork" {
-				t.Error("hb_bidder key was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbBidderConstantKey)] != "audienceNetwork" {
+				t.Error(string(openrtb_ext.HbBidderConstantKey) + " key was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_deal"] != "2345" {
-				t.Error("hb_deal_id key was not parsed correctly ")
+			if bid.AdServerTargeting[string(openrtb_ext.HbDealIDConstantKey)] != "2345" {
+				t.Error(string(openrtb_ext.HbDealIDConstantKey) + " key was not parsed correctly ")
 			}
 		}
 		if bid.BidderCode == "appnexus" {
-			if bid.AdServerTargeting["hb_size_appnexus"] != "320x50" {
-				t.Error("hb_size key for appnexus bidder was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbSizeConstantKey)+"_appnexus"] != "320x50" {
+				t.Error(string(openrtb_ext.HbSizeConstantKey) + " key for appnexus bidder was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_cache_id_appnexus"] != "test_cache_id2" {
-				t.Error("hb_cache_id key for appnexus bidder was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbCacheKey)+"_appnexus"] != "test_cache_id2" {
+				t.Error(string(openrtb_ext.HbCacheKey) + " key for appnexus bidder was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_bidder_appnexus"] != "appnexus" {
-				t.Error("hb_bidder key for appnexus bidder was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbBidderConstantKey)+"_appnexus"] != "appnexus" {
+				t.Error(string(openrtb_ext.HbBidderConstantKey) + " key for appnexus bidder was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_pb_appnexus"] != "1.00" {
-				t.Error("hb_pb key for appnexus bidder was not parsed correctly")
+			if bid.AdServerTargeting[string(openrtb_ext.HbpbConstantKey)+"_appnexus"] != "1.00" {
+				t.Error(string(openrtb_ext.HbpbConstantKey) + " key for appnexus bidder was not parsed correctly")
 			}
-			if bid.AdServerTargeting["hb_pb"] != "" {
-				t.Error("hb_pb key was parsed for two bidders")
+			if bid.AdServerTargeting[string(openrtb_ext.HbpbConstantKey)] != "" {
+				t.Error(string(openrtb_ext.HbpbConstantKey) + " key was parsed for two bidders")
 			}
-			if bid.AdServerTargeting["hb_deal_appnexus"] != "1234" {
-				t.Errorf("hb_deal_id_appnexus was not parsed correctly %v", bid.AdServerTargeting["hb_deal_id_appnexus"])
+			if bid.AdServerTargeting[string(openrtb_ext.HbDealIDConstantKey)+"_appnexus"] != "1234" {
+				t.Errorf(string(openrtb_ext.HbDealIDConstantKey)+"_appnexus was not parsed correctly %v", bid.AdServerTargeting[string(openrtb_ext.HbDealIDConstantKey)+"_appnexus"])
 			}
 		}
-		if bid.BidderCode == "rubicon" {
+		if bid.BidderCode == string(openrtb_ext.BidderRubicon) {
 			if bid.AdServerTargeting["rpfl_1001"] != "15_tier0100" {
 				t.Error("custom ad_server_targeting KVPs from adapter were not preserved")
 			}
 		}
 		if bid.BidderCode == "nosizebidder" {
-			if _, exists := bid.AdServerTargeting["hb_size_nosizebidder"]; exists {
-				t.Error("hb_size key for nosize bidder was not parsed correctly", bid.AdServerTargeting)
+			if _, exists := bid.AdServerTargeting[string(openrtb_ext.HbSizeConstantKey)+"_nosizebidder"]; exists {
+				t.Error(string(openrtb_ext.HbSizeConstantKey)+" key for nosize bidder was not parsed correctly", bid.AdServerTargeting)
 			}
 		}
 		if bid.BidderCode == "nodeal" {
-			if _, exists := bid.AdServerTargeting["hb_deal_nodeal"]; exists {
-				t.Error("hb_deal_id key for nodeal bidder was not parsed correctly")
+			if _, exists := bid.AdServerTargeting[string(openrtb_ext.HbDealIDConstantKey)+"_nodeal"]; exists {
+				t.Error(string(openrtb_ext.HbDealIDConstantKey) + " key for nodeal bidder was not parsed correctly")
 			}
 		}
 	}

endpoints/openrtb2/video_auction.go

@@ -375,9 +375,9 @@ func buildVideoResponse(bidresponse *openrtb.BidResponse, podErrors []PodError)
 			podId, _ := strconv.ParseInt(podNum, 0, 64)
 
 			videoTargeting := openrtb_ext.VideoTargeting{
-				Hb_pb:         tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbpbConstantKey)],
-				Hb_pb_cat_dur: tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbCategoryDurationKey)],
-				Hb_cache_id:   tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbVastCacheKey)],
+				HbPb:       tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbpbConstantKey)],
+				HbPbCatDur: tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbCategoryDurationKey)],
+				HbCacheID:  tempRespBidExt.Prebid.Targeting[string(openrtb_ext.HbVastCacheKey)],
 			}
 
 			adPod := findAdPod(podId, adPods)

endpoints/openrtb2/video_auction_test.go

@@ -54,7 +54,7 @@ func TestVideoEndpointImpressionsNumber(t *testing.T) {
 	assert.Len(t, resp.AdPods[3].Targeting, 1, "Incorrect Targeting data in response")
 	assert.Len(t, resp.AdPods[4].Targeting, 3, "Incorrect Targeting data in response")
 
-	assert.Equal(t, resp.AdPods[4].Targeting[0].Hb_pb_cat_dur, "20.00_395_30s", "Incorrect number of Ad Pods in response")
+	assert.Equal(t, resp.AdPods[4].Targeting[0].HbPbCatDur, "20.00_395_30s", "Incorrect number of Ad Pods in response")
 
 }
 
@@ -398,8 +398,8 @@ func TestVideoBuildVideoResponseMissedCacheForOneBid(t *testing.T) {
 	assert.NoError(t, err, "Should be no error")
 	assert.Len(t, bidRespVideo.AdPods, 1, "AdPods length should be 1")
 	assert.Len(t, bidRespVideo.AdPods[0].Targeting, 2, "AdPod Targeting length should be 2")
-	assert.Equal(t, "17.00_123_30s", bidRespVideo.AdPods[0].Targeting[0].Hb_pb_cat_dur, "AdPod Targeting first element hb_pb_cat_dur should be 17.00_123_30s")
-	assert.Equal(t, "17.00_456_30s", bidRespVideo.AdPods[0].Targeting[1].Hb_pb_cat_dur, "AdPod Targeting first element hb_pb_cat_dur should be 17.00_456_30s")
+	assert.Equal(t, "17.00_123_30s", bidRespVideo.AdPods[0].Targeting[0].HbPbCatDur, "AdPod Targeting first element hb_pb_cat_dur should be 17.00_123_30s")
+	assert.Equal(t, "17.00_456_30s", bidRespVideo.AdPods[0].Targeting[1].HbPbCatDur, "AdPod Targeting first element hb_pb_cat_dur should be 17.00_456_30s")
 }
 
 func TestVideoBuildVideoResponseMissedCacheForAllBids(t *testing.T) {

exchange/targeting.go

@@ -51,7 +51,7 @@ func (targData *targetData) setTargeting(auc *auction, isApp bool, categoryMappi
 				targData.addKeys(targets, openrtb_ext.HbVastCacheKey, vastID, bidderName, isOverallWinner)
 			}
 			if deal := topBidPerBidder.bid.DealID; len(deal) > 0 {
-				targData.addKeys(targets, openrtb_ext.HbDealIdConstantKey, deal, bidderName, isOverallWinner)
+				targData.addKeys(targets, openrtb_ext.HbDealIDConstantKey, deal, bidderName, isOverallWinner)
 			}
 
 			if isApp {

openrtb_ext/bid.go

@@ -87,7 +87,7 @@ const (
 	// HbBidderConstantKey is the name of the Bidder. For example, "appnexus" or "rubicon".
 	HbBidderConstantKey TargetingKey = "hb_bidder"
 	HbSizeConstantKey   TargetingKey = "hb_size"
-	HbDealIdConstantKey TargetingKey = "hb_deal"
+	HbDealIDConstantKey TargetingKey = "hb_deal"
 
 	// HbCacheKey and HbVastCacheKey store UUIDs which can be used to fetch things from prebid cache.
 	// Callers should *never* assume that either of these exist, since the call to the cache may always fail.

openrtb_ext/bid_response_video.go

@@ -14,7 +14,7 @@ type AdPod struct {
 }
 
 type VideoTargeting struct {
-	Hb_pb         string `json:"hb_pb"`
-	Hb_pb_cat_dur string `json:"hb_pb_cat_dur"`
-	Hb_cache_id   string `json:"hb_cache_id"`
+	HbPb       string `json:"hb_pb"`
+	HbPbCatDur string `json:"hb_pb_cat_dur"`
+	HbCacheID  string `json:"hb_cache_id"`
 }