Difference between revisions of "ATC/Current/AdminGuide/Tracking snippet"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 10: Line 10:
 
** '''Journey '''>''' Settings''' > '''Edit''', or '''View''' permissions
 
** '''Journey '''>''' Settings''' > '''Edit''', or '''View''' permissions
 
|Section={{Section
 
|Section={{Section
 +
|sectionHeading=Overview
 +
|Type=Structured
 +
|anchor=Deploy
 +
|alignment=Horizontal
 +
|image=SnippetProcess.png
 +
|gif=No
 +
|structuredtext=# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#GetSnippet|display text=Copy the snippet.}}
 +
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#Customize|display text=Customize the snippet.}}
 +
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#TagManagers|display text=Deploy the snippet with your preferred tag manager.}}
 +
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#VerifySnippet|display text=Verify that the snippet works.}}
 +
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|display text=Configure web tracking.}}<br />
 +
|fullwidth=No
 +
|Status=No
 +
}}{{Section
 
|sectionHeading=Before you begin
 
|sectionHeading=Before you begin
 
|Type=Structured
 
|Type=Structured
Line 15: Line 29:
 
|gif=No
 
|gif=No
 
|structuredtext=Before you deploy the {{MINTYDOCSPRODUCT}} tracking snippet be sure you understand:
 
|structuredtext=Before you deploy the {{MINTYDOCSPRODUCT}} tracking snippet be sure you understand:
* How to deploy the tracking snippet to be compliant with {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}<br />
+
* How to deploy the tracking snippet to be compliant with {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.<br />
 
|fullwidth=No
 
|fullwidth=No
 
|Status=No
 
|Status=No
Line 35: Line 49:
  
 
}}
 
}}
===How uBlock affects {{MINTYDOCSPRODUCT}}<br />===
+
===How uBlock affects {{MINTYDOCSPRODUCT}}===
 
uBlock adversely affects {{MINTYDOCSPRODUCT}} in the following ways
 
uBlock adversely affects {{MINTYDOCSPRODUCT}} in the following ways
 
* If you use Google Tag Manager, uBlock prevents you from loading the tracking snippet and Journey JavaScript SDK.
 
* If you use Google Tag Manager, uBlock prevents you from loading the tracking snippet and Journey JavaScript SDK.
Line 42: Line 56:
 
|Status=Yes
 
|Status=Yes
 
}}{{Section
 
}}{{Section
|sectionHeading=Deploy the tracking snippet
+
|sectionHeading=Copy the snippet
 
|Type=Structured
 
|Type=Structured
|anchor=Deploy
+
|anchor=GetSnippet
 
|alignment=Vertical
 
|alignment=Vertical
 
|gif=No
 
|gif=No
|structuredtext=To deploy the tracking snippet:
+
|structuredtext={{ComingSoon}}
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#GetSnippet|display text=Get the snippet.}}
+
# Click '''Admin'''.
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#WhereToDeploy|display text=Identify where to deploy the snippet.}}
 
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#TagManagers|display text=Use a tag manager.}}
 
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#Customize|display text=Customize the snippet.}}
 
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#VerifySnippet|display text=Verify that the snippet works.}}
 
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#TroubleshootSnippet|display text=Troubleshoot the snippet.}}
 
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#ErrorSnippet|display text=Review error messages.}}
 
|fullwidth=No
 
|Status=No
 
}}{{Section
 
|sectionHeading=Get the snippet
 
|Type=Structured
 
|anchor=GetSnippet
 
|alignment=Horizontal
 
|image=ScriptTags.png
 
|gif=No
 
|structuredtext=# Click '''Admin'''.
 
 
# Under '''Altocloud''', click '''Tracking Snippet'''. <br />
 
# Under '''Altocloud''', click '''Tracking Snippet'''. <br />
# {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#SelectSnippet|display text=Select the type of snippet you need.}}
+
# To determine which snippet to use:
# Copy the code.
+
#* Read about the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#TypesofSnippets|display text=types of snippets.}}<br />
 
+
#* Review the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|anchor=SnippetRecs|display text=snippet recommendations|display text=snippet recommendations.}}<br />
{{NoteFormat|
+
# Use a text editor to copy the snippet.<br />Since you are logged in to PureCloud, the {{MINTYDOCSPRODUCT}} tracking snippet already contains your organization ID and Genesys region.
*Since you are logged in to PureCloud, the {{MINTYDOCSPRODUCT}} tracking snippet already contains your organization ID and your Genesys region.
+
|fullwidth=Yes
# When you copy the Altocloud tracking snippet into your {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#TagManagers|display text=tag manager}}, remove both script tags.
+
|structuredtextwide={{NoteFormat|
* If you copy and paste the tracking snippet into an email or other editing program, that program may insert or replace characters in the tracking snippet. If you need to copy and paste the tracking snippet, use a text editor to ensure a clean copy and paste.}}
+
* Use a text editor to ensure a clean copy and paste. Other programs may insert or replace characters in the tracking snippet. }}
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Types of tracking snippets
 
|sectionHeading=Types of tracking snippets
 
|Type=Structured
 
|Type=Structured
|anchor=SelectSnippet
+
|anchor=TypesofSnippets
 
|alignment=Vertical
 
|alignment=Vertical
 
|gif=No
 
|gif=No
|structuredtext=Select the appropriate {{MINTYDOCSPRODUCT}} tracking snippet for your environment.
+
|structuredtext={{ComingSoon}}{{MINTYDOCSPRODUCT}} provides the following types of snippets:
===Basic snippet===
+
* Website snippet
The basic snippet provides tracking support to traditional webpages that contain little or nodynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the basic snippet calls <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview|display text=ac('pageview')}}</tt> each time the a new page is loaded by the web browser.
+
* SPA snippet
 +
 
 +
===Website snippet===
 +
The Website snippet provides tracking support to traditional webpages that contain little or nodynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the Website snippet calls <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview|display text=ac('pageview')}}</tt> each time the a new page is loaded by the web browser.
  
 
<source lang="javascript">
 
<source lang="javascript">
Line 95: Line 95:
 
</script>
 
</script>
 
</source>
 
</source>
 +
===SPA snippet===
 +
The SPA snippet can track activity on Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. The SPA snippet can also track when users click relative links, which the Website snippet does not. The SPA snippet works on SPAs such as Angular, React, Vue.js, and so on. For more information about the additional tracking options available with the SPA snippet, see {{Link-SomewhereInThisVersion|manual=SDK|topic=autoTrackURLChange}}.
  
 
+
<source lang="javascript">
===Advanced snippet===
+
<script>
The advanced snippet provides tracking support to Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. Additionally, this functionality can track {{GlossaryTooltip|term=relative links}}, which the traditional snippet does not. The SPA snippet works on any framework that you use with your SPA, including Angular, React, Vue.js, and so on.
+
  (function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
 +
  (a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
 +
  d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d)
 +
  })(window, document, 'script', 'https://apps.inindca.com/journey/sdk/js/web/v1/ac.js', 'ac');
 +
  ac('init', 'a061a3fe-7a80-4b50-9d3b-df88c0f9efad', { environment: 'dev' });
 +
  ac('load', 'autotrackUrlChange');
 +
</script>
 +
</source>
 
|fullwidth=No
 
|fullwidth=No
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Where to deploy the snippet
+
|sectionHeading=Snippet recommendations
 
|Type=Structured
 
|Type=Structured
|anchor=WhereToDeploy
+
|anchor=SnippetRecs
 
|alignment=Vertical
 
|alignment=Vertical
 
|gif=No
 
|gif=No
|structuredtext={{NoteFormat|Do not deploy any {{MINTYDOCSPRODUCT}} tracking snippet on any page that collects payment information.|3}}
+
|structuredtext={{ComingSoon}}
* Deploy the {{MINTYDOCSPRODUCT}} tracking snippet on the main page of the website you want to track.  
+
{{{!}} class="wikitable" style="font-size: 14px;"
* Paste the {{MINTYDOCSPRODUCT}} tracking snippet in the element of the website template page before the closing tag.
+
{{!}}-
* Do not deploy the tracking snippet in an iframe.
+
{{!}}{{!}}'''If you have this type of website...'''
 +
{{!}}{{!}}'''Use this snippet...'''
 +
{{!}}-
 +
{{!}}{{!}}Not sure
 +
{{!}}{{!}}SPA
 +
{{!}}-
 +
{{!}}{{!}}Mix of traditional and SPA pages
 +
{{!}}{{!}}SPA
 +
{{!}}-
 +
{{!}}{{!}}Traditional pages only
 +
{{!}}{{!}}Website
 +
{{!}}}
 
|fullwidth=No
 
|fullwidth=No
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Tag managers
+
|sectionHeading=Customize how the snippet tracks activity
|FAQHeading=Why doesn't my tag management system properly deploy the tracking snippet?
 
 
|Type=Structured
 
|Type=Structured
|anchor=TagManagers
+
|anchor=Customize
 
|alignment=Vertical
 
|alignment=Vertical
 
|gif=No
 
|gif=No
|structuredtext=To easily deploy the {{MINTYDOCSPRODUCT}} tracking snippet, use a tag management system such as:
+
|structuredtext=* If you need to refine how {{MINTYDOCSPRODUCT}} tracks activity on your website, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=About_event_tracking}}.
* {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#GoogleTagMgr|display text=Google Tag Manager}}
+
* You can also customize the {{MINTYDOCSPRODUCT}} tracking snippet with functions from the {{Link-SomewhereInThisVersion|manual=SDK}}. For example:
* Adobe Launch
+
** {{Link-SomewhereInThisVersion|manual=SDK|display text=Use the Journey JavaScript SDK to track page view events and to configure how Altocloud updates cookies. }}
* Tealium
+
** {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking to enable tracking across multiple domains.}}
 
|fullwidth=No
 
|fullwidth=No
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Google Tag Manager
+
|sectionHeading=Deploy the snippet with a tag manager
 +
|FAQHeading=Why doesn't my tag management system properly deploy the tracking snippet?
 
|Type=Structured
 
|Type=Structured
|anchor=GoogleTagMgr
+
|anchor=TagManagers
|alignment=Vertical
+
|alignment=Horizontal
 +
|image=ScriptTags.png
 
|gif=No
 
|gif=No
|structuredtext=Google Tag Manager provides numerous predefined triggers and tags to refine the {{MINTYDOCSPRODUCT}} tracking snippet. For example:
+
|structuredtext=To easily deploy the {{MINTYDOCSPRODUCT}} tracking snippet, use your preferred tag manager. For example:
* Click element
+
* {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Google_Tag_Manager}}
* Click class
+
* {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Adobe_Launch|display text=Adobe Launch}}<br />
* Click ID
+
* Any other tag manager
* Click Target
+
|fullwidth=Yes
* Click URL
+
|structuredtextwide====Deployment notes===
* Click TextErrors
+
 
* Error Message
+
* Deploy the {{MINTYDOCSPRODUCT}} tracking snippet on the main page of the website you want to track.  
* Error URL
+
* Remove the script tags.
* Error LineForms
+
* Paste the tracking snippet in the element of the website template page before the closing tag.
* Form Classes
+
* Paste the snippet in the head section.
* Form Element
+
* Do not deploy the tracking snippet in an iframe.
* Form ID
 
* Form Target
 
* Form Text
 
* Form URLScroll
 
* Scroll Depth Threshold
 
* Scroll Depth Units
 
* Scroll Direction
 
For complete information on the custom tags that are available with Google Tag Manager, see [https://support.google.com/tagmanager/answer/6107167?hl=en&reftopic=3002579&authuser=0  Custom tags].
 
|fullwidth=No
 
|Status=No
 
}}{{Section
 
|sectionHeading=Customize the snippet
 
|Type=Structured
 
|anchor=Customize
 
|alignment=Vertical
 
|gif=No
 
|structuredtext=* If you need to refine how {{MINTYDOCSPRODUCT}} tracks activity on your website, use the predefined custom tags that your {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=tag manager}} provides. For example:
 
** {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet#GoogleTagMgr|display text=Examples from Google Tag Manager}}
 
* If your tag manager's predefined tags do not provide the level of customization you need, customize the {{MINTYDOCSPRODUCT}} tracking snippet with functions from the {{Link-SomewhereInThisVersion|manual=SDK}}. For example:
 
** {{Link-SomewhereInThisVersion|manual=SDK|display text=Use the Journey JavaScript SDK to track page view events and to configure how Altocloud updates cookies. }}
 
** {{Link-SomewhereInThisVersion|manual=SDK|topic=Configure_advanced_tracking|display text=Configure advanced tracking to enable tracking across multiple domains.}}
 
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 174: Line 173:
 
|gif=No
 
|gif=No
 
|structuredtext=When the tracking snippet is properly executed and initialized:
 
|structuredtext=When the tracking snippet is properly executed and initialized:
* You should receive a ping every 4-5 seconds.
+
* Use Live Now to verify that {{MINTYDOCSPRODUCT}} is tracking your website activity.
* The ping should return status code 200.
+
* You should see an update every 4-5 seconds.<br />
 
|fullwidth=No
 
|fullwidth=No
 
|Status=No
 
|Status=No

Revision as of 18:45, October 10, 2019

Deploy the Genesys Predictive Engagement tracking snippet to enable visitor tracking on your website.

Prerequisites

Overview

Before you begin

Before you deploy the Genesys Predictive Engagement tracking snippet be sure you understand:

Ad blockers

9/17: David Trihy to create a research spike on ad blockers in general for next sprint (38)When this is ironed out, add this text to the Before you begin section as Step 2:


The effects of [#AdBlockers ad blockers]

on Altocloud.
Ad blockers are plug-ins or browser extensions that prevent tracking software, such as trackers used for advertising purposes, from running on a website. Because Genesys Predictive Engagement is a type of tracking software, some ad blockers detect and block it.
Important
Do not use uBlock on any webpages that you want to track with Altocloud.

This is not accurate. We can't control when our customers' customers install uBlock. What we really need to say is that our customers need to prompt their customers to disable any ad blockers in order to experience the best user experience on their site.

How uBlock affects Genesys Predictive Engagement

uBlock adversely affects Genesys Predictive Engagement in the following ways

  • If you use Google Tag Manager, uBlock prevents you from loading the tracking snippet and Journey JavaScript SDK.
  • If you use a different JavaScript management approach, the tracking snippet and Journey JavaScript load on your webpages. However, Altocloud will be unable to send beacons or register cookies, effectively preventing it from working as expected.

Copy the snippet

Feature coming soon
  1. Click Admin.
  2. Under Altocloud, click Tracking Snippet.
  3. To determine which snippet to use:
  4. Use a text editor to copy the snippet.
    Since you are logged in to PureCloud, the Genesys Predictive Engagement tracking snippet already contains your organization ID and Genesys region.
Important
  • Use a text editor to ensure a clean copy and paste. Other programs may insert or replace characters in the tracking snippet.

Types of tracking snippets

Feature coming soon
Genesys Predictive Engagement provides the following types of snippets:
  • Website snippet
  • SPA snippet

Website snippet

The Website snippet provides tracking support to traditional webpages that contain little or nodynamic content. Traditional websites load a new HTML page whenever the user navigates to a different URL. To provide tracking support to traditional webpages, the Website snippet calls ac('pageview') each time the a new page is loaded by the web browser.

<script>
  (function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
  (a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
  d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d)
  })(window, document, 'script', 'https://example.com, 'ac');
  ac('init', 'a061a3fe-7a80-4b50-9d3b-df88c0f9efad', { region: 'use1' });
  ac('pageview');
</script>

SPA snippet

The SPA snippet can track activity on Single Page Applications (SPAs). SPAs load dynamic content on demand without requiring a hard reload of the HTML page. The SPA snippet can also track when users click relative links, which the Website snippet does not. The SPA snippet works on SPAs such as Angular, React, Vue.js, and so on. For more information about the additional tracking options available with the SPA snippet, see [[ATC/Current/SDK/autoTrackURLChange|]].

<script>
  (function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
  (a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
  d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d)
  })(window, document, 'script', 'https://apps.inindca.com/journey/sdk/js/web/v1/ac.js', 'ac');
  ac('init', 'a061a3fe-7a80-4b50-9d3b-df88c0f9efad', { environment: 'dev' });
  ac('load', 'autotrackUrlChange');
</script>

Snippet recommendations

Feature coming soon
If you have this type of website... Use this snippet...
Not sure SPA
Mix of traditional and SPA pages SPA
Traditional pages only Website

Customize how the snippet tracks activity

Deploy the snippet with a tag manager

To easily deploy the Genesys Predictive Engagement tracking snippet, use your preferred tag manager. For example:

  • [[ATC/Current/AdminGuide/Google_Tag_Manager|]]
  • Adobe Launch
  • Any other tag manager

Deployment notes

  • Deploy the Genesys Predictive Engagement tracking snippet on the main page of the website you want to track.
  • Remove the script tags.
  • Paste the tracking snippet in the element of the website template page before the closing tag.
  • Paste the snippet in the head section.
  • Do not deploy the tracking snippet in an iframe.

Verify that the snippet works

When the tracking snippet is properly executed and initialized:

  • Use Live Now to verify that Genesys Predictive Engagement is tracking your website activity.
  • You should see an update every 4-5 seconds.

Troubleshoot the snippet

If the tracking snippet does not work properly when you load it on your web pages, check the following things:
* Is the snippet on the correct page?
* Is the snippet correctly placed in the header?
* Are all of the parameters specified correctly?
* Are there any typos, missing characters, or extra white space?

Error reference

Comments or questions about this documentation? Contact us for support!