From f92650f022463ed16fc9faaaadb279d14819ce95 Mon Sep 17 00:00:00 2001
From: Nepomuk Seiler <muuki88@users.noreply.github.com>
Date: Tue, 22 Oct 2019 17:32:18 +0200
Subject: [PATCH] Add cpmDistribution function for Google Analytics adapter
 (#4240)

* Add cpmDistribution function for Google Analytics adapter

* Add test for the cpmDistribution function

* Remove half written comment
---
 modules/googleAnalyticsAdapter.js             | 12 ++++++
 modules/googleAnalyticsAdapter.md             | 37 +++++++++++++++++++
 .../modules/googleAnalyticsAdapter_spec.js    | 18 +++++++--
 3 files changed, 64 insertions(+), 3 deletions(-)
 create mode 100644 modules/googleAnalyticsAdapter.md

diff --git a/modules/googleAnalyticsAdapter.js b/modules/googleAnalyticsAdapter.js
index c1c16019449..2e569cd7ba1 100644
--- a/modules/googleAnalyticsAdapter.js
+++ b/modules/googleAnalyticsAdapter.js
@@ -19,6 +19,7 @@ var _enableCheck = true;
 var _category = 'Prebid.js Bids';
 var _eventCount = 0;
 var _enableDistribution = false;
+var _cpmDistribution = null;
 var _trackerSend = null;
 var _sampled = true;
 
@@ -42,6 +43,9 @@ adapter.enableAnalytics = function ({ provider, options }) {
   if (options && typeof options.enableDistribution !== 'undefined') {
     _enableDistribution = options.enableDistribution;
   }
+  if (options && typeof options.cpmDistribution === 'function') {
+    _cpmDistribution = options.cpmDistribution;
+  }
 
   var bid = null;
 
@@ -166,6 +170,9 @@ function getLoadTimeDistribution(time) {
 }
 
 function getCpmDistribution(cpm) {
+  if (_cpmDistribution) {
+    return _cpmDistribution(cpm);
+  }
   var distribution;
   if (cpm >= 0 && cpm < 0.5) {
     distribution = '$0-0.5';
@@ -255,6 +262,11 @@ function sendBidWonToGa(bid) {
   checkAnalytics();
 }
 
+/**
+ * Exposed for testing purposes
+ */
+adapter.getCpmDistribution = getCpmDistribution;
+
 adapterManager.registerAnalyticsAdapter({
   adapter,
   code: 'ga'
diff --git a/modules/googleAnalyticsAdapter.md b/modules/googleAnalyticsAdapter.md
new file mode 100644
index 00000000000..08423a1d492
--- /dev/null
+++ b/modules/googleAnalyticsAdapter.md
@@ -0,0 +1,37 @@
+# Google Analytics Adapter
+
+The google analytics adapter pushes prebid events into google analytics.
+
+## Usage
+
+The simplest way to enable the analytics adapter is this
+
+```javascript
+pbjs.enableAnalytics([{
+  provider: 'ga'
+}]);
+```
+
+Defaults will be used and you should see events being pushed to analytics.
+
+You can customize the adapter with various `options` like this
+
+```javascript
+pbjs.enableAnalytics([{
+  provider: 'ga',
+  options: { ... }
+}]);
+
+Here is a full list of settings available
+
+- `global` (string) - name of the global analytics object. Default is `ga`
+- `trackerName` (string) - use another tracker for prebid events. Default is the default tracker
+- `sampling` (number) - choose a value from `0` to `1`, where `0` means 0% and `1` means 100% tracked
+- `enableDistribution` (boolean) - enables additional events that track load time and cpm distribution
+  by creating buckets for load time and cpm
+- `cpmDistribution` (cpm: number => string) - customize the cpm buckets for the cpm distribution
+
+
+## Additional resources
+
+- [Prebid GA Analytics](http://prebid.org/overview/ga-analytics.html)
diff --git a/test/spec/modules/googleAnalyticsAdapter_spec.js b/test/spec/modules/googleAnalyticsAdapter_spec.js
index 20517f4138d..6bc0d4e192d 100644
--- a/test/spec/modules/googleAnalyticsAdapter_spec.js
+++ b/test/spec/modules/googleAnalyticsAdapter_spec.js
@@ -4,12 +4,24 @@ var assert = require('assert');
 
 describe('Ga', function () {
   describe('enableAnalytics', function () {
-    it('should accept a tracker name option and output prefixed send string', function () {
-      var config = { options: { trackerName: 'foo' } };
-      ga.enableAnalytics(config);
+    var cpmDistribution = function(cpm) {
+      return cpm <= 1 ? '<= 1$' : '> 1$';
+    }
+    var config = { options: { trackerName: 'foo', enableDistribution: true, cpmDistribution: cpmDistribution } };
+
+    // enableAnalytics can only be called once
+    ga.enableAnalytics(config);
 
+    it('should accept a tracker name option and output prefixed send string', function () {
       var output = ga.getTrackerSend();
       assert.equal(output, 'foo.send');
     });
+
+    it('should use the custom cpm distribution', function() {
+      assert.equal(ga.getCpmDistribution(0.5), '<= 1$');
+      assert.equal(ga.getCpmDistribution(1), '<= 1$');
+      assert.equal(ga.getCpmDistribution(2), '> 1$');
+      assert.equal(ga.getCpmDistribution(5.23), '> 1$');
+    });
   });
 });