RAD-1229 add docs for Custom CPM Bucket Sizing

Rich Loveland · Rich Loveland · commit db38cc5a9c8a · 2016-11-15T14:32:32.000-05:00
(From 0.14 release)
diff --git a/dev-docs/publisher-api-reference.md b/dev-docs/publisher-api-reference.md
@@ -365,6 +365,7 @@ Accepted values:
 + `"high"`: $0.01 increments, capped at $20 CPM
 + `"auto"`: Applies a sliding scale to determine granularity as shown in the [Auto Granularity](#autoGranularityBucket) table below.
 + `"dense"`: Like `"auto"`, but the bid price granularity uses smaller increments, especially at lower CPMs.  For details, see the [Dense Granularity](#denseGranularityBucket) table below.
++ `customConfigObject`: If you pass in a custom config object (as shown in the [Custom CPM Bucket Sizing](#customCPMObject) example below), you can have much finer control over CPM bucket sizes, precision, and caps.
 
 <div class="alert alert-danger" role="alert">
   <p>
@@ -396,6 +397,37 @@ Accepted values:
 | CPM <= $20 and >$8 | 	$0.50 increments             | $14.26 floored to $14.00 |
 | CPM >  $20 | 	Caps the price bucket at $20 | $24.82 floored to $20.00 |
 
+<a name="customCPMObject"></a>
+
+#### Custom CPM Bucket Sizing
+
+To set up your own custom CPM buckets, create an object like the following, and pass it into `setPriceGranularity`:
+
+```javascript
+const customConfigObject = {
+  "buckets" : [{
+      "precision" 2,  //default is 2 if omitted - means 2.1234 rounded to 2 decimal places = 2.12
+      "min" : 0,
+      "max" : 5,
+      "increment" : 0.01,
+    },
+    {
+      "precision" 2,
+      "min" : 5,
+      "max" : 8,
+      "increment" : 0.05,
+    },
+    {
+      "precision" 2,
+      "min" : 8,
+      "max" : 20,
+      "increment" : 0.5
+    }]
+};
+
+//set custom config object
+pbjs.setPriceGranularity(customConfigObject);
+```
 
 <hr class="full-rule">
 
