View source for Digital Pre-Certification Checklist Browser SDK

{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|US DCR & DTVR}}  {{CurrentBreadcrumb}}
[[Category:Digital]]

<blockquote>'''Note:''' Due to the variable and unique nature of each application,  there may be additional testing required by Nielsen that is not listed here.  These tests are completed to ensure the quality of data collected.  Please speak with your account manager if you have any questions.</blockquote>

== Pre-Certification Checklist - VOD with Ads ==
Before starting the certification process, please verify the following steps have been completed.
* Your Client Service representative should have already discussed a reporting hierarchy with you -- along with a Parent, Brand, and Sub-brand/Channel
* Your Technical Account Manager should have:
** provided you with an APID
** informed you of our Opt-Out requirement to be included in your Privacy Policy section of your site
** informed you to add the Static Queue Snippit on each page you wish to enable video measurement 
** informed you that the apid, 'instanceName', and ‘nol_sdkDebug’ : ‘DEBUG’ should be present in the SDK initialization

== Initialization ==
The first step in the Certification process is to ensure that the Nielsen SDK is initializing on page load, and that the global metadata values are present.
{| class="wikitable"
|-
! Keys !! Value
|-style="background-color:#d0f6f8;"
| appid || <code>"PXXXXX-XXXXXX-XXXXX-XXXXX"</code>
|-style="background-color:#d0f6f8;"
| instanceName || <code>"nlsnInstance"</code>
|-style="background-color:#d0f6f8;"
| nol_sdkDebug || <code>"debug"</code>
|}

'''Browser SDK Queue Snippit & Initialization Example'''
<syntaxhighlight lang="objective-c">NSDictionary* appInformation = @
<script type="text/javascript">
  // Add 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");

  // Created SDK Instance
  var nSdkInstance = NOLBUNDLE.nlsQ("XXXXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX","nlsnInstance", {nol_sdkDebug: "debug"});
</script>
</syntaxhighlight>

== Test Cases ==
The following lists the test cases along with the Expected results:
{| class="wikitable"
|-
! Test Case !! Param !! Expected Result !! Pass/Fail
|-
| SDK Initialized || <code>apid</code> || Correct APID || 
|-
|  || <code>instanceName</code> || SDK Instance Name || 
|-
|  || <code>nol_sdkDebug</code> || <code>"DEBUG"</code> || 
|}

=== loadMetadata() - Content ===
* Called at beginning of content, or when resuming content from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> || 
|-
|  || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset, no [[Special Characters]]) || 
|-
|  || <code>length</code> || <code>"600"</code> || length in seconds (int or float) || 
|-
|  || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) || 
|-
|  || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) || 
|-
|  || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown || 
|-
|  || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown || 
|-
|  || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID || 
|-
|  || <code>crossId2</code> || <code>"ABC"</code> || Network Name || 
|-
|  || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) || 
|-
|  || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time || 
|-
|  || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI || 
|-
|  || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads || 
|}

=== loadMetadata() - ad ===
* Called at beginning of ad, or when resuming ad from interruption
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>assetid</code> || <code>"ad_2201343201"</code> || (any non-empty value) || 
|-
|  || <code>type</code> || <code>"midroll"</code> || <code>"preroll"</code>, <code>"midroll"</code>, <code>"postroll"</code> || Example
|}

=== setPlayheadPosition() - Preroll ad ===
* Track current position of playhead
* Starts at 0 at the beginning of ad
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second || 
|-
| <code>stop()</code> || Called at the end of Ad || 
|}

=== loadMetadata() - Content ===
* Test is to validate Content metadata is the same as original metadata passed during initial loadMetadata call.
{| class="wikitable"
|-
! Test !! Param !! Example Value !! Accepted Values !! Pass/Fail
|-
| loadMetadata || <code>type</code> || <code>"content"</code> || <code>"content"</code> || 
|-
|  || <code>assetid</code> || <code>"unique_id_500291"</code> || (unique per asset) || 
|-
|  || <code>length</code> || <code>"600"</code> || length in seconds (int or float) || 
|-
|  || <code>title</code> || <code>"Episode Title"</code> || (any non-empty value) || 
|-
|  || <code>program</code> || <code>"Show Name"</code> || (any non-empty value) || 
|-
|  || <code>segB</code> || <code>"Primetime"</code> || (any value), used for optional breakdown || 
|-
|  || <code>segC</code> || <code>"Comedy"</code> || (any value), used for optional breakdown || 
|-
|  || <code>crossId1</code> || <code>"EP018S9S290015"</code> || Gracenote ID || 
|-
|  || <code>crossId2</code> || <code>"ABC"</code> || Network Name || 
|-
|  || <code>isfullepisode</code> || <code>"y"</code> || (<code>"y"</code> or <code>"n"</code>) (<code>"Y"</code> or <code>"N"</code>) || 
|-
|  || <code>airdate</code> || <code>"20160206 23:00:00"</code> || <code>"YYYYMMDD[space]HH:MM:SS"</code> -- note: HH=24 hour time || 
|-
|  || <code>adloadtype</code> || <code>"1"</code> || <code>"1"</code> for linear ads, <code>"2"</code> for DAI || 
|-
|  || <code>hasAds</code> || <code>"1"</code> || <code>"0"</code> for no ads, <code>"1"</code> for has ads || 
|}

=== setPlayheadPosition() - Content ===
* Track current position of playhead
* Starts at 0 at the beginning of content
* Updated at least once per second
* Separate playhead position for ads and content, should accurately reflect current position in either ads or content
* Final playhead position for content must equal the length specified in loadMetadata(), followed by end() call
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>setPlayehadPosition</code> || Called every second, and starts at 0 || 
|-
| <code>stop()</code> || Called at the end of each asset before transition ie. content to ad, ad to content, ad to ad || 
|}

=== stop() ===
* Should Be Called:
* Before each transition from ad to content, content to ad, or ad to ad
* Upon pause
* When playback is interrupted (connection lost, user exits video or page)

=== end() ===
* Reached the end of content
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>end</code> || Called once content has completed fully || 
|}

== Interruptions ==
* All interruptions to playback of content or ads should trigger a call to stop(). Once the interruption is over, loadMetadata() with the same metadata should be called, followed by playheadPosition resuming from where it left off.

* Interruptions include:
** user-induced pause
** screen turned off
** refresh page
** internet connection lost (n.b. cached playback plays as normal until it expires)
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| user-induced pause || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> || 
|-
| screen turned off || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> || 
|-
| internet connection lost || <code>stop()</code>, <code>loadMetadata()</code> & <code>playheadPosition</code> || 
|-
| content paused || <code>playheadPosition</code> is not passed || 
|-
| resume content || <code>loadMetadata()</code> is called for content || 
|-
|  || <code>loadMetadata()</code> is the same as original || 
|-
|  || <code>playheadPosition</code> continues from resumed position || 
|}


'''Expected SDK behavior for all interruptions:'''
# interruption triggers stop() call
# when content resumes, loadMetadata() is called with the same metadata that was playing previously (ad or content)
# playheadPosition() resumes from the same position before the interruption

'''Example session:'''
* 5 minutes of content played, call interruption, content resumes until end of 15 min video

== Scrubbing ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| Scrub Backward || new playhead position is accurate || 
|-
|  || new playhead continues from new position || 
|-
| Scrub Forward || new playhead position is accurate || 
|-
|  || new playhead continues from new position || 
|-
| Scrub to end || final playhead position is passed || 
|-
|  || end event called at completion of content playback || 
|-
| Scrub past midroll || Playhead for content stops || 
|}

== Midroll & Postroll Ads ==
{| class="wikitable"
|-
! Test Case !! Test Condition !! Pass/Fail
|-
| <code>loadMetadata()</code> || Called for each Ad || 
|-
|  || Required Metadata is accurate || 
|-
| <code>playheadPosition</code> || Passed every second || 
|-
| <code>stop()</code> || called for each ad || 
|-
| <code>loadMetadata()</code>, <code>playheadPosition</code>, <code>stop()</code> || correct sequence for each ad || 
|}

== Opt-Out ==
The site must provide a means for the user to opt-out of or opt back into Nielsen measurement. Include the following two items in the site’s 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 https://www.nielsen.com/digitalprivacy

The following paragraph is a template for an opt-out statement
Our properties may feature Nielsen proprietary measurement software, which will allow you 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, refer to Nielsen Digital Measurement Privacy Policy at https://www.nielsen.com/digitalprivacy.