<\/p>\n <\/a><\/p>\n<\/div>\n The Snowplow Analytics<\/strong> custom tag template<\/a> is an official<\/strong> tag template for Google Tag Manager\u2019s<\/a> community template gallery<\/a>.<\/p>\n <\/p>\n <\/a><\/p>\n<\/div>\n This template implements the Snowplow Analytics JavaScript tracker<\/a>. The template supports the full spread of features of the tracker, with a few exceptions due to the limitations of custom templates\u2019 sandboxed JavaScript.<\/p>\n To install the template<\/strong>, browse to Templates<\/strong> in the Google Tag Manager user interface.<\/p>\n Under Tag Templates<\/strong>, click Search Gallery<\/strong>, and type <\/p>\n <\/a><\/p>\n<\/div>\n Click the Snowplow Analytics<\/strong> template name, and then click Add to Workspace<\/strong> in the next screen. Review the permissions and click Add<\/strong> to finalize the import.<\/p>\n After importing the template, you can follow the normal process of creating a new tag<\/strong> in Google Tag Manager, and the Snowplow Analytics<\/strong> template will be listed among the Custom<\/strong> tag types you can choose from.<\/p>\n To begin with, some of the caveats of using the Custom Template.<\/p>\n Here are basic instructions for how to instrument the JavaScript tracker. You are encouraged to consult the technical documentation<\/a> for more information on each individual feature.<\/p>\n In general, when the tag fires, it first checks if the Snowplow JavaScript library has been loaded from the self-hosted URL provided in the template settings (more on this below). Then, the tag checks whether a tracker with the given Tracker Name<\/strong> has already been initialized. If not, it proceeds to initialize the new tracker.<\/p>\n Finally, the tag bundles a command<\/strong> from the settings in the tag, and sends it to the given Collector Endpoint<\/strong>.<\/p>\n The first field requires you to add the tracker name<\/strong>. The reason you might have more than one tracker name generated on the site is if you have different configuration objects or tracking endpoints to which you want to send commands.<\/p>\n When the tag runs, it first checks if a tag with this name has already been initialized. If it has, it then proceeds to send the command to this tracker name. If a tracker with this name has not<\/em> been initialized, a new tracker is initialized with the tracker configuration derived from the tag (or from the linked Snowplow Analytics Settings variable<\/a>).<\/p>\n This means that a tracker configuration is applied only once<\/strong> to the tracker. Thus if you have more than one tag running on the site, each with the same tracker name but different tracker configurations, only the configuration of the tag that fires first<\/em> will be applied to the tracker.<\/p>\n This needs to be set to the hostname (e.g. Jumping to the end of the template, the Advanced Configuration<\/strong> group has two important settings:<\/p>\n If you change the Global Method Name<\/strong> from <\/p>\n <\/a><\/p>\n<\/div>\n Change the text <\/p>\n <\/a><\/p>\n<\/div>\n UPDATE 18 May 2020<\/strong>: The template has been updated to have AWS Cloudfront<\/strong> and Google Cloud Storage<\/strong> destinations supported by default ( Next, once you have the Snowplow library self-hosted<\/a>, you need to update the Injects Scripts<\/strong> permission to reflect the new location. Delete the content of the Allowed URL Match Patterns<\/strong> field, and type the full URL to the library there. Again, it must match what you input into the tag itself when creating it.<\/p>\n <\/p>\n <\/a><\/p>\n<\/div>\n Unfortunately, modifying permissions breaks the gallery link<\/strong> and you will no longer be notified about updates to the template. Being able to modify permissions without having the link break is a feature request I hope will get solved very soon.<\/p>\n <\/p>\n <\/a><\/p>\n<\/div>\n Under Tag Type<\/strong>, you can choose what type of command is compiled and sent to the endpoint. The tag types are split here into three groups: commands that utilize a common parameters<\/strong> object, commands that have special conditions<\/strong>, and custom commands<\/strong>.<\/p>\n Tags that can derive their parameters from a Google Tag Manager variable are:<\/p>\n You can set the Retrieve Parameters From Variable<\/strong> setting to a Google Tag Manager variable. This parameter must<\/em> return an object. In the object, the key-value pairs should reflect the named parameters in the event documentation<\/a>. For example, to have the variable populate an Error event<\/a>, you could use a Custom JavaScript variable like this:<\/p>\n Alternatively, you can set the drop-down to the value <\/p>\n <\/a><\/p>\n<\/div>\n Some tag types will add additional selections to this section. Follow the official tracker documentation for more information about what each option does.<\/p>\n Some tag types have special conditions and have been separated into their own configurations.<\/p>\n When you select Enhanced Ecommerce, you are left with two options: Use Data Layer<\/strong> or Choose Variable<\/strong>. The way it works is very similar to Enhanced Ecommerce in Google Analytics.<\/p>\n If you choose the first, the template will look into the If you selected Choose Variable<\/strong>, you need to provide a GTM variable that returns an object in the correct, expected format.<\/p>\n Form tracking has just two options, because filters<\/strong> and transformations<\/strong> won\u2019t work with the custom template (due to lack of support for processing HTML elements). The options are to set form and\/or field blacklists<\/strong> and whitelists<\/strong>.<\/p>\n Blacklists and whitelists for forms are a list of comma-separated HTML class names. If blacklisted, then any form element with a listed class will not trigger the form event. If whitelisted, then only<\/em> form elements with a listed classname will be tracked.<\/p>\n For fields, blacklists and whitelists work similarly, except they use the The Track Link Click<\/strong> event is similar to regular parameter-based events, as it lets you add parameters and track a link click as a manually encoded hit.<\/p>\n The Enable Automatic Link Click Tracking<\/strong> adds listeners to the page, which will track clicks on links permitting they adhere to the blacklisted\/whitelisted class names you can optionally provide.<\/p>\n The Fix Middle-click Tracking<\/strong> adds a fix for some browsers where middle-clicks were not tracked properly.<\/p>\n If you check Track HTML Content Of Clicked Link<\/strong>, then the full text content of the link element will be sent to Snowplow as well.<\/p>\n You can provide a Custom Page Title<\/strong> if you wish, and you can add a custom context function<\/a> to the request.<\/p>\n If you enable Page Activity Tracking<\/strong>, the tag will setup a heartbeat<\/em> tracker, and send page pings to Snowplow at intervals that you can specify.<\/p>\n The Callback Function<\/strong> is something you can set to a JavaScript function. If you set the callback, then instead of sending the page ping to Snowplow, the function gets invoked instead.<\/p>\n Here is the list of custom commands you can execute, with details about the arguments (if any).<\/p>\n![\"Snowplow](\"https:\/\/www.simoahava.com\/images\/2020\/05\/snowplow-analytics.jpg\")
<\/p>\n<\/p>\nDescription<\/h2>\n
Install the template<\/h2>\n
snowplow<\/code> into the gallery overlay search bar.<\/p>\n<\/p>\nCaveats<\/h2>\n
\n
ErrorEvent<\/code> API.<\/li>\nInstructions<\/h2>\n
Tracker Name<\/h3>\n
Collector Endpoint Hostname<\/h3>\n
www.domain.com<\/code>) on which you\u2019ve configured the Snowplow Analytics collector<\/a>.<\/p>\nAdvanced Configuration<\/h3>\n
\n
snowplow<\/code> to something else (due to a conflict, for example), change the value in this field.<\/li>\nUpdate permissions<\/h4>\n
snowplow<\/code> to anything else, you need to make a change to the template<\/strong>. Open the template for editing (from the \u201cTemplates\u201d section of the container), and browse to the Permissions<\/strong> tab. Under Accesses Global Variables<\/strong>, edit the four permissions that start with the name snowplow<\/code>.<\/p>\n<\/p>\nsnowplow<\/code> to whatever your preferred method name is (it must match the name set in the tag once you create it). Remember to leave everything else as it is: permissions and suffixes. This is what the changed list would look like if the method name were changed to some_other_snowplow<\/code>:<\/p>\n<\/p>\n\n
https:\/\/*.cloudfront.net\/*<\/code> and https:\/\/storage.cloud.google.com\/*<\/code>). If you load the library from either location, you do not<\/strong> need to update permissions for injectScript<\/code>!<\/p>\n<\/blockquote>\n<\/p>\n<\/p>\nTag Type<\/h3>\n
Tags with a parameter object<\/h4>\n
\n
function<\/span>() {\n return<\/span> {\n message: 'Some Error Happened'<\/span>,\n filename: 'somefile.js'<\/span>,\n lineno: 5<\/span>,\n colno: 236<\/span>,\n error: null<\/span>\n }\n}\n<\/code><\/pre>\n<\/div>\nNo<\/code>, and add the parameters manually instead:<\/p>\n<\/p>\nSpecial tags<\/h4>\n
Enhanced Ecommerce<\/h5>\n
dataLayer<\/code> structure for the most recently<\/strong> pushed Enhanced Ecommerce object<\/a>, and map this object to the request to Snowplow Analytics.<\/p>\nForm Tracking<\/h5>\n
name<\/code> attribute rather than the class.<\/p>\nLink Click Tracking<\/h5>\n
Page View<\/h5>\n
Custom Commands<\/h4>\n