Add segment (#3630)

ampproject · Jun 21, 2016 · 82a52c8 · 82a52c8
1 parent 4cde182
commit 82a52c8
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 2 deletions.
diff --git a/examples/analytics.amp.html b/examples/analytics.amp.html
@@ -445,6 +445,31 @@
 </amp-analytics>
 <!-- End SimpleReach Example -->
 
+<!-- Segment analytics tracking -->
+<amp-analytics type="segment">
+<script type="application/json">
+{
+  "vars": {
+    "writeKey": "p74lml96co",
+    "name": "Page name"
+  },
+  "extraUrlParams": {
+    "properties.author.name": "John"
+  },
+  "triggers": {
+    "click": {
+      "on": "click",
+      "selector": "#test1",
+      "request": "track",
+      "vars": {
+        "event": "click"
+      }
+    }
+  }
+}
+</script>
+</amp-analytics>
+
 <!-- Snowplow Analytics tracking -->
 <amp-analytics type="snowplow" id="snowplow">
 <script type="application/json">
@@ -651,4 +676,3 @@ <h1 id="top">AMP Analytics</h1>
     </amp-anim>
 </body>
 </html>
-
diff --git a/extensions/amp-analytics/0.1/test/vendor-requests.json b/extensions/amp-analytics/0.1/test/vendor-requests.json
@@ -98,6 +98,12 @@
     "visible": "https://edge.simplereach.com/n?amp=true&pid=$pid&title=_title_&url=_canonical_url_&date=$published_at&authors=$authors&channels=$categories&tags=$tags&referrer=_document_referrer_&page_url=_source_url_&user_id=_client_id_&domain=_canonical_host_",
     "timer": "https://edge.simplereach.com/t?amp=true&pid=$pid&title=_title_&url=_canonical_url_&date=$published_at&authors=$authors&channels=$categories&tags=$tags&referrer=_document_referrer_&page_url=_source_url_&user_id=_client_id_&domain=_canonical_host_&t=5000&e=5000"
   },
+  "segment": {
+    "host": "https://api.segment.io/v1/pixel",
+    "base": "?writeKey=$writeKey&anonymousId=$anonymousId&context.locale=_browser_language_&context.page.path=_canonical_path_&context.page.url=_canonical_url_&context.page.referrer=_document_referrer_&context.page.title=_title_&context.screen.width=_screen_width_&context.screen.height=_screen_height_",
+    "page": "https://api.segment.io/v1/pixel/page?writeKey=$writeKey&anonymousId=$anonymousId&context.locale=_browser_language_&context.page.path=_canonical_path_&context.page.url=_canonical_url_&context.page.referrer=_document_referrer_&context.page.title=_title_&context.screen.width=_screen_width_&context.screen.height=_screen_height_&name=$name",
+    "track": "https://api.segment.io/v1/pixel/track?writeKey=$writeKey&anonymousId=$anonymousId&context.locale=_browser_language_&context.page.path=_canonical_path_&context.page.url=_canonical_url_&context.page.referrer=_document_referrer_&context.page.title=_title_&context.screen.width=_screen_width_&context.screen.height=_screen_height_&event=$event"
+  },
   "snowplow": {
     "aaVersion": "amp-0.1",
     "basePrefix": "https://$collectorHost/i?url=_canonical_url_&page=_title_&res=_screen_width_x_screen_height_&stm=_timestamp_&tz=_timezone_&aid=$appId&p=web&tv=amp-0.1",

diff --git a/extensions/amp-analytics/0.1/vendors.js b/extensions/amp-analytics/0.1/vendors.js
@@ -645,6 +645,37 @@ export const ANALYTICS_CONFIG = {
     },
   },
 
+  'segment': {
+    'transport': {
+      'beacon': false,
+      'xhrpost': false,
+      'image': true,
+    },
+    'vars': {
+      'anonymousId': 'CLIENT_ID(segment_amp_id)',
+    },
+    'requests': {
+      'host': 'https://api.segment.io/v1/pixel',
+      'base': '?writeKey=${writeKey}' +
+        '&anonymousId=${anonymousId}' +
+        '&context.locale=${browserLanguage}' +
+        '&context.page.path=${canonicalPath}' +
+        '&context.page.url=${canonicalUrl}' +
+        '&context.page.referrer=${documentReferrer}' +
+        '&context.page.title=${title}' +
+        '&context.screen.width=${screenWidth}' +
+        '&context.screen.height=${screenHeight}',
+      'page': '${host}/page${base}&name=${name}',
+      'track': '${host}/track${base}&event=${event}',
+    },
+    'triggers': {
+      'page': {
+        'on': 'visible',
+        'request': 'page',
+      },
+    },
+  },
+
   'snowplow': {
     'requests': {
       'aaVersion': 'amp-0.1',
@@ -843,4 +874,3 @@ ANALYTICS_CONFIG['adobeanalytics_nativeConfig']
 
 ANALYTICS_CONFIG['oewa']['triggers']['pageview']['iframe' +
 /* TEMPORARY EXCEPTION */ 'Ping'] = true;
-
diff --git a/extensions/amp-analytics/amp-analytics.md b/extensions/amp-analytics/amp-analytics.md
@@ -214,6 +214,13 @@ Type attribute value: `quantcast`
 
 Adds support for Quantcast Measurement. More details for adding Quantcast Measurement can be found at [quantcast.com](https://www.quantcast.com/help/guides/)
 
+## Segment
+
+Type attribute value: `segment`
+
+Adds support for segment page views and events.
+To see the full list of fields that you can send, see [Segment Spec](https://segment.com/docs/spec/).
+
 ### SOASTA mPulse
 
 Type attribute value: `mpulse`