Last modified by steven@one-count_com on 2018/07/10 16:47
From version 13.1
edited by melanie@one-count_com
on 2016/12/13 13:23
Change comment: There is no comment for this version
To version 14.1
edited by steven@one-count_com
on 2018/07/10 16:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ONEcount Javascript Widget Changes (v12.x)
1 +ONEcount Javascript Widget Changes
Parent
... ... @@ -1,0 +1,1 @@
1 +System Setup Detail and Technical Information
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.melanie@one-count_com
1 +XWiki.steven@one-count_com
Tags
... ... @@ -1,0 +1,1 @@
1 +system_and_setup_info
Content
... ... @@ -4,30 +4,36 @@
4 4  
5 5  
6 6  {{id name="Start ScreenSteps Content"/}}
7 - Changes as of 10/05/2016
8 8  
9 -=== GCN.onecount.track(url, title, referrer): ===
8 +=== GCN.onecount.track(url, title, referrer, resourceId, callback): ===
10 10  
11 11  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.
12 12  
13 13  This function is designed to provide an impression track for each article on a page. The function expects three parameters:
14 14  
15 -**url**: The url of the article that is supposed to be tracked. **This is required**.
14 +* **url**: The url of the article that is supposed to be tracked. **This is required**.
15 +* **title**: This should be the same as the **title tag** if the article was displayed alone on the page.
16 +* **referrer**: The referrer of article. (For infinite scroll this can be the previous article in the scroll.)
17 +* (((
18 +**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
19 +)))
20 +* (((
21 +**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
22 +)))
16 16  
17 -**title**: This should be the same as the **title tag** if the article was displayed alone on the page.
18 -
19 -**referrer**: The referrer of article. (For infinite scroll this can be the previous article in the scroll.)
20 -
21 21  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.
22 22  
23 23  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.
24 24  
25 -=== GCN.onecount.gate(resourceId): ===
28 +=== GCN.onecount.gate(resourceId, callback): ===
26 26  
27 27  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.
28 28  
29 -This function expects **one parameter** which is the numeric resource id. **The resourceId is required.**
32 +This function expects **two parameter** :
30 30  
34 +1. **resourceId** : this is the **resourceId** that will be used for gating and it's **required.**
35 +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.
36 +
31 31  Resource Ids are available in ONEcount on the resource listing page.
32 32  
33 33  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.
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -67701
1 +65751
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/67701/ONEcount Javascript Widget Changes (v12.x)
1 +https://info.onecount.net//wiki/spaces/OD/pages/65751/ONEcount Javascript Widget Changes