Webtrekk Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Documentation Webtrekk GmbH | Robert-Koch-Platz 4 | 10115 Berlin Webtrekk Support | [email protected] Teaser Tracking Plugin (v2) Table of Contents 1 Disclaimer 3 1.1 Introduction 4 2 Technical Requirements 5 2.1 Browser Support 5 3 Creating Teaser Parameters 6 4 Configuring and Activating the Plugin 8 4.1 Tag Integration (Web) 8 4.2 JavaScript 10 5 Initializing the Teaser Elements 13 6 Best Practices 16 6.1 View Tracking with Dynamic Teaser Insertion 16 6.2 View Tracking 17 6.3 Customizing a Website Goal 18 6.4 Customizing the Engagement Page 18 12/13/2018 2/18 Teaser Tracking Plugin (v2) 1 Disclaimer This manual is the intellectual property of Webtrekk GmbH. This includes the contents but also all images, tables, and drawings. Change or removal of copyright notices, registering mark or control numbers are not allowed. Any use not permitted by German copyright law requires the prior written consent of the respective author or creator. This applies in particular to reproduction, editing, translation, storage, processing or distribution of contents in databases or other electronic media and systems. Webtrekk GmbH allows the use of the content solely for the contractual purpose. It should be noted that the contents of this manual may be subject to changes, without that a reporting obligation on the part of Webtrekk GmbH can be derived from this. Users of this manual must independently obtain information themselves, whether modified versions or notes to the contents are present, for example on the Internet at https://docs.webtrekk.com/, and take these into account during operation. All information provided in this manual is made available by Webtrekk GmbH. Webtrekk GmbH assumes no liability or warranty for errors or omissions in this manual, but avow for products and services according to the agreement which is expressly laid down for the respective products and services. The information contained in this manual result in no further liability. Webtrekk GmbH Robert-Koch-Platz 4 10115 Berlin Germany Phone +49 030 - 755 415 - 0 Fax +49 030 - 755 415 - 100 [email protected] www.webtrekk.com 12/13/2018 Teaser Tracking Plugin - Online 3/18 Teaser Tracking Plugin (v2) 1.1 Introduction Teasers are image/ text elements that serve to attract attention and redirect your website visitors to a specific page or offer that you have defined. If you want to optimize teasers, you need more detailed information about the use of teasers. Not only which teaser elements were clicked on, but also which clicks led to orders, contact requests, etc. at the end. With the teaser tracking plugin, you have the possibility of extensive analyses of your onsite teasers. By integrating the plugin, teaser views and clicks are automatically captured on your website. If you specify additional parameters, you can also describe them in detail and evaluate them in combination with your web analytics data. To evaluate the impact of a single teaser, in addition to views and clicks, engagement and conversion are calculated. The engagement measurement for a specific teaser is initiated as soon as it is clicked. For each page call that follows a teaser click, its engagement value is increased by 1. This happens until a website goal is reached or the user ends his visit to the website. The display of all values recorded with the plugin is teaser accurate - either with aggregated daily values or in Webtrekk Live Analytics for the periods that can be set there. If you need other information, you can still enter it as your action parameters. In the JavaScript file of the teaser tracking or Tag Integration, you can configure how many percents must be visible, and after how many milliseconds the request should be submitted. This documentation describes the configuration and technical integration for using the teaser tracking plugin. 12/13/2018 Teaser Tracking Plugin - Online 4/18 Teaser Tracking Plugin (v2) 2 Technical Requirements Please note the following technical requirements for a successful installation of the plugin: The plugin only works with Webtrekk Tracking Pixel version 3.2.x or higher. Required parameters have to be activated and configured (contact the Webtrekk support team if necessary). Teaser elements must be initialized. 2.1 Browser Support The teaser tracking plugin uses the "querySelector" method to search for the teasers to be measured. The following browsers support this method: Internet Explorer from version 8 Microsoft Edge Firefox from version 3.5 Google Chrome Safari from version 3 Opera from version 10 12/13/2018 Teaser Tracking Plugin - Online 5/18 Teaser Tracking Plugin (v2) 3 Creating Teaser Parameters The captured teaser information appears in Webtrekk as action parameters. You must first create these action parameters in Webtrekk Q3. 1. Log in to your Webtrekk Q3 account. 2. Go to Configuration > Custom Parameters. 3. Open the "Event parameter" tab. A list of all existing event parameters appears. 4. Click [Create new custom parameter]. You are forwarded to the specification dialog for custom parameters. 5. Make the following settings: Parameter Description Title Specify a title. Description Enter a meaningful description of the parameter. This description is displayed when you call the help for this parameter. Active Activate the parameter with the corresponding radio button. 12/13/2018 Teaser Tracking Plugin - Online 6/18 Teaser Tracking Plugin (v2) Parameter Description Preconfigured Select the required entry from the drop-down menu: Teaser - Placement (ID: 520) Teaser - Name (ID: 521) Teaser - Views (ID: 523) Teaser - Clicks (ID: 524) Teaser - Page Engagement (ID: 525) Teaser - Content (ID: 526) Teaser - Variant (ID: 527) Teaser - Conversion (ID: 528) Parameter ID The ID is set automatically by the system. Data type Select from the dropdown list the required data type: Figure This parameter is available as a metric. You can also select the figure type, see "Aggregation" below. Text This parameter is available as a dimension. The number of possible values is contractually agreed. Generic This parameter is available as a dimension. Allows the unlimited storing of information. Aggregation If you have selected the data type "Figure," you can also specify the figure type. Quantity: shows how often a parameter was tracked. Quantity and sum: a metric is generated that ads up the tracked values. Example A parameter is submitted twice, once with the value 5 and once with the value 3. "Quantity" is 2, "Sum" is 8. 12/13/2018 Teaser Tracking Plugin - Online 7/18 Teaser Tracking Plugin (v2) Parameter Description Amount You can specify the number of parameter values. This defines whether you parameter values pass single information or a range of information simultaneously. From the dropdown list, choose: Single value: A single information will be submitted Several values: Multiple values will be provided. 6. Click [Save] to save your settings. The event parameter is created and appears in the "Custom Parameters" overview. 4 Configuring and Activating the Plugin The plugin is available in Tag Integration. Alternatively, you can integrate it in the standard pixel as a separate JavaScript file. 4.1 Tag Integration (Web) Integrate the teaser tracking plugin into the container in which the webpage to be measured is located. To add plugins the desired container, proceed as follows: 1. In the container overview, select the required container by clicking the corresponding entry. 2. Click [Add Plugin]. You will be forwarded to the overview of all available plugins. 12/13/2018 Teaser Tracking Plugin - Online 8/18 Teaser Tracking Plugin (v2) 3. Select the "Teaser tracking plugin" by clicking the appropriate button. The plugin configuration dialog opens. 4. Now enter the following information: Parameter Description Attribute name Mandatory. Specify the attribute name of the teaser element containing the teaser information (compatibility mode for teaser tracking version 1). Delete teaser cookie Optional. Activate the checkbox to determine that the cookie in which after conversion the teaser information is stored will be deleted after a successful conversion. Send engagement Optional. Activate the checkbox to specify that teaser engagements automatically are sent automatically. When sending manually, you must define the variable "wt_teaserEngagements" on the desired pages. 12/13/2018 Teaser Tracking Plugin - Online 9/18 Teaser Tracking Plugin (v2) Parameter Description Additional conversion Optional. pages Engagement pages Optional. 5. In the "Assign rules" area, you define the page areas on which the measurement is to be carried out. 6. Finally, click [Add plugin]. 4.2 JavaScript Since version 3.2.x of the Webtrekk tracking script, the use of plugins is supported. A plugin is all JavaScript functions that are transferred to the Webtrekk pixel. For the integration of the teaser tracking plugin, you need the JavaScript file "pixel-teasertracking- v2.min.js." 1. Download the JavaScript file "pixel-teasertracking-v2.min.js" from the download area . 2. The configuration object "wt_teaserTrackingConfig_v2" is located inside the plugin. Make the following adjustment: 12/13/2018 Teaser Tracking Plugin - Online 10/18 Teaser Tracking Plugin (v2) Example window.wt_teaserTracking = function(conf) { if ((conf.mode === "page" || conf.mode === "config") && conf.requestCounter === 1) { var wt_teaserTrackingConfig_v2 = window.wt_teaserTrackingConfig_v2 || { teaserAttribute: "", viewPercent: 100, viewTime: 1000, attribution: "all", maxSendTeasers: { session: 10000, page: