DCR Static Lite Browser SDK: Difference between revisions

From Engineering Client Portal

(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Content Ratings}} {{CurrentBreadcrumb}} Category:Digital == Overview == DCR Static Lite <Page Measurement> al...")
 
No edit summary
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Content Ratings}}  {{CurrentBreadcrumb}}
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}}  {{CurrentBreadcrumb}}
[[Category:Digital]]
[[Category:Digital]]


== Overview ==
== Overview ==
<blockquote>
[[Image:AlertIcon.png|left|60px|link=|class=smallIcon]] DCR Static Lite has been Sunset.  If you are currently using this solution, please reach out to your Technical Account Manager.
</blockquote>
<!--
DCR Static Lite <Page Measurement> allows clients to measure the time spent by users on static content (in focus). Unlike Video measurement, the Static Lite <Page Measurement> does not require a configuration file.
DCR Static Lite <Page Measurement> allows clients to measure the time spent by users on static content (in focus). Unlike Video measurement, the Static Lite <Page Measurement> does not require a configuration file.
* The cadence of the View and Duration pings for DCR Static Lite is same as Video content. (View ping when content is loaded completely and Duration ping every 5 minutes following that).
* The cadence of the View and Duration pings for DCR Static Lite is same as Video content. (View ping when content is loaded completely and Duration ping every 5 minutes following that).
Line 14: Line 20:
| Requires a configuration file. || Does not require a configuration file.
| Requires a configuration file. || Does not require a configuration file.
|-
|-
| Duration ping cadence is every 30 minutes. || Duration ping cadence is every 5 minutes.
| Duration ping cadence is every 5 minutes. || Duration ping cadence is every 5 minutes.
|}
|}


== Prerequisites ==
== Prerequisites ==
To start using the Browser SDK, the following details are required:
To start using the App SDK, the following items are required:
* '''App ID (apid):''' Unique ID assigned to the player/site and configured by product.
{| class="wikitable"
* '''sfcode:''' Unique identifier for the environment that the SDK should point to. During testing, please use the sfcode as "dcr-cert".
|-
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
! style="width: 30px;" |
! style="width: 15%;" | Item
! Description
! Source
|-
|| ☑ || '''App ID (appid)''' || Unique ID assigned to the player/site and configured by product. || Contact Nielsen
|}


== DCR Static Lite Implementation ==
== DCR Static Lite Implementation ==
Line 31: Line 43:


'''with HTTPS URL'''
'''with HTTPS URL'''
<syntaxhighlight lang='javascript'><script async src="https://seccdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#nol_sfcode=dcr-cert&nol_ci=AB-XXXXXX&nol_apid=TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&nol_assetname=My_assetname&nol_apn=My_AppName&nol_ad=0&nol_vc=b02&nol_devid=XXXX-XXXX-XXXX&nol_segA=NA&nol_segB=NA&nol_segC=NA"></script></syntaxhighlight>
<syntaxhighlight lang='javascript'><script async src="https://seccdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#nol_sfcode=dcr&nol_ci=AB-XXXXXX&nol_apid=TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&nol_assetname=My_assetname&nol_apn=My_AppName&nol_ad=0&nol_vc=b02&nol_devid=XXXX-XXXX-XXXX&nol_segA=NA&nol_segB=NA&nol_segC=NA"></script></syntaxhighlight>
'''with HTTP URL'''
'''with HTTP URL'''
<syntaxhighlight lang='javascript'><script async src="http://cdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#nol_sfcode=dcr-cert&nol_ci=AB-XXXXXX&nol_apid=TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&nol_assetname=My_assetname&nol_apn=My_AppName&nol_ad=0&nol_vc=b02&nol_devid=XXXX-XXXX-XXXX&nol_segA=NA&nol_segB=NA&nol_segC=NA"></script></syntaxhighlight>
<syntaxhighlight lang='javascript'><script async src="http://cdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#nol_sfcode=dcr&nol_ci=AB-XXXXXX&nol_apid=TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&nol_assetname=My_assetname&nol_apn=My_AppName&nol_ad=0&nol_vc=b02&nol_devid=XXXX-XXXX-XXXX&nol_segA=NA&nol_segB=NA&nol_segC=NA"></script></syntaxhighlight>




Line 47: Line 59:
! Parameter !! Description !! Required? !! Specified by !! Example
! Parameter !! Description !! Required? !! Specified by !! Example
|-
|-
| nol_sfcode || Location of collection environment. During testing, all traffic should be directed to “dcr-cert”. || Yes || Nielsen || dcr-cert
| nol_sfcode || Location of collection environment. || Yes || Nielsen || dcr
|-
|-
| nol_ci || Brand level aggregation || Yes || Nielsen || My_ClientID
| nol_ci || Brand level aggregation || Yes || Nielsen || My_ClientID
|-
|-
| nol_apid || UniqueID assigned to player/site. || Yes || Nielsen || TXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
| nol_apid || UniqueID assigned to player/site. || Yes || Nielsen || PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|-
|-
| nol_assetname || Unique ID assigned to content || Yes || Client || My_assetname
| nol_assetname || Section of each site (e.g. section value should be first <br />
level in page URL: website.com/section). Limit to 25 unique values
|| Yes  
|| Client  
|| My_assetname
|-
|-
| nol_apn || User-defined string value for describing the player/site. || Yes || Client || My_AppName
| nol_apn || User-defined string value for describing the player/site. || Yes || Client || My_AppName
|-
|-
| nol_vc || Sub-brand level aggregation || Yes || Client || vcID
| nol_vc || Sub-brand level aggregation || Yes || Client || VCID
|-
|-
| nol_apv || Version of the app build || Yes || Client || 1.0
| nol_segA || Segment A custom segment for reporting || No || Client || NA
|-
|-
| nol_segA || Segment A. (defaults to NA) || No || Client || NA
| nol_segB || Segment B custom segment for reporting || No || Client || NA
|-
|-
| nol_segB || Segment B. (defaults to NA) || No || Client || NA
| nol_segC || Segment C custom segment for reporting || No || Client || NA
|}
 
The values passed through the Nielsen keys will determine the breakouts that are seen in reporting. The custom segments (A, B & C) will roll into the sub-brand. To not use custom segments A, B and C, do not pass any value in these keys.
 
'''Aggregation Limits'''
There are limits on the number of unique values that can be aggregated on in reporting. The specific limitations by key are:
{| class="wikitable"
|-
|-
| nol_segC || Segment C. (defaults to NA) || No || Client || NA
! Key !! Aggregation Limit
|-
|-
| nol_cref1 || Standard episode ID. This is a custom parameter || No || Client || Reference11
| section || Maximum of 25 unique values (section <= 25)
|-
|-
| nol_cref2 || Content originator (required only for distributors). This is a custom parameter || No || Client || Reference 22
| segA || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
|-
| nol_ad || Access method (defaults to 0) || No || Client || 0 for browser, 1 for app
| segB || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
|-
| nol_devid || Device id. Defaults to blank if not provided. || No || Client || myDeviceID
| segC || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|}
|}


== Advanced Tag Implementation ==
== Advanced Tag Implementation ==
In case you want to set the parameters dynamically using JavaScript, refer to [[BSDK_Tag_Implementation|Advanced Dynamic Script Initialization]].
DCR Static Lite ensures that clients have a prior knowledge of the values for the parameters, they also offer the option of dynamically binding these parameters to the script tag.
 
Below is an example of how to bind Dynamic Parameters to the script tag.
 
In the HTML <head> section of each page, add the script snippet as shown below.
<blockquote>Note: This tagging is an alternative way of dynamically passing parameters to Static Lite in replacement of the standard <script> tag implementation.</blockquote>
<blockquote>Note: This tagging is an alternative way of dynamically passing parameters to Static Lite in replacement of the standard <script> tag implementation.</blockquote>


== Nielsen Measurement Opt-Out Implementation ==
<syntaxhighlight lang="html">
<script type= "text/javascript" async>
var _nolParams =
{
  nol_sfcode: 'dcr',
  nol_ci: 'My_ClientID',
  nol_apid: 'PXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  nol_apn: 'My_AppName',
  nol_vc: 'My_vcID',
  nol_segA: 'NA',
  nol_segB: 'NA',
  nol_segC: 'NA',
  nol_assetname: 'My_assetname'
};
/* This function dynamically builds the script tag and injects it into the page */
(function (params)
{
  var url = 'https://cdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#'; // Only for HTTPS URLs
  var url = 'http://cdn-gl.imrworldwide.com/novms/js/2/nlsDcrLite510.min.js#'; // Only for HTTP URLs
  var query = [];
  for (var param in params)
{
  query.push(param + '=' + params[param]);
}// for
url += query.join('&');
var script = window.document.createElement("script");
script.async = true;
script.src = url;
window.document.getElementsByTagName('head')[0].appendChild(script);
})(_nolParams);
</script>
</syntaxhighlight>
 
== Privacy and Opt-Out ==
* As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. Our digital measurement products are not used to identify the consumer in any way, but they help us and our clients measure and analyze how consumers engage with media across online, mobile and emerging technologies, and offer insights into consumer behavior.
* As a global information and measurement leader, we are committed to protecting the privacy and security of the data we collect, process and use. Our digital measurement products are not used to identify the consumer in any way, but they help us and our clients measure and analyze how consumers engage with media across online, mobile and emerging technologies, and offer insights into consumer behavior.
* When the user wants to opt in or opt out of Nielsen measurement, a new dynamic page (with content similar to [http://secure-us.imrworldwide.com/nielsen_app_optout.html]) should be displayed.
 
*For more details, refer to [[Opt-Out Implementation]] and Nielsen Digital Privacy.
* The site must provide a means for the user to opt-out of, or opt back into, Nielsen Measurement. A user can opt-out if they would prefer not to participate in any Nielsen online measurement research.  To implement the User Opt-Out option, include the following link to the Nielsen Digital Measurement Privacy Policy at https://priv-policy.imrworldwide.com/priv/browser/us/en/optout.html
 
* On the Nielsen Digital Measurement Privacy Policy page, users can click Choices to read more detailed information about the measurement software, learn about their options with regard to Nielsen measurement, and, if they do not want to participate in Nielsen online measurement, click a link to receive an opt-out cookie.


== Pre-Certification Checklists ==
== Pre-Certification Checklists ==
Line 89: Line 154:


== Testing an Implementation - Browser ==
== Testing an Implementation - Browser ==
[[Testing Browser Implementation | Click here]] for information on Testing the Browser Implementation.
See [[Digital Measurement Testing]].
 
-->
[[Category:Browser_SDK_(DCR)|Browser_SDK_(DCR)]]

Latest revision as of 15:48, 23 September 2021

Engineering Portal / Digital / US DCR & DTVR / DCR Static Lite Browser SDK

Overview

AlertIcon.png

DCR Static Lite has been Sunset. If you are currently using this solution, please reach out to your Technical Account Manager.


Retrieved from "https://engineeringportal.nielsen.com/w/index.php?title=DCR_Static_Lite_Browser_SDK&oldid=5361"