GROWTH-1094 add logAttributionCapturedEvent option to log Amplitude Events when attribution data is captured

Author: kelsonpw

src/amplitude-client.js

@@ -354,14 +354,28 @@ AmplitudeClient.prototype._migrateUnsentEvents = function _migrateUnsentEvents(c
  * @private
  */
 AmplitudeClient.prototype._trackParamsAndReferrer = function _trackParamsAndReferrer() {
+  let utmProperties;
+  let referrerProperties
+  let gclidProperties;
   if (this.options.includeUtm) {
-    this._initUtmData();
+    utmProperties = this._initUtmData();
   }
   if (this.options.includeReferrer) {
-    this._saveReferrer(this._getReferrer());
+    referrerProperties = this._saveReferrer(this._getReferrer());
   }
   if (this.options.includeGclid) {
-    this._saveGclid(this._getUrlParams());
+    gclidProperties = this._saveGclid(this._getUrlParams());
+  }
+  if (this.options.logAttributionCapturedEvent) {
+    const attributionProperties = Object.assign(
+      {},
+      utmProperties,
+      referrerProperties,
+      gclidProperties
+    );
+    if (Object.keys(attributionProperties).length > 0) {
+      this.logEvent(Constants.ATTRIBUTION_EVENT, attributionProperties);
+    }
   }
 };
 
@@ -675,6 +689,7 @@ AmplitudeClient.prototype._initUtmData = function _initUtmData(queryParams, cook
   cookieParams = cookieParams || this.cookieStorage.get('__utmz');
   var utmProperties = getUtmData(cookieParams, queryParams);
   _sendParamsReferrerUserProperties(this, utmProperties);
+  return utmProperties;
 };
 
 /**
@@ -739,6 +754,7 @@ AmplitudeClient.prototype._saveGclid = function _saveGclid(urlParams) {
   }
   var gclidProperties = {'gclid': gclid};
   _sendParamsReferrerUserProperties(this, gclidProperties);
+  return gclidProperties;
 };
 
 /**
@@ -778,6 +794,7 @@ AmplitudeClient.prototype._saveReferrer = function _saveReferrer(referrer) {
     'referring_domain': this._getReferringDomain(referrer)
   };
   _sendParamsReferrerUserProperties(this, referrerInfo);
+  return referrerInfo;
 };
 
 /**

src/constants.js

@@ -37,5 +37,7 @@ export default {
   UTM_MEDIUM: 'utm_medium',
   UTM_CAMPAIGN: 'utm_campaign',
   UTM_TERM: 'utm_term',
-  UTM_CONTENT: 'utm_content'
+  UTM_CONTENT: 'utm_content',
+
+  ATTRIBUTION_EVENT: 'attribution captured'
 };

src/options.js

@@ -30,6 +30,7 @@ export default {
   includeUtm: false,
   language: language.getLanguage(),
   logLevel: 'WARN',
+  logAttributionCapturedEvent: false,
   optOut: false,
   onError: () => {},
   platform,

test/browser/amplitudejs.html

@@ -89,7 +89,7 @@
     }
 </script>
 <script>
-    amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true, includeUtm: true, includeGclid: true}, function() {
+    amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true, includeUtm: true, includeGclid: true, logAttributionCapturedEvent: true}, function() {
         alert(amplitude.options.deviceId);
     });
     amplitude.setVersionName('Web');