{"id":7819,"date":"2016-05-31T09:47:22","date_gmt":"2016-05-31T16:47:22","guid":{"rendered":"http:\/\/blog.mozilla.org\/addons\/?p=7819"},"modified":"2016-06-01T07:38:31","modified_gmt":"2016-06-01T14:38:31","slug":"using-google-analytics-in-extensions","status":"publish","type":"post","link":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/","title":{"rendered":"Using Google Analytics in Extensions"},"content":{"rendered":"

As an add-on developer, you may want to have usage reporting integrated into your add-on. This allows you to understand how your users are using the add-on in real life, which can often lead to important insights and code updates that improve user experience.<\/p>\n

The most popular way to do this is to inject the Google Analytics script into your codebase as if it were a web page. However, this is incompatible with our review policies. Injecting remote scripts into privileged code – or even content – is very dangerous and it’s not allowed. Fortunately, there are ways to send reports to Google Analytics without resorting to remote script injection, and they are very easy to implement.<\/p>\n

Update:<\/strong> add-ons that use GA are required to have a privacy policy on AMO, and the data they send should be only what’s strictly necessary for usage reporting. This blog post is meant to show the safer ways of using GA, not advocate its unrestricted use.<\/p>\n

I created a branch of one of my add-ons<\/a> to serve as a demo. The add-on is a WebExtension that injects a content script into some AMO<\/a> pages to add links that are useful to admins and reviewers. The diff for the branch<\/a><\/strong> shouldn’t take much time to read and understand. It mostly comes down to this XHR:<\/p>\n

let request = new XMLHttpRequest();\r\nlet message =\r\n  \"v=1&tid=\" + GA_TRACKING_ID + \"&cid= \" + GA_CLIENT_ID + \"&aip=1\" +\r\n  \"&ds=add-on&t=event&ec=AAA&ea=\" + aType;\r\n\r\nrequest.open(\"POST\", \"https:\/\/www.google-analytics.com\/collect\", true);\r\nrequest.send(message);<\/code><\/pre>\n
In my demo I do everything from the content script code. For add-ons with a more complex structure, you should set up a background script that does the reporting and have content scripts send messages to it if needed.<\/p>\n
I set up my reporting so the hits are sent as events. You can read about reporting types and all the different parameters in the Google Analytics developer docs<\/a>.<\/p>\n
Thanks to the real-time tracking feature I could see that my implementation was working right away:<\/p>\n
\"live-tracking\"<\/p>\n
That’s it! With just a few lines of code you can set up Google Analytics for your add-on safely, in a way that meets our review guidelines.<\/p>\n","protected":false},"excerpt":{"rendered":"
As an add-on developer, you may want to have usage reporting integrated into your add-on. This allows you to understand how your users are using the add-on in real life, … Read more<\/a><\/p>\n","protected":false},"author":173,"featured_media":1995,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[44,278886],"tags":[580,278873,278894,278879,278871],"yoast_head":"\nUsing Google Analytics in Extensions - Mozilla Add-ons Community Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Jorge Villalobos\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/\",\"url\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/\",\"name\":\"Using Google Analytics in Extensions - Mozilla Add-ons Community Blog\",\"isPartOf\":{\"@id\":\"https:\/\/blog.mozilla.org\/addons\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png\",\"datePublished\":\"2016-05-31T16:47:22+00:00\",\"dateModified\":\"2016-06-01T14:38:31+00:00\",\"author\":{\"@id\":\"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/8f9ee30568e42640295498bf253f227c\"},\"breadcrumb\":{\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage\",\"url\":\"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png\",\"contentUrl\":\"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png\",\"width\":\"217\",\"height\":\"188\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/blog.mozilla.org\/addons\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Using Google Analytics in Extensions\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/#website\",\"url\":\"https:\/\/blog.mozilla.org\/addons\/\",\"name\":\"Mozilla Add-ons Community Blog\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/blog.mozilla.org\/addons\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/8f9ee30568e42640295498bf253f227c\",\"name\":\"Jorge Villalobos\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/6d1966118f16e4b99a6e3ad07883be33?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/6d1966118f16e4b99a6e3ad07883be33?s=96&d=mm&r=g\",\"caption\":\"Jorge Villalobos\"},\"description\":\"Jorge is the Product Manager for addons.mozilla.org\",\"url\":\"https:\/\/blog.mozilla.org\/addons\/author\/jvillalobosmozilla-com\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Using Google Analytics in Extensions - Mozilla Add-ons Community Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/","twitter_misc":{"Written by":"Jorge Villalobos","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/","url":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/","name":"Using Google Analytics in Extensions - Mozilla Add-ons Community Blog","isPartOf":{"@id":"https:\/\/blog.mozilla.org\/addons\/#website"},"primaryImageOfPage":{"@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage"},"image":{"@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage"},"thumbnailUrl":"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png","datePublished":"2016-05-31T16:47:22+00:00","dateModified":"2016-06-01T14:38:31+00:00","author":{"@id":"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/8f9ee30568e42640295498bf253f227c"},"breadcrumb":{"@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#primaryimage","url":"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png","contentUrl":"https:\/\/blog.mozilla.org\/addons\/files\/2010\/10\/addons.png","width":"217","height":"188"},{"@type":"BreadcrumbList","@id":"https:\/\/blog.mozilla.org\/addons\/2016\/05\/31\/using-google-analytics-in-extensions\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/blog.mozilla.org\/addons\/"},{"@type":"ListItem","position":2,"name":"Using Google Analytics in Extensions"}]},{"@type":"WebSite","@id":"https:\/\/blog.mozilla.org\/addons\/#website","url":"https:\/\/blog.mozilla.org\/addons\/","name":"Mozilla Add-ons Community Blog","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/blog.mozilla.org\/addons\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/8f9ee30568e42640295498bf253f227c","name":"Jorge Villalobos","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.mozilla.org\/addons\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/6d1966118f16e4b99a6e3ad07883be33?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/6d1966118f16e4b99a6e3ad07883be33?s=96&d=mm&r=g","caption":"Jorge Villalobos"},"description":"Jorge is the Product Manager for addons.mozilla.org","url":"https:\/\/blog.mozilla.org\/addons\/author\/jvillalobosmozilla-com\/"}]}},"_links":{"self":[{"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/posts\/7819"}],"collection":[{"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/users\/173"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/comments?post=7819"}],"version-history":[{"count":0,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/posts\/7819\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/media\/1995"}],"wp:attachment":[{"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/media?parent=7819"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/categories?post=7819"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.mozilla.org\/addons\/wp-json\/wp\/v2\/tags?post=7819"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}