DCR Static Browser Bundled SDK - Revision history

NickParrucci: /* Opt-Out */

2023-02-23T20:59:46Z

Opt-Out

← Older revision		Revision as of 20:59, 23 February 2023
Line 143:		Line 143:
	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 opt-out option, include the following two items in your privacy policy		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 opt-out option, include the following two items in your privacy policy
	* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)		* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
	* A link to the Nielsen Digital Measurement Privacy Policy at ~~http~~://www.nielsen.com/digitalprivacy		* A link to the Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/digitalprivacy
	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.		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.

	The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at ~~http~~://www.nielsen.com/digitalprivacy.		The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/digitalprivacy.

	'''Opt Back In'''		'''Opt Back In'''

Admin at 20:18, 14 March 2018

2018-03-14T20:18:43Z

← Older revision		Revision as of 20:18, 14 March 2018
Line 112:		Line 112:
	\| type \|\| asset type \|\| fixed \|\| <code>'static'</code> \|\| Yes		\| type \|\| asset type \|\| fixed \|\| <code>'static'</code> \|\| Yes
	\|-		\|-
	\| assetid \|\| Unique ID for each article \|\| dynamic \|\| custom \|\| Yes		\| assetid \|\| Unique ID for each article \|\| dynamic \|\| custom<br>(no [[Special Characters]]) \|\| Yes
	\|-		\|-
	\| section \|\| section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values \|\| dynamic \|\| custom \|\| Yes		\| section \|\| section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values \|\| dynamic \|\| custom \|\| Yes

Admin at 23:00, 8 June 2017

2017-06-08T23:00:09Z

← Older revision		Revision as of 23:00, 8 June 2017
Line 1:		Line 1:
	{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|~~Digital Content Ratings~~}} {{CurrentBreadcrumb}}		{{Breadcrumb\|}} {{Breadcrumb\|Digital}} {{Breadcrumb\|DCR & DTVR}} {{CurrentBreadcrumb}}
	[[Category:Digital]]		[[Category:Digital]]

Line 79:		Line 79:
	<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>		<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

	The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[~~Bundled_SDK_~~-~~_Static~~#Configure_Metadata~~\|Step 3~~]].		The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[Bundled SDK - Static#Configure_Metadata]].

	=== Pass App ID in Initialization Call ===		=== Pass App ID in Initialization Call ===
Line 100:		Line 100:
	\|}		\|}

	Update <code><apid></code> with the AppID provided~~. Refer to the [[Bundled_SDK_-_Static#Going_Live\|Going Live]] section to know about updating the AppID to production after testing is completed~~.		Update <code><apid></code> with the AppID provided.

	=== Configure Metadata ===		=== Configure Metadata ===

Admin: Admin moved page DCR Static Browser SDK to DCR Static Browser Bundled SDK without leaving a redirect

2017-05-20T22:46:02Z

Admin moved page DCR Static Browser SDK to DCR Static Browser Bundled SDK without leaving a redirect

← Older revision	Revision as of 22:46, 20 May 2017
(No difference)

Admin: Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Content Ratings}} {{CurrentBreadcrumb}} Category:Digital == Prerequisites == To get started, an App ID is nee..."

2017-05-20T22:24:39Z

Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Content Ratings}} {{CurrentBreadcrumb}} Category:Digital == Prerequisites == To get started, an App ID is nee..."

New page

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Content Ratings}} {{CurrentBreadcrumb}}
[[Category:Digital]]

== Prerequisites ==
To get started, an App ID is needed. The App ID is a unique ID assigned to the player/site/app. This will be provided upon starting the integration.
<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>

== Implementation Steps ==
=== Add Tracking Code ===
The Nielsen DCR Tracking Code must be added to each page.
<syntaxhighlight lang="javascript"><script>
// Static Queue Snippet
!function(t,n){t[n]=t[n]||{nlsQ:function(e,o,c,r,s,i){return s=t.document,r=s.createElement("script"),r.async=1,r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},t[o]}}} (window,"NOLBUNDLE");

// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});

// Content Metadata
var nielsenMetadata = {
type: 'static',
assetid: '', // *DYNAMIC METADATA*: unique ID for each article **REQUIRED**
section: '', // *DYNAMIC METADATA*: section of site **REQUIRED**
segA: '', // *DYNAMIC METADATA*: custom segment
segB: '', // *DYNAMIC METADATA*: custom segment
segC: '' // *DYNAMIC METADATA*: custom segment
};

// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</script></syntaxhighlight>

==== Tracking Code Components ====
The tracking code includes
* Static Queue Snippet
* SDK Initialization
* Content Metadata
* staticstart Event

'''Static Queue Snippet'''

The static queue snippet allows the SDK APIs to be called while the actual SDK and configuration file are still being downloaded. As the queue can capture all API calls before the download completes, there is no wait time. Once the SDK is available, the API calls will transition from directing to the queue to the SDK seamlessly.
<syntaxhighlight lang="javascript">
!function(t,n){t[n]=t[n]||
{
nlsQ:function(e,o,c,r,s,i)
{
return s=t.document,
r=s.createElement("script"),
r.async=1,
r.src=("http:"===t.location.protocol?"http:":"https:")+"//cdn-gl.imrworldwide.com/conf/"+e+".js#name="+o+"&ns="+n,i=s.getElementsByTagName("script")[0],i.parentNode.insertBefore(r,i),
t[o]=t[o]||{g:c,ggPM:function(n,e,c,r,s){(t[o].q=t[o].q||[]).push([n,e,c,r,s])}},t[o]}
}
}
(window,"NOLBUNDLE");</syntaxhighlight>

'''SDK Initialization'''

While creating an SDK instance, initialize the SDK by calling:

'''Initialization API Call'''

<syntaxhighlight lang="javascript">NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "",{nol_sdkDebug: "debug"})</syntaxhighlight>

When the initialization call is made, a unique static config file, <code><apid>.js</code>, will be downloaded based on the <code>apid</code> and cached by the client-side browser(s).

Once the static config file is downloaded, the SDK will be fully downloaded and initialized. All SDK modules are included in one file:
"nlsSDK600.bundle.min.js".

'''Content Metadata'''

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values.

Pass dynamic metadata for the keys with the <code><metadataPlaceholder></code> value (e.g. <code>section: ''</code>).

'''staticstart Event'''

There is only one event call required:
<syntaxhighlight lang="javascript">nSdkInstance.ggPM("staticstart", nielsenMetadata);</syntaxhighlight>

The content metadata object is passed as a parameter when calling 'staticstart' event . To know more about configuring metadata refer [[Bundled_SDK_-_Static#Configure_Metadata|Step 3]].

=== Pass App ID in Initialization Call ===
Pass the unique App ID in the first parameter of the initialization call, <code><apid></code>.

'''Example SDK Initialization'''

<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX", "nlsnInstance", {nol_sdkDebug: "debug"});</syntaxhighlight>

The initialization call has three parameters:
{| class="wikitable"
|-
! Parameter !! Description !! Values
|-
| apid || Unique ID assigned to player/site. || <code>PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX</code>
|-
| instanceName || Name of SDK instance || Any string value
|-
| nol_sdkDebug: "debug" || Enables Nielsen console logging. Only required for testing || <code>{nol_sdkDebug: "debug"}</code>
|}

Update <code><apid></code> with the AppID provided. Refer to the [[Bundled_SDK_-_Static#Going_Live|Going Live]] section to know about updating the AppID to production after testing is completed.

=== Configure Metadata ===
Map the Nielsen keys to variables so that the content metadata is dynamically updated.

The Nielsen reserved keys are:
{| class="wikitable"
|-
! Key !! Description !! Data Type !! Value !! Required?
|-
| type || asset type || fixed || <code>'static'</code> || Yes
|-
| assetid || Unique ID for each article || dynamic || custom || Yes
|-
| section || section of each site (e.g. section value should be first level in page URL: website.com/section). Limit to 25 unique values || dynamic || custom || Yes
|-
| segA || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segB || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || dynamic || custom || No
|-
| segC || custom segment for reporting: Limit to 25 unique values across custom segments (segA + segB + segC) || fixed || custom || No
|}

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"
|-
! Key !! Aggregation Limit
|-
| section || maximum of 25 unique values (section <= 25)
|-
| segA || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segB || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|-
| segC || Maximum number of unique values allowed across segA, segB, and segC is 25 (segA + segB + segC<= 25)
|}

== Opt-Out ==
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 opt-out option, include the following two items in your privacy policy
* A notice that the player includes proprietary measurement software that allows users to contribute to market research (such as Nielsen TV Ratings)
* A link to the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy
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.

The following paragraph is a template for an opt-out statement, the properties may feature Nielsen proprietary measurement software, which will allow users to contribute to market research, such as Nielsen TV Ratings. To learn more about the information that Nielsen software may collect and your choices with regard to it, please see the Nielsen Digital Measurement Privacy Policy at http://www.nielsen.com/digitalprivacy.

'''Opt Back In'''

Once users have opted-out, they can choose to opt back into Nielsen Measurement at anytime by selecting the opt back in link on the Nielsen Digital Privacy Policy page. When a user selects the link, their opt-out cookie will be deleted and they will be able to be measured.

== Going Live ==
Once the DCR Tracking Code is added to Instant Articles, Nielsen will validate the implementation. Following Nielsen testing, users need to make a couple of updates to the initialization call to ensure that the site is being measured properly.
# '''App ID''': Ensure that correct <apid> is used during initialization<syntaxhighlight lang="javascript">'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'</syntaxhighlight>
# '''Debug Logging''': Disable logging by deleting <code>{nol_sdkDebug: 'DEBUG'}</code> from initialization call.
#* '''Example Production Initialization Call''' - Refer to the production initialization call below:<syntaxhighlight lang="javascript">var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "nlsnInstance");</syntaxhighlight>