Difference between revisions of "ATC/Current/SDK/autotrackScrollDepth"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 3: | Line 3: | ||
|DisplayName=autotrackScrollDepth | |DisplayName=autotrackScrollDepth | ||
|TocName=autotrackScrollDepth | |TocName=autotrackScrollDepth | ||
| − | |Context=Learn how to configure which scroll milestones {{MINTYDOCSPRODUCT}} tracks on your | + | |Context=Learn how to configure which scroll milestones {{MINTYDOCSPRODUCT}} tracks on your web sites. This configuration provides more accurate page tracking information for use in segments and outcomes. |
|Dimension=Modules | |Dimension=Modules | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform=GenesysEngage-cloud | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
|anchor=Description | |anchor=Description | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |structuredtext=The <code>autotrackScrollDepth</code> module tracks when the user scrolls to see a specific percentage of a webpage. To use <code>autotrackScrollDepth</code>, | + | |structuredtext=The <code>autotrackScrollDepth</code> module tracks when the user scrolls to see a specific percentage of a webpage. To use <code>autotrackScrollDepth</code>, configure the click events to track using the following options: |
| − | *Config | + | *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackScrollDepth|anchor=Config|display text=Config}} |
| − | *Callback | + | *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackScrollDepth|anchor=Callback|display text=Callback}} |
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 43: | Line 43: | ||
|anchor=Config | |anchor=Config | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |structuredtext=Description: identifies an array of scroll depths that should be tracked. | + | |structuredtext='''Description:''' identifies an array of scroll depths that should be tracked. |
| − | Type: object | + | '''Type:''' object |
| − | Properties: | + | '''Properties:''' See the following table. |
{{{!}} class="wikitable" role="grid" | {{{!}} class="wikitable" role="grid" | ||
! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Name: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Name | ! class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" scope="col" role="columnheader" aria-label="Name: No sort applied, activate to apply an ascending sort" tabindex="0" aria-disabled="false" unselectable="on" aria-sort="none"{{!}}Name | ||
| Line 56: | Line 56: | ||
{{!}}- role="row" | {{!}}- role="row" | ||
{{!}} class="confluenceTd"{{!}}percentage | {{!}} class="confluenceTd"{{!}}percentage | ||
| − | {{!}} class="confluenceTd"{{!}} | + | {{!}} class="confluenceTd"{{!}}String that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches |
{{!}} class="confluenceTd"{{!}}Number (0 - 100) | {{!}} class="confluenceTd"{{!}}Number (0 - 100) | ||
{{!}} class="confluenceTd"{{!}}required | {{!}} class="confluenceTd"{{!}}required | ||
| Line 62: | Line 62: | ||
{{!}}- role="row" | {{!}}- role="row" | ||
{{!}} class="confluenceTd"{{!}}eventName | {{!}} class="confluenceTd"{{!}}eventName | ||
| − | {{!}} class="confluenceTd"{{!}} | + | {{!}} class="confluenceTd"{{!}}String used as the event name when an element matching the selector is clicked. |
{{!}} class="confluenceTd"{{!}}String | {{!}} class="confluenceTd"{{!}}String | ||
{{!}} class="confluenceTd"{{!}}optional | {{!}} class="confluenceTd"{{!}}optional | ||
| Line 84: | Line 84: | ||
|anchor=Callback | |anchor=Callback | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |structuredtext=When a module | + | |structuredtext=When a module loads, callback is executed. No arguments pass to the callback. |
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 17:56, December 16, 2020
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
Learn how to configure which scroll milestones Genesys Predictive Engagement tracks on your web sites. This configuration provides more accurate page tracking information for use in segments and outcomes.
Description
The autotrackScrollDepth module tracks when the user scrolls to see a specific percentage of a webpage. To use autotrackScrollDepth, configure the click events to track using the following options:
Signature
ac('load', 'autotrackScrollDepth', config, [callback]);Example
ac('load', 'autotrackScrollDepth', {
scrollDepthEvents: [
{ percentage: 75, eventName: 'scroll_depth_75' },
{ percentage: 100, eventName: 'scroll_depth_100' }
]
}, function () {
console.log('"autotrackScrollDepth" has been loaded');
});Config (required)
Description: identifies an array of scroll depths that should be tracked.
Type: object
Properties: See the following table.
| Name | Description | Type | Status | Default |
|---|---|---|---|---|
| percentage | String that selects elements. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Element/matches | Number (0 - 100) | required | NA |
| eventName | String used as the event name when an element matching the selector is clicked. | String | optional | scroll_depth_<percentage>
eg if "percentage" = 75, eventName defaults to "scroll_depth_75" |
Example
{
scrollDepthEvents: [
{ percentage: 50 },
{ percentage: 100, eventName: 'viewed_full_page' },
]
}Callback (optional)
When a module loads, callback is executed. No arguments pass to the callback.
Comments or questions about this documentation? Contact us for support!