Difference between revisions of "ATC/Current/AdminGuide/Tracking snippet"
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (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}} | + | ===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= | + | |sectionHeading=Copy the snippet |
|Type=Structured | |Type=Structured | ||
− | |anchor= | + | |anchor=GetSnippet |
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
− | |structuredtext= | + | |structuredtext={{ComingSoon}} |
− | + | # Click '''Admin'''. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | }} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
# Under '''Altocloud''', click '''Tracking Snippet'''. <br /> | # Under '''Altocloud''', click '''Tracking Snippet'''. <br /> | ||
− | # {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet# | + | # To determine which snippet to use: |
− | # | + | #* 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 /> | |
− | {{ | + | # 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. |
− | + | |fullwidth=Yes | |
− | + | |structuredtextwide={{NoteFormat| | |
− | * | + | * Use a text editor to ensure a clean copy and paste. Other programs may insert or replace characters in the tracking snippet. }} |
− | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Types of tracking snippets | |sectionHeading=Types of tracking snippets | ||
|Type=Structured | |Type=Structured | ||
− | |anchor= | + | |anchor=TypesofSnippets |
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
− | |structuredtext= | + | |structuredtext={{ComingSoon}}{{MINTYDOCSPRODUCT}} provides the following types of snippets: |
− | === | + | * Website snippet |
− | The | + | * 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"> | |
− | === | + | <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> | ||
+ | </source> | ||
|fullwidth=No | |fullwidth=No | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
− | |sectionHeading= | + | |sectionHeading=Snippet recommendations |
|Type=Structured | |Type=Structured | ||
− | |anchor= | + | |anchor=SnippetRecs |
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
− | |structuredtext={{ | + | |structuredtext={{ComingSoon}} |
− | + | {{{!}} class="wikitable" style="font-size: 14px;" | |
− | + | {{!}}- | |
− | + | {{!}}{{!}}'''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= | + | |sectionHeading=Customize how the snippet tracks activity |
− | |||
|Type=Structured | |Type=Structured | ||
− | |anchor= | + | |anchor=Customize |
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
− | |structuredtext= | + | |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= | + | * You can also 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 | |fullwidth=No | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
− | |sectionHeading= | + | |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= | + | |anchor=TagManagers |
− | |alignment= | + | |alignment=Horizontal |
+ | |image=ScriptTags.png | ||
|gif=No | |gif=No | ||
− | |structuredtext= | + | |structuredtext=To easily deploy the {{MINTYDOCSPRODUCT}} tracking snippet, use your preferred tag manager. For example: |
− | * | + | * {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Google_Tag_Manager}} |
− | + | * {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Adobe_Launch|display text=Adobe Launch}}<br /> | |
− | + | * Any other tag manager | |
− | + | |fullwidth=Yes | |
− | + | |structuredtextwide====Deployment notes=== | |
− | + | ||
− | + | * Deploy the {{MINTYDOCSPRODUCT}} 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. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | ** | ||
− | ** | ||
− | |||
|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 | + | * Use Live Now to verify that {{MINTYDOCSPRODUCT}} is tracking your website activity. |
− | + | * 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
Contents
Deploy the Genesys Predictive Engagement tracking snippet to enable visitor tracking on your website.
Prerequisites
- Configure the following permissions in PureCloud:
- Journey > Settings > Edit, or View permissions
Overview
Before you begin
Before you deploy the Genesys Predictive Engagement tracking snippet be sure you understand:
- How to deploy the tracking snippet to be compliant with General Data Protection Regulation (GDPR).
Copy the snippet
- Click Admin.
- Under Altocloud, click Tracking Snippet.
- To determine which snippet to use:
- Read about the types of snippets.
- Review the snippet recommendations.
- Read about the types of snippets.
- 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.
- 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
- 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
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
- If you need to refine how Genesys Predictive Engagement tracks activity on your website, see [[ATC/Current/AdminGuide/About_event_tracking|]].
- You can also customize the Genesys Predictive Engagement tracking snippet with functions from the Journey JavaScript SDK. For example:
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?