Wiki source code of ONEcount Javascript Widgets

Last modified by Admin on 2021/08/02 13:54
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 ----
5
6 (updated 10/12/16)
7
8 \\
9
10 **all.min.js**: This is the main script that's used for data collection, interacting with ONEcount.
11
12 The main object in this script is called **GCN**. **GCN** contains the following objects:
13
14 (% style="margin-left: 30.0px;" %)
15 **variables**: this is a container for variables that may be used by others objects in GCN
16 \\
17
18 (% style="margin-left: 30.0px;" %)
19 **cookie**: utility for interacting with cookies. Contains the following functions:
20
21 * (((
22 * (((
23 **read**(**name**) : returns the value of cookie **name** or null if it doesn't exist
24 )))
25 * (((
26 **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
27 )))
28 * (((
29 **remove**(**name**, **options**): removes the cookie **name**. **options** is an object which can have the property **sublevel
30 \\**
31 )))
32 )))
33
34 (% style="margin-left: 30.0px;" %)
35 **url**: utility for interacting with url. Contains the following functions:
36
37 * (((
38 * (((
39 **parse**(**url**): parses the url and returns an object containing these properties : **href**, **withoutHash**, **url**, **origin**, **protocol**, **protocolseparator**, **credhost**, **cred**, **user**, **pass**, **host**, **hostname**, **port**, **pathname**, **segment1**, **segment2**, **search**, **hash**
40 )))
41 * (((
42 **params**(**url**): return a key value pair object of the query string parameters
43 )))
44 )))
45
46 * (((
47 * (((
48 **build**(**url**, **params**): create a new **url** based of the provided **url** and **params**
49 )))
50 )))
51
52
53
54 (% style="margin-left: 30.0px;" %)
55 **script**: utility for interacting with scripts. Contains the following functions:
56
57 * (((
58 * (((
59 **add**(**url**): creates a script tag using **document.write** whose **src** is **url**
60 )))
61 * (((
62 **addInHeader**(**url**): create a script tag in the **head** whose **src** is **url**
63 )))
64 * (((
65 **addAsync**(**url**): create a script tag in the **body** whose **src** is **url**
66 )))
67 * (((
68 **createScript**(**url**): helper function that create a script element whose src is url\\
69 )))
70 )))
71
72 (% style="margin-left: 30.0px;" %)
73 **method**: utility for dynamically invoking methods. Contains the following functions:
74
75 * (((
76 * (((
77 **call**(**f**, **options**): calls the function **f
78 \\**
79 )))
80 )))
81
82 (% style="margin-left: 30.0px;" %)
83 **event**: utility for interacting with event. Contains the following functions:
84
85 * (((
86 * (((
87 **on**(type, listener, f) : add a listener that executes the function **f** when event of type **type** occurs on **listener**
88 )))
89 * (((
90 **off**(**type**, **listener**, **f**): removes the listener that executes the function **f** when event of type **type** occurs
91 \\
92 )))
93 )))
94
95 (% style="margin-left: 30.0px;" %)
96 **random**: utility for generating random number and string. Contains the following functions:
97
98 * (((
99 * (((
100 **number**(): return a random integer
101 )))
102 * (((
103 **string**(**count**): return a random string of length **count**
104 \\
105 )))
106 )))
107
108 (% style="margin-left: 30.0px;" %)
109 **tracker**: this is used for tracking web impressions. Contains many functions used internally but the 2 functions accessible publicly are:
110
111 * (((
112 * (((
113 **init**(**_gcnt**): called on page load to initialize the tracker which which will start collecting impressions. **_gcnt** is an array that contains options used by the tracker.~/~/add list of options ?
114 )))
115 * (((
116 **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**.
117 \\
118 )))
119 )))
120
121 (% style="margin-left: 30.0px;" %)
122 **ONEcount**: object for interacting with ONEcount application. This object contains many functions and objects.
123
124 (% style="margin-left: 60.0px;" %)
125 a.** Functions**:
126
127 * (((
128 * (((
129 **init**(): initialize the widget
130 )))
131 * (((
132 **parseScript**(): parse the main script that was loaded to retrieve the **clientId**
133 )))
134 * (((
135 **getClientId**(): return the **clientId**
136 )))
137 * (((
138 **getOrigin**(): returns the script's **origin**
139 )))
140 * (((
141 **getScript**(): return the current script that is being executed
142 )))
143 * (((
144 **setUrls**(): set the different urls endpoint (**automation**, **login/logout**, **tracking**, **viewability**, **form embed**, ...) used to interact with ONEcount
145 )))
146 * (((
147 **setLinks**(): set the login/logout url as link.
148 )))
149 * (((
150 **setTargeting**() : loads the automation script used for **targeting**
151 )))
152 * (((
153 **loadAdditionalScripts**(): load additional scripts based on the **clientId**
154 )))
155 * (((
156 **isLoggedIn**(): return true if the user is logged in
157 )))
158 * (((
159 **checkPerm**(**params**): makes a **jsonp** request to the perm server to check whether the user has access to the page or not. **params** is an object that can have **url**, **referrer**, **resource** properties. If **url** and **referrer** are not provided, they will be retrieved from the window element. This is actually calling **tracker.track(url, title, referer)**. If the callback is provided, it will be called once a response is received from the server. This is being used to return the number of articles read for windowed products
160 )))
161 * (((
162 **gate**(**resource**): makes a **jsonp** request to the perm server to take the user to the registration page for resource. If the user is already subscribed then nothing will happen.
163 )))
164 )))
165
166 \\
167
168 (% style="margin-left: 60.0px;" %)
169 b. ** Objects**
170
171 * (((
172 * (((
173 **urls**: this object contains all the url used to interact with ONEcount. These url already have the **clientId** appended to them.
174 \\
175 )))
176 * (((
177 **links:** this object contains links to the login/logout in ONEcount. Below are the functions:
178 )))
179 )))
180
181 * (((
182 * (((
183 * (((
184 **login**() : return the link needed for login
185 )))
186 * (((
187 **logout**(): return the link need for logout
188 )))
189 * (((
190 This also contains other helper functions such as **setReturn**(**returnUrl**), **getReturnParam**(**returnUrl**), **encodeUrl**(**url**), **decodeUrl**(**url**)
191 \\
192 )))
193 )))
194 )))
195
196 * (((
197 * (((
198 **modal**: used to create a modal. This is being used for the form popup and the custom targeting pop up Contains the following functions:
199
200 *
201
202 **create**(**options**): create a modal. options is an object that contains the properties **html**, **styles**, **close**
203
204 *
205
206 **getCloseButton**(**options**): return the close button element. **options** is an object that contains the properties **close**
207
208 *
209
210 **getContent**(**options**): return a div that contains the content of the modal. **options** is an object that contains the properties **html**
211
212 *
213
214 **loadStyles**(**options**): load css styles used for the modal. **options** is an object that contains the properties **style
215 \\**
216 )))
217 * (((
218 **functions**: this is an object contains functions used by other widgets on the page. Contains the following functions:
219
220 *
221
222 **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**)
223
224 *
225
226 **get_user_data()**: returns the user's **ocid** and **tempid** in the format **ocid.tempid
227 \\**
228 )))
229 * (((
230 **form**: used to create a pop up form or for form embed. Contains one function and another object:
231
232 *
233
234 **embed**(**options**): this function is used to embed a form on the page
235
236 *
237
238 **popup:** this object is used to display the form as a popup. Contains the following functions:
239
240 *
241
242 **resize**(**id**): re sizes the form with document id **id**
243
244 *
245
246 **display**(options): displays the form as a pop up
247
248 *
249
250 **message**(event): used to interact with the form in the iframe via **postMessage**
251 )))
252 )))
253
254 \\
255
256 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.
257
258 **v.js:** This script is used to capture viewability data for **DFP Premium** and **Openx Open Source (Revive)**.
259
260 **v_sb.js:** This script is used to capture viewability data for **DFP Small Business**
261
262 **fs.js:** This is the form scrapper script. Used to scrapped content from 3^^rd^^ party forms when they are being submitted.
263
264 === GCN.onecount.track(url, title, referrer, resourceId, callback): ===
265
266 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.
267
268 This function is designed to provide an impression track for each article on a page. The function expects three parameters:
269
270 * **url**: The url of the article that is supposed to be tracked. **This is required**.
271 * **title**: This should be the same as the **title tag** if the article was displayed alone on the page.
272 * **referrer**: The referrer of article. (For infinite scroll this can be the previous article in the scroll.)
273 * (((
274 **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
275 )))
276 * (((
277 **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
278 )))
279
280 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.
281
282 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.
283
284 === GCN.onecount.gate(resourceId, callback): ===
285
286 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.
287
288 This function expects **two parameter** :
289
290 1. **resourceId** : this is the **resourceId** that will be used for gating and it's **required.**
291 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.
292
293 Resource Ids are available in ONEcount on the resource listing page.
294
295 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.
296
297 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.
298
299 \\
300
301 \\
302
303 **__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.
304
305 \\
306
307 \\
308 {{/layout-cell}}
309
310 {{layout-cell}}
311 {{panel borderStyle="solid" title="Search all Documentation:"}}
312
313
314 {{livesearch/}}
315 {{/panel}}
316
317 {{panel borderStyle="solid" title=" Search System and Setup Information:"}}
318
319
320 {{pagetreesearch rootPage="System and Setup Information"/}}
321 {{/panel}}
322
323 {{panel borderStyle="solid" title="More System and Setup Information"}}
324 {{expand}}
325 [[ONEcount Cookies>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65727||shape="rect"]]
326 \\[[Widget Implementation>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65622||shape="rect"]]
327 \\[[Widget Builder>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]]
328 \\[[\\\\ONEcount Javascript Widget Changes>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]][[
329 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Configuration Manager>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65754||shape="rect"]][[
330 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Smartlinks, Brand Codes, and Other Form Linkouts>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65829||shape="rect"]][[
331 >>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[
332 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"]][[
333 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[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"]][[
334 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[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"]][[
335 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[DFP Premium – Create Key/Value Pair for Ad Targeting>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65879||shape="rect"]][[
336 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Progressive Lookup>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Progressive+Lookup||shape="rect"]][[
337 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Embedding Forms in Web Pages>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Embedding+Forms+in+Web+Pages||shape="rect"]][[
338 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Overriding Lookup/Login Page Settings>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65896||shape="rect"]][[
339 >>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[
340 Email Engine and Sender Score>>url:http://bos-jira01-cl01.onecount.net:8090/display/OD/Email+Engine+and+Sender+Score||shape="rect"]][[
341 \\>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[Global Features>>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65905||shape="rect"]][[
342 >>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65735||shape="rect"]][[
343 >>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]][[
344 >>url:http://bos-jira01-cl01.onecount.net:8090/pages/viewpage.action?pageId=65751||shape="rect"]]
345 {{/expand}}
346 {{/panel}}
347
348 \\
349
350 \\
351
352 \\
353 {{/layout-cell}}
354 {{/layout-section}}
355 {{/layout}}