Changes for page ONEcount Javascript Widgets

Last modified by Admin User on 2025/10/31 14:02

From 2.1 to 3.1 From 12.1 to 13.1

From version 3.1

edited by melanie@one-count_com
on 2016/11/17 13:29

Change comment: There is no comment for this version

To version 12.1

edited by Admin User
on 2025/10/31 13:59

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Parent

...	...	@@ -1,0 +1,1 @@
	1	+System Setup Detail and Technical Information

Author

@@ -1,1 +1,1 @@
--XWiki.melanie@one-count_com
++XWiki.admin

Content

@@ -1,9 +1,10 @@
  {{layout}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
++----
++
  (updated 10/12/16)
--
  **all.min.js**: This is the main script that's used for data collection, interacting with ONEcount.
@@ -11,7 +11,6 @@
  (% style="margin-left: 30.0px;" %)
  **variables**: this is a container for variables that may be used by others objects in GCN
--\\
  (% style="margin-left: 30.0px;" %)
  **cookie**: utility for interacting with cookies. Contains the following functions:
@@ -24,8 +24,7 @@
  **set**(**name**, **value**, **options**): create a cookie called **name** with value **value**. **options** is an object which can have **expires**, **path**, **domain** and **secure** properties
  )))
  * (((
--**remove**(**name**, **options**): removes the cookie **name**. **options** is an object which can have the property **sublevel
--\\**
++**remove**(**name**, **options**): removes the cookie **name**. **options** is an object which can have the property **sublevel**
  )))
  )))
@@ -47,8 +47,8 @@
  )))
  )))
--
++
  (% style="margin-left: 30.0px;" %)
  **script**: utility for interacting with scripts. Contains the following functions:
@@ -63,7 +63,7 @@
  **addAsync**(**url**): create a script tag in the **body** whose **src** is **url**
  )))
  * (((
--**createScript**(**url**): helper function that create a script element whose src is url\\
++**createScript**(**url**): helper function that create a script element whose src is url
  )))
  )))
@@ -72,8 +72,7 @@
  * (((
  * (((
--**call**(**f**, **options**): calls the function **f
--\\**
++**call**(**f**, **options**): calls the function **f**
  )))
  )))
@@ -86,7 +86,6 @@
  )))
  * (((
  **off**(**type**, **listener**, **f**): removes the listener that executes the function **f** when event of type **type** occurs
--\\
  )))
  )))
@@ -99,7 +99,6 @@
  )))
  * (((
  **string**(**count**): return a random string of length **count**
--\\
  )))
  )))
@@ -112,7 +112,6 @@
  )))
  * (((
  **track**(**url**, **title**, **referer**): used to dynamically track a page with url **url**, title **title** and referer **referer**. This can be used with **infinite scroll**.
--\\
  )))
  )))
@@ -120,7 +120,7 @@
  **ONEcount**: object for interacting with ONEcount application. This object contains many functions and objects.
  (% style="margin-left: 60.0px;" %)
--a.** Functions**:
++a.** Functions**:
  * (((
  * (((
@@ -161,15 +161,14 @@
  )))
  )))
--
++
  (% style="margin-left: 60.0px;" %)
--b. ** Objects**
++b. ** Objects**
  * (((
  * (((
  **urls**: this object contains all the url used to interact with ONEcount. These url already have the **clientId** appended to them.
--\\
  )))
  * (((
  **links:** this object contains links to the login/logout in ONEcount. Below are the functions:
@@ -186,7 +186,6 @@
  )))
  * (((
  This also contains other helper functions such as **setReturn**(**returnUrl**), **getReturnParam**(**returnUrl**), **encodeUrl**(**url**), **decodeUrl**(**url**)
--\\
  )))
  )))
  )))
@@ -195,62 +195,60 @@
  * (((
  **modal**: used to create a modal. This is being used for the form popup and the custom targeting pop up Contains the following functions:
--*
++*
  **create**(**options**): create a modal. options is an object that contains the properties **html**, **styles**, **close**
--*
++*
  **getCloseButton**(**options**): return the close button element. **options** is an object that contains the properties **close**
--*
++*
  **getContent**(**options**): return a div that contains the content of the modal. **options** is an object that contains the properties **html**
--*
++*
--**loadStyles**(**options**): load css styles used for the modal. **options** is an object that contains the properties **style
--\\**
++**loadStyles**(**options**): load css styles used for the modal. **options** is an object that contains the properties **style**
  )))
  * (((
  **functions**: this is an object contains functions used by other widgets on the page. Contains the following functions:
--*
++*
  **dfp_sb_ad_capture**(**e**): used to prepare data for **DFP Small Business** viewability script. e is and event containing data about the data (**creativeId**, **lineItemId**)
--*
++*
--**get_user_data()**: returns the user's **ocid** and **tempid** in the format **ocid.tempid
--\\**
++**get_user_data()**: returns the user's **ocid** and **tempid** in the format **ocid.tempid**
  )))
  * (((
  **form**: used to create a pop up form or for form embed. Contains one function and another object:
--*
++*
  **embed**(**options**): this function is used to embed a form on the page
--*
++*
  **popup:** this object is used to display the form as a popup. Contains the following functions:
--*
++*
  **resize**(**id**): re sizes the form with document id **id**
--*
++*
  **display**(options): displays the form as a pop up
--*
++*
  **message**(event): used to interact with the form in the iframe via **postMessage**
  )))
  )))
--
++
  On top of this **all.min.js** also contains a library used for browser fingerprinting as well as a library used for getting flash info on the browser. The content of this files used to spread in 3 different files and now they're in one place.
  **v.js:** This script is used to capture viewability data for **DFP Premium** and **Openx Open Source (Revive)**.
@@ -259,20 +259,46 @@
  **fs.js:** This is the form scrapper script. Used to scrapped content from 3^^rd^^ party forms when they are being submitted.
--
++=== GCN.onecount.track(url, title, referrer, resourceId, callback): ===
--\\
++By default, ONEcount widgets track impressions on each page load. For sites where one article is displayed per page, this works fine. But in cases where articles are displayed on the same page, i.e. infinite scroll, only the first one is tracked.
--
++This function is designed to provide an impression track for each article on a page. The function expects three parameters:
--\\
--{{/layout-cell}}
++* **url**: The url of the article that is supposed to be tracked. **This is required**.
++* **title**: This should be the same as the **title tag** if the article was displayed alone on the page.
++* **referrer**: The referrer of article. (For infinite scroll this can be the previous article in the scroll.)
++* (((
++**resourceId**: this is optional. If set to a valid resourceId, that resource that will be used in order to perform gating or increase view_count. You can pass 0 in order to use the default resource associated with the url if any
++)))
++* (((
++**callback**: function to be called after a request has been sent to ONEcount. This can return the number of articles read by the user for products with limit in timeframe
++)))
--{{layout-cell}}
++While the impressions are being tracked, ONEcount will also check whether the user's subscription is still valid or not (e.g. limit of X articles per month has been reached). If the subscription is not valid, then the user will be taken to the subscription page.
++Let's assume I have a page where the first article is displayed when the page loads and three mores articles are displayed as the user scrolls down. The first article will be tracked by ONEcount, but for the three other articles, a call to GCN.onecount.track needs to be made to tell ONEcount that the articles have been displayed. The url should be the direct url of the article. The referrer should be the previous article's url.
--{{livesearch/}}
++=== GCN.onecount.gate(resourceId, callback): ===
++Gating is currently done based on a REGEX match of a url segment on page load. This function is designed to allow customers to gate content where gating can not be sufficiently managed using URL segments, or where content must be gated without a page load.
++
++This function expects **two parameter** :
++
++1. **resourceId** : this is the **resourceId** that will be used for gating and it's **required.**
++1. **callback:** this is a function that can be passed. The response from the gating request will be made available in the callback. The callback should expect one parameter which is a JSON object. The JSON object has a property called hasAccess which is a boolean (true/false). **true** means the user has access and **false** means he does not.
++
++Resource Ids are available in ONEcount on the resource listing page.
++
++To create a resource that uses this function, choose “Function” from the resource type pull-down, then enter a text return value in the box below. This return value is ignored for now, but may be used to trigger gating in the future.
++
++When the function is called and the user is not subscribed to the product that the resource belongs to, he will be taken to the registration page in order to do so. If he is already subscribed to the product then nothing will happen.
++
++
++
++**__NOTE:__**   If page load speed is ever a concern, it is recommended to use a third party service (such as tools.pingdom.com). By doing so, it will generate report of all items loading on your webpage along with their load times. Simply copy and paste your page's URL into the designated field and a test will be conducted immediately. If any** oc.net** item exceeds a load speed of 500ms, please enter a Helpdesk ticket for us to review. Testing page load speeds is a very informative way of identifying items that are directly impacting page performance. It is worth mentioning that there will be items that continuously load in short spurts (ex. **v.js** for viewability data) however those short spurts do not negatively impact load speed performance.
++
++
  {{/layout-cell}}
  {{/layout-section}}

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--66135
++66131

url

@@ -1,1 +1,1 @@
--https://info.onecount.net//wiki/spaces/OD/pages/66135/ONEcount Javascript Widgets
++https://info.onecount.net//wiki/spaces/OD/pages/66131/ONEcount Javascript Widgets