Flexible Analytics Manager #526
Conversation
Allow analytics provider plugins to specify template tag names to allow templates to specify where on the DOM individual providers are rendered. (for example: google tag manager requires a data layer in the head however, the core tag manager snippet might be best placed in the body of the document).
| @@ -112,14 +128,16 @@ module.exports = function AnalyticsManagerModule(pb) { | |||
| * instance of Localization. The last is a callback that should be called with | |||
| * two parameters. The first is an error, if occurred and the second is raw | |||
| * HTML string that represents the snippet to be executed by the analytics | |||
| * plugin. | |||
| * plugin. | |||
| * @param {String} optional name of template tag where the template service to register your snippet | |||
There was a problem hiding this comment.
Would you mind updating the documentation to:
* @param {String} name
* @param {Function} onPageRendering
* @param {String} [templateTag='analytics'] name of template tag where the template service to register your snippet
This will make things show up correctly when we generate our documentation using YUIDoc
…non page controllers
|
Thank you for the making the changes. I'll be looking back over this day and hopefully merging it in. |
| self.templateService.registerLocal(result.templateTag, function(flag, cb){ | ||
| pb.AnalyticsManager.onPageRender(self.req, self.session, self.ls, result.providerName, cb); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
This does avoid the performance issues I mentioned but brings to light another issue with this implementation. It does not support the ability for multiple providers to be rendered under the same analytics tag. This is needed for backward compatibility.
For example, if someone were running both the google analytics plugin and the ChartBeat plugin only one would get rendered when the ^analytics^ flag is encountered in the templates. The reason is because in your loop you register a single flag name with a single provider.
The more I ponder over this use case the more I wonder if the core functionality should be to provide an analytics_header and analytics_footer flag and let the plugins themselves choose where to render with the default going to the header. Then if there are other specific use cases for inputing in the body or only in certain circumstances the plugins can register global flags and render appropriately for that specific purpose.
|
Hey Brian, Sorry for not getting back to this sooner. I think for our use case we can leave it as is for now. For Google Tag Manager, we will just leave it up to the theme template to provide the variable dataLayer and then we will let the plugin render the core GTM script via the ^analytics^ flag. Based on the way GTM works we don't want both it and Google Analytics installed side by side as GTM handles GA tracking. |
Allow analytics provider plugins to specify template tag names to allow
templates to specify where on the DOM individual providers are
rendered. (for example: google tag manager requires a data layer in
the head however, the core tag manager snippet might be best placed in
the body of the document).
Also I will follow this change with this submission of a Google Tag Manager plugin on the PencilBlue Plugins page.