prebid#4 Add ExtImpConsumable contract class

openrtb_ext/imp.go

@@ -2,11 +2,12 @@ package openrtb_ext
 
 // ExtImp defines the contract for bidrequest.imp[i].ext
 type ExtImp struct {
-	Prebid    *ExtImpPrebid    `json:"prebid"`
-	Appnexus  *ExtImpAppnexus  `json:"appnexus"`
-	Rubicon   *ExtImpRubicon   `json:"rubicon"`
-	Adform    *ExtImpAdform    `json:"adform"`
-	Rhythmone *ExtImpRhythmone `json:"rhythmone"`
+	Prebid     *ExtImpPrebid     `json:"prebid"`
+	Appnexus   *ExtImpAppnexus   `json:"appnexus"`
+	Consumable *ExtImpConsumable `json:"consumable"`
+	Rubicon    *ExtImpRubicon    `json:"rubicon"`
+	Adform     *ExtImpAdform     `json:"adform"`
+	Rhythmone  *ExtImpRhythmone  `json:"rhythmone"`
 }
 
 // ExtImpPrebid defines the contract for bidrequest.imp[i].ext.prebid

openrtb_ext/imp_consumable.go

@@ -1,4 +1,10 @@
 package openrtb_ext
 
 // ExtImpConsumable defines the contract for bidrequest.imp[i].ext.consumable
-type ExtImpConsumable struct{}
+type ExtImpConsumable struct {
+	NetworkId int `json:"networkId,omitempty"`
+	SiteId    int `json:"siteId,omitempty"`
+	UnitId    int `json:"unitId,omitempty"`
+	/* UnitName gets used as a classname and in the URL when building the ad markup */
+	UnitName string `json:"unitName"`
+}

static/bidder-params/consumable.json

@@ -1,5 +1,30 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Consumable Adapter Params",
-  "description": "A schema which validates params accepted by the Consumable adapter"
-}
+  "description": "A schema which validates params accepted by the Consumable adapter",
+
+  "type": "object",
+  "properties": {
+    "siteId": {
+      "type": "number",
+      "description": "An ID which identifies the site selling the impression",
+      "pattern": "^[0-9]+$"
+    },
+    "networkId": {
+      "type": "number",
+      "description": "The network id",
+      "pattern": "^[0-9]+$"
+    },
+    "unitId": {
+      "type": "number",
+      "description": "The unit id",
+      "pattern": "^[0-9]+$"
+    },
+    "unitName": {
+      "type": "string",
+      "description": "The unit name (expected to be a valid CSS class name)",
+      "pattern": "^-?[_a-zA-Z]+[_a-zA-Z0-9-]*$"
+    }
+  },
+  "required": ["siteId", "unitId", "unitName"]
+}