Wiki source code of Widget Implementation -- oc.min.js
Last modified by Admin User on 2025/06/27 12:15
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
7.1 | 1 | {{layout}} |
| 2 | {{layout-section ac:type="two_right_sidebar"}} | ||
| 3 | {{layout-cell}} | ||
| |
3.1 | 4 | {{id name="Start ScreenSteps Content"/}} |
| |
40.1 | 5 | (% style="color:#808080" %)// In order to identify users and track activity, widgets must be embedded on every page of your web site .// |
| |
3.1 | 6 | |
| |
40.1 | 7 | (% style="color:#808080" %)//These widgets, specific to your site(s), and directions for placement are provided in the Widget Builder.// |
| |
3.1 | 8 | |
| |
5.1 | 9 | === ONEcount Library/Tracker === |
| |
3.1 | 10 | |
| 11 | This javascript snippet controls gating/access, cookie setting, and handles web tracking_**.**_ | ||
| 12 | |||
| 13 | Access protection: Pages or sections of pages that are defined as a resource in ONEcount and that require registration/ signup are handled by this widget. If a resource is being accessed and the user that is trying to access it is not logged in or doesn't have access to that particular resource, then they will be directed to the lookup/ login page (or if lookup/login is set to "off", to the registration form enabled with progressive lookup functionality) where they can log in or complete registration. | ||
| 14 | |||
| |
40.1 | 15 | This widget also allows users who have clicked on a smartlink(% style="color:#ff0000" %)*(%%) to automatically be logged in to ONEcount, as well as users identified by a ONEcount cookie-sync with other third-party identification systems you may use. In either case, ONEcount will identify the user and set a cookie for her/him. Any subsequent action by that user on the site will then be tracked and attributed to that user (via tracking widget). These users are included in statistics for Known Users. Note that if a user goes directly to the website (not directed there by a smartlink) and is NOT logged in, he/she will NOT be identified and tracked as a Known User. A user must be logged in to be identified. |
| |
3.1 | 16 | |
| 17 | This widget also tracks all web activity. | ||
| 18 | |||
| |
32.1 | 19 | ==== ONEcount Library/Tracker Placement: ==== |
| |
3.1 | 20 | |
| |
40.1 | 21 | The main ONEcount widget, (oc.min.js) is responsible for loading most of the code that ONEcount uses when a user visits your web site. It also takes the first step in identifying visitors to your web site, so it’s important it be placed properly on the site. |
| |
32.1 | 22 | |
| |
38.1 | 23 | Tag management platforms can be used as long as you can control where the ONEcount widget loads. Because order and placement is often difficult for users to configure, we recommend placing the ONEcount widget directly on the page, as the first element in the document <HEAD>. For further reading on fun with Google Tag Manager, read [[here.>>url:https://www.simoahava.com/gtm-tips/gtm-container-snippet-in-the-head/||shape="rect"]] |
| |
32.1 | 24 | |
| |
36.1 | 25 | ONEcount uses first-party cookies to track user behavior and target users. There are two main cookies that are important here: the OCID cookie, which identifies a user who exists as a user in the ONEcount database (ie., a “known” user), and the tmpcookie, which is a tracking cookie assigned to all users, known and unknown. If a user has a tmpcookie in their browser, ONEcount can track and target the user. If the user also has an OCID cookie in their browser, ONEcount can match that browser to a record in your database. |
| |
32.1 | 26 | |
| 27 | These cookies exist in two domains: the “local” domain for your web site or one of your web sites, and the “central” domain ([[onecount.net>>url:http://onecount.net||shape="rect"]]). ONEcount is designed for multi-site identification; a user who logs in on your Site A, can also be logged in on your Site B via the central domain cookie. | ||
| 28 | |||
| |
37.1 | 29 | When the page loads, the ONEcount widget checks the local domain for the tmpcookie. If the user is visiting your site for the first time, he or she may not have a local domain tmpcookie. The ONEcount widget then checks the ONEcount central domain ([[onecount.net>>url:http://onecount.net||shape="rect"]]) to see if the user has a first-party tmpcookie in that domain. If there is a tmpcookie in the central domain, the ONEcount widget reloads the page and sets a tmpcookie in the local domain. When a user is identified through a registration, cookie-sync or link-click, the OCID cookie is created in both the local and central domains during the subsequent page load. |
| |
32.1 | 30 | |
| 31 | ~*~*Please note that these central domain cookies are //customer-specific//, and we do not share those cookies between customers. | ||
| 32 | |||
| 33 | The main ONEcount widget is as follows: | ||
| 34 | |||
| |
40.1 | 35 | <script id="oc-widget-main" src="https:~/~/validate.onecount.net/js/oc.min.js#%%%%%%%%%%%%%%%%"></script> |
| |
32.1 | 36 | |
| |
35.1 | 37 | Most US-based customers will get the fastest response downloading the widget from our data centers in New Jersey and Illinois using the URL above. Customers with a presence outside the United States may experience lower latency by downloading the main ONEcount widget from our global CDN. To do that, simply substitute the hostname "cdn.onecount.net" for "validate.onecount.net in the URL above. As illustrated here: |
| |
32.1 | 38 | |
| |
40.1 | 39 | <script id="oc-widget-main" src="https:~/~/cdn.onecount.net/js/oc.min.js#%%%%%%%%%%%%%%%%"></script> |
| |
35.1 | 40 | |
| 41 | The widget includes a unique customer identifier that will be unique to your installation of ONEcount. You should place the widget in the header of the root template of your web site(s) so it can load on every page you would like ONEcount to track. | ||
| 42 | |||
| |
32.1 | 43 | The main widget should be placed in the document header, after the Title and Meta Keywords tags so that these values can be available to the ONEcount widget when a user visits a page. |
| 44 | |||
| 45 | If you are using any third-party tracking or measuring pixels (ie., Google Analytics, Adobe, etc.), you should place these pixels after the ONEcount pixel. | ||
| 46 | |||
| 47 | This is to avoid double-counting page views from first time visitors. | ||
| 48 | |||
| 49 | In other words, the following order: | ||
| 50 | |||
| |
36.1 | 51 | <HTML> |
| 52 | <HEAD> | ||
| 53 | <TITLE>title</TITLE> | ||
| |
32.1 | 54 | Google Analytics Widget |
| 55 | ONEcount Widget | ||
| 56 | |||
| 57 | Would result in Google Analytics recording two page impressions for a first-time site visitor, because GA would count the initial load, and then record an additional page load after the redirect. | ||
| 58 | |||
| 59 | This order: | ||
| 60 | |||
| |
36.1 | 61 | <HTML> |
| 62 | <HEAD> | ||
| 63 | <TITLE>title</TITLE> | ||
| |
32.1 | 64 | ONEcount Widget |
| 65 | Google Analytics Widget | ||
| 66 | |||
| 67 | Will allow ONEcount to reload the page for first-time visitors prior to the GA widget loading, resulting in a single impression. | ||
| 68 | |||
| |
36.1 | 69 | If you're concerned about how the page reload impacts user experience, keep in mind two things: |
| |
32.1 | 70 | |
| |
36.1 | 71 | 1) The redirect only happens once per user, per device. |
| |
32.1 | 72 | |
| |
36.1 | 73 | 2) If the widget is placed properly, the user won't experience the redirect. As you can see from the placement above, the ONEcount widget is delivered prior to any content, so the user experience won't be interrupted. |
| 74 | |||
| |
37.1 | 75 | 3) The redirect is required in order to get around Apple's Intelligent Tracking Protection software, which limits the life-span of even first-party cookies that are set in Javascript. During the redirect, ONEcount's first-party cookies are set by the server, making them immune to ITP. For more info on this issue, click [[here.>>url:https://cookiesaver.io/archives/analytics-guides/how-safari-itp-impacts-cookies/||shape="rect"]] |
| 76 | |||
| |
36.1 | 77 | Once the widget is placed on your pages, you will see a number of pixels load from the [[onecount.net>>url:http://onecount.net||shape="rect"]] domain each time the page loads. Most of these pixels load asynchronously, meaning in parallel, and should not impact your page load at all. |
| 78 | |||
| |
40.1 | 79 | (% style="color:#ff0000" %)//*//(% style="color:#000000" %)//A smartlink is any link that has parameters for identifying the user appended to the end of the URL. These parameters vary based on the email marketing platform you use (e.g. ONEcount's integrated Email Engine, Real Magnet/Magnet Mail, Exact Target, Silverpop, etc.) Upon clicking on a smartlink, two things will happen: 1) the user will be authenticated automatically for access-controlled content; and 2) the user will be identified in the system as a ONEcount user and a cookie will be set, allowing you to track as a Known user all activities across your online properties. //(%%)//*See Smartlinks and Other Form Linkouts// //documentation for more information on smartlinks.// |
| |
3.1 | 80 | |
| |
32.1 | 81 | |
| |
34.1 | 82 | === NO LONGER USED: The following widget is no longer needed, 05/15/2022 === |
| |
3.1 | 83 | |
| |
34.1 | 84 | === --Automation Widget-- === |
| |
3.1 | 85 | |
| |
34.1 | 86 | --Automation scripts are snippets of javascript code that allow ONEcount to target actions (like ad target, popup target etc). This piece of javascript determines and outputs any automated action to the browser.-- |
| |
3.1 | 87 | |
| |
34.1 | 88 | --This snippet is placed inside head (<head></head>) and SHOULD BE PLACED AFTER any ad network slot definition code (DFP).-- |
| |
3.1 | 89 | |
| |
34.1 | 90 | --See Widget Bulder documentation for more information.-- |
| 91 | |||
| |
5.1 | 92 | === IVT Tracker and Noscript Tag === |
| |
3.1 | 93 | |
| 94 | _**The IVT tracker snippet identifies potential IVT traffic, and the noscript tag is needed to track requests when javascript is disabled.** _ | ||
| 95 | |||
| 96 | This snippet is placed inside body tag. Usually putting just before the end body tag (</body>) is advised. | ||
| 97 | |||
| 98 | See Widget Builder documentation for more information. | ||
| 99 | |||
| |
5.1 | 100 | === Banner Trackers === |
| |
3.1 | 101 | |
| |
33.1 | 102 | Banner widgets are used to track and report banner activity. The banner widgets also track whether banner ads are "in view" on the user's screen. This is accomplished by a specific pixel that "checks-in" with ONEcount every three seconds to report whether the banner is still in view. This URL (v_js.php) may appear in the lower-left of your browser screen each time it is called, making it appear that v_js.php is loading and potentially slowing down the loading of the web page. This is not the case. If you view the load time in the developer tools of your browser, you will see this pixel is firing repeatedly, usually taking less than 10ms. Also, this pixel fires asynchronously, meaning in parallel with other elements on the page. So there is no impact on site performance from this pixel. |
| |
3.1 | 103 | |
| 104 | There are two banner platforms supported within ONEcount: OpenX and DFP (Premium and Small Business). | ||
| 105 | |||
| 106 | Widget Builder documentation provides widgets and directions for both platforms. | ||
| 107 | |||
| |
5.1 | 108 | === ONEcount Pixel for Moat === |
| |
3.1 | 109 | |
| 110 | ONEcount can collect ad viewability data from Moat's realtime pixel. In order to send data to ONEcount, Moat can fire a pixel like like that in the Widget Builder to send data to ONEcount. | ||
| 111 | |||
| |
30.1 | 112 | === Content Meta Tags === |
| |
3.1 | 113 | |
| |
30.1 | 114 | ONEcount uses content meta tags from your web pages to determine the type of content users are consuming. In order for ONEcount to understand the engagement users are having on your site, you should configure specific keywords in the meta tags in your web pages that represent what the content is about. |
| |
3.1 | 115 | |
| |
30.1 | 116 | For example, if you have an article about swimming pools, you might use keywords like "pool," "swimming," "water," etc. |
| 117 | |||
| 118 | There are three ways to tell ONEcount what type of content is on your web page: | ||
| 119 | |||
| 120 | <meta name="oc:keywords" content="swimming,pool,swimming pool,water" /> | ||
| 121 | |||
| 122 | <meta property="oc:keywords" content="swimming,pool,swimming pool,water" /> | ||
| 123 | |||
| 124 | ONEcount will accept three different properties: keywords, og:keywords, and oc:keywords. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| |
3.1 | 129 | {{id name="End ScreenSteps Content"/}} |
| |
7.1 | 130 | {{/layout-cell}} |
| 131 | |||
| 132 | {{layout-cell}} | ||
| |
40.1 | 133 | |
| |
27.1 | 134 | |
| |
26.1 | 135 | {{panel title="On this page:"}} |
| |
25.1 | 136 | {{toc style="square"/}} |
| |
26.1 | 137 | {{/panel}} |
| |
25.1 | 138 | |
| |
26.1 | 139 | {{panel borderStyle="solid" title="More System and Setup Information"}} |
| |
40.1 | 140 | {{expand title="Click here to expand..."}} |
| |
15.1 | 141 | [[ONEcount Cookies>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65727||shape="rect"]] |
| |
8.1 | 142 | \\[[Widget Implementation>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65622||shape="rect"]] |
| |
15.1 | 143 | \\[[Widget Builder>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]] |
| |
40.1 | 144 | \\[[doc:ONEcount Javascript Widgets]] |
| 145 | \\[[ONEcount Javascript Widget Changes>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]] | ||
| 146 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Configuration Manager>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65754||shape="rect"]] | ||
| 147 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Smartlinks, Brand Codes, and Other Form Linkouts>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65829||shape="rect"]][[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]] | ||
| 148 | [[ONEcount SSL and non-SSL Client Brand Pages>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/ONEcount+SSL+and+non-SSL+Client+Brand+Pages||shape="rect"]] | ||
| 149 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[OpenX Zone Setup for Banner Tracking and Viewability>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/OpenX+Zone+Setup+for+Banner+Tracking+and+Viewability||shape="rect"]] | ||
| 150 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[DFP Small Business – Create Key/Value Pair for Ad Targeting>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65873||shape="rect"]] | ||
| 151 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[DFP Premium – Create Key/Value Pair for Ad Targeting>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65879||shape="rect"]] | ||
| 152 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Progressive Lookup>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Progressive+Lookup||shape="rect"]] | ||
| 153 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Embedding Forms in Web Pages>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Embedding+Forms+in+Web+Pages||shape="rect"]] | ||
| 154 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Overriding Lookup/Login Page Settings>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65896||shape="rect"]][[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]] | ||
| 155 | [[Email Engine and Sender Score>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Email+Engine+and+Sender+Score||shape="rect"]] | ||
| 156 | \\[[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735]][[Global Features>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65905||shape="rect"]][[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]][[url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]] | ||
| |
8.1 | 157 | {{/expand}} |
| |
26.1 | 158 | {{/panel}} |
| |
25.1 | 159 | |
| 160 | |||
| 161 | |||
| |
40.1 | 162 | |
| |
7.1 | 163 | {{/layout-cell}} |
| 164 | {{/layout-section}} | ||
| 165 | {{/layout}} |