DCR Podcasts in Digital: Difference between revisions

From Engineering Client Portal

mNo edit summary
m (UTC -> UNIX)
 
(45 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}}
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Digital Audio}} {{CurrentBreadcrumb}}
[[Category:Digital]]
[[Category:Podcasts]]


== Prerequisites ==
__TOC__
To start using the App SDK, the following details are required:
* '''App ID (appid):''' Unique ID assigned to the player/site and configured by product.
* '''sfcode:''' Unique identifier for the environment that the SDK should point to.
* '''Nielsen SDK''' and '''Sample Player''': A part of the downloaded package
If you do not have any of these pre-requisites or if you have any questions, please contact our SDK sales support team.
Refer to [[Digital Measurement Onboarding]] guide for information on how to get a Nielsen App SDK and appid.


== Import Library ==
== Steps ==
Refer to [[iOS SDK API Reference#Importing Frameworks|iOS SDK API Reference - Importing Frameworks]] for information on importing libraries.
'''This document assumes you have implemented Digital Audio with Live AM/FM stream measurement''' with a "radio" content type.    It outlines the new parameters you will use to implement podcast measurement.  
* The latest version of App SDK allows instantiating multiple instances of App SDK object and can be used simultaneously without any issues.


== Initialize SDK ==
#Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
Initialize App SDK as soon as the application is launched. Refer to [[iOS SDK API Reference#Initialization|iOS SDK API Reference - Initialization]] for details on initializing an AppSDK object and the parameters required.
#Your TAM will provide new appIds for the applications that will offer podcasts
#Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate [[DCR Podcasts in Digital#Changes_for_Podcast_Measurement|Changes for Podcast Measurement]]  below
#Obtain Nielsen Podcast certification once your changes are complete and tested
#Complete a Production License with your Nielsen Account Representative
=== Library ===
Use the same SDK library as Digital Audio, live AM/FM stream measurement.
 
== Changes for Podcast Measurement ==
=== Initializing the SDK ===
Update your appid to the new ID provided by your TAM for podcast measurement.  
When you initialize the SDK, use 'dcr' in the sfcode instead of 'drm'.  


== Configure API calls ==
=== play ===
=== play ===
Use [[play]] to pass the channel descriptor information through channelName parameter when the user taps the '''Play''' button on the player.
Call [[play]] when the user taps the '''Play''' button to start the content.. The channelName parameter is not required.
 
'''play Example'''
 
<syntaxhighlight lang="json">{
  "channelName": "KABC-FM Morning Show"
}</syntaxhighlight>


=== loadMetadata ===
=== loadMetadata ===
Use [[loadMetadata]] to pass 'content' and 'ad' [[Digital Measurement Metadata]]. The CMS data must be passed as a JSON object.
Use [[loadMetadata]] to pass information about your podcast to the SDK. The parameters must be passed as a JSON object.
<syntaxhighlight lang="objective-c">    – (void) loadMetadata :(id)metadata;</syntaxhighlight>
<syntaxhighlight lang="objective-c">    – (void) loadMetadata :(id)metadata;</syntaxhighlight>
Refer to [[loadMetadata]] for the list of parameters to be passed in the JSON object.
Refer to [[loadMetadata]] for the list of parameters to be passed in the JSON object.
<blockquote>'''Note:''' The [[loadMetadata]] call after the first [[play]] call must have ‘content’ details ("type": "content"). This call should occur before any preroll ad starts playing.</blockquote>
<blockquote>'''Note:''' The [[loadMetadata]] call after the first [[play]] call '''must have ‘content’ ("type": "content").''' </blockquote>


=== playheadPosition (Content) ===
'''loadMetadata Example'''
Use [[playheadPosition]] to pass the position of the playhead while the content is being played.
<syntaxhighlight lang="json">{
<syntaxhighlight lang="objective-c">   – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>
  "type": "content",
{| class="wikitable"
  "assetid": "KABC:345-67483",
|-
  "program": "KABC Morning Show",
! # !! Key !! Description !! Values !! Required? (Y/N) !! Example
  "title": "20171125: HR1",
|-
  "length": "3600",
| 1 || Live** || UTC of the live content || Client-defined || Yes || Seconds since 1970
  "segB": "KABC-FM",                       // station call letters and band are optional here                 
|-
  "isfullepisode": "y",
| 2 || Video On Demand (VOD)** || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
  "airdate": "20171125 06:00:00",
|}
  "adloadtype": "2",
<nowiki>**</nowiki>''Only one of these parameters is mandatory''
  "pipmode":"false"  
<blockquote>'''Note:''' If playhead is not available from audio / video measurement, allow the app to start a timer (1-5 seconds) and send playhead position to SDK based on the timer event. Once the actual playhead is available, let the app send the proper playhead position. This allows the SDK to calculate and provide a closer value for duration.</blockquote>
}</syntaxhighlight>
 
'''Buffering state'''
* Do not supply playhead position while the content is being buffered.
* If the content is in buffering state continuously for more than 30 seconds, call [[stop]] API.
 
 
'''Live Content'''
<syntaxhighlight lang="objective-c">    long long pos = [[NSDate date] timeIntervalSince1970];
    [nAppApiObject playheadPosition:pos];</syntaxhighlight>
 
 
'''On-demand Content'''
<syntaxhighlight lang="objective-c">    CMTime curTime=[player currentTime];
    long pos=CMTimeGetSeconds(curTime);
    [nAppApiObject playheadPosition:pos];</syntaxhighlight>


=== playheadPosition (Ad) ===
=== playheadPosition for "content" ===
Use [[playheadPosition]] to pass the position of the playhead while the advertisement is being played.
You will continue to use [[playheadPosition]] to pass the position of the playhead while the content is being played; however, you will pass the relative position from the beginning of the file. '''This is different than live stream measurement, which uses the current Unix timestamp (seconds since Jan-1-1970 UTC).'''
<syntaxhighlight lang="objective-c">    – (void) playheadPosition: (long long) playheadPos</syntaxhighlight>


{| class="wikitable"
{| class="wikitable"
Line 64: Line 56:
! Key !! Description !! Values !! Required? (Y/N) !! Example
! Key !! Description !! Values !! Required? (Y/N) !! Example
|-
|-
| Ad || Position taken from beginning of the ad in seconds || Client-defined || Yes || Seconds since tart of the ad
| On-Demand Audio || Position taken from beginning of the content in seconds. || Client-defined || Yes || Current player position from beginning of the content.
|}
|}


'''Ad Content'''
''' playheadPosition Syntax Example for iOS'''
<syntaxhighlight lang="objective-c">    CMTime curTime=[adplayer currentTime];
<syntaxhighlight lang="objective-c">    CMTime curTime=[player currentTime];
     long pos=CMTimeGetSeconds(curTime);
     long pos=CMTimeGetSeconds(curTime);
     [nAppApiObject playheadPosition:pos];</syntaxhighlight>
     [nAppApiObject playheadPosition:pos];</syntaxhighlight>
<blockquote>'''Note:''' The playhead positions for ad and content should be maintained separately.</blockquote>


=== stop ===
[[stop]] must be called on the following events:
* At the end of ad
* In case of interruptions during playback like flight mode, Wi-Fi toggle, etc.


Call [[loadMetadata]] and [[playheadPosition]] when the stream resumes.
'''Usage Sequence and API'''
 
The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.
Call [[play]] when starting the new stream.
 
=== end ===
[[end]] must be called on the following events:
*End of playback
*Channel change
 
=== API Call sequence ===
==== Use Case 1: Content has no Advertisements ====
Use the sample API sequence below as a reference to identify the specific events that need to be called during content playback without ads.
 
Call [[play]] with channelName JSON as below.
<syntaxhighlight lang="json">{
  "channelName": "TheMovieTitle"
}</syntaxhighlight>
Call [[loadMetadata]] with JSON metadata for content as below.
<syntaxhighlight lang="json">{
  "type": "content",
  "assetid": "vid345-67483",
  "program": "ProgramName",
  "title": "Program S3, EP1",
  "length": "3600",
  "segB": "CustomSegmentValueB",
  "segC": "CustomSegmentValueC",
  "crossId1": "Reference11",
  "crossId2": "Reference22",
  "isfullepisode": "y",
  "airdate": "20161013 20:00:00",
  "adloadtype": "2",
  "progen":"GV"
}</syntaxhighlight>
Call [[playheadPosition]] every one second until a pause / stop.


{| class="wikitable"
{| class="wikitable"
|-
|-
! Type !! Sample code !! Description
! Action !! Sample code !! Description
|-
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of program being played
|-
|-
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
| <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
|-
| Content || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
| Listening || <code>[nielsenMeter playheadPosition: position];</code> || // playheadPosition is position of the playhead while the content is being played
|-
|-
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
| End of Stream || <code>[nielsenMeter end];</code> || // Content playback is completed.
|}
|}


==== Use Case 2: Content has Advertisements ====
- Continue to call [[playheadPosition]] every two seconds until the user pauses, stops, or loses audio.  
Call [[play]] with channelName JSON as below.
 
<syntaxhighlight lang="json">{
- Call a new ''loadMetadata'' when the user selects a different program.
  "channelName": "TheMovieTitle"
}</syntaxhighlight>
'''With Preroll, Midroll, Postroll Ads'''
Call [[loadMetadata]] with JSON metadata for ad as below.
'''Please note:''' The below examples include ad pod information.  These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.  
<syntaxhighlight lang="json">{
  "type": "preroll",
  "assetid": "ad=123"
}</syntaxhighlight>
<blockquote>Note: In case the individual ad details are not available, send ad pod (presence) details through the [[loadMetadata]] and playhead position through [[playheadPosition]].</blockquote>


Call [[playheadPosition]] every one second until a pause / stop / another ''loadMetadata'' is called. Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].
When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of [[loadMetadata]].


The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.
{| class="wikitable"
{| class="wikitable"
|-
|-
! Type !! Sample code !! Description
! Action !! Sample code !! Description
|-
|-
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
| rowspan="2" | Start of stream || <code>[nielsenMeter play: channelName];</code> || // channelName contains JSON metadata of channel/video name being played
Line 155: Line 104:
| <code>[nielsenMeter stop];</code> || // Call stop after preroll occurs
| <code>[nielsenMeter stop];</code> || // Call stop after preroll occurs
|-
|-
| rowspan="3" | Content || <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
| rowspan="3" | Listening || <code>[nielsenMeter loadMetadata: contentMetadataObject];</code> || // contentMetadataObject contains the JSON metadata for the content being played
|-
|-
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the content is being played
| <code>[nielsenMeter playheadPosition: position];</code> || // position is position of the playhead while the content is being played
Line 181: Line 130:


<blockquote>'''Note:''' Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.</blockquote>
<blockquote>'''Note:''' Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.</blockquote>
== The Viewability Metric ==
The viewability metric introduced in the Nielsen AppSDK represents the visibility of a video in the player along a playback. If you decide to implement the Nielsen Viewability Module, the SDK will track the viewability of the targeted player/element, log the viewable percentage, and record in seconds the time the player/element was in that viewable state.  Please refer to Implementing [[Implementing Viewability with AppSDK|Viewability with AppSDK.]]
== Interruptions during playback ==
As part of integrating Nielsen App SDK with the player application, the Audio / Video app developer needs to handle the following possible interruption scenarios:
* Pause / Play
* Network Loss (Wi-Fi / Airplane / Cellular)
* Call Interrupt (SIM or Third party Skype / Hangout call)
* Alarm Interrupt
* Content Buffering
* Device Lock / Unlock (Video players only, not for Audio players)
* App going in the Background/Foreground (Video players only, not for Audio players)
* Channel / Station Change Scenario
* Unplugging of headphone
In case of encountering one of the above interruptions, the player application needs to
* Call [[stop]] immediately (except when content is buffering) and withhold sending playhead position.
* Start sending pings – [[loadMetadata]] and [[playheadPosition]] for the new viewing session, once the playback resumes.
Please see the [[Digital Measurement FAQ]] for more details


== Nielsen Measurement Opt-Out Implementation ==
== Nielsen Measurement Opt-Out Implementation ==
Opt-out implementation for podcasts is the same as live AM/FM stream measurement.  
No changes are necessary because Opt-out implementation for podcasts is the same as live AM/FM stream measurement.


== Technical Guides ==
== Technical Guides ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 50%;" | DCR Implementation Guide
!| SDK Documentation
|-
| rowspan="7" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| [[Android SDK API Reference]]
|}
{| class="wikitable"
{| class="wikitable"
|-
|-
Line 223: Line 172:
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist App SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
| '''[[Digital Pre-Certification Checklist Browser SDK]]'''
|}
== SDK - Video ==
{| class="wikitable"
! style="width: 90px;" | Type
! style="width: 45px;" |
! style="width: 45px;" | OS
! style="width: 30%;" | DCR Implementation Guide
! style="width: 25%;" | DTVR Implementation Guide
!| SDK Documentation
|-
| rowspan="7" | {{SmallIcon|SDKIcon.png|alt=SDK}}
|-
| rowspan="3" | {{OSIcon|VideoIcon.png|alt=Video}}
| {{OSIcon|macOSIcon.png|alt=iOS}}
| '''[[DCR Video iOS SDK]]'''
| '''[[DTVR iOS SDK]]'''
| [[iOS SDK API Reference]]
|-
| {{OSIcon|AndroidIcon.png|alt=Android}}
| '''[[DCR Video Android SDK]]'''
| '''[[DTVR Android SDK]]'''
| [[Android SDK API Reference]]
|}
|}

Latest revision as of 16:28, 11 January 2019

Engineering Portal / Digital / Digital Audio / DCR Podcasts in Digital

Steps

This document assumes you have implemented Digital Audio with Live AM/FM stream measurement with a "radio" content type. It outlines the new parameters you will use to implement podcast measurement.

  1. Contact your Nielsen Account Representative to discuss the way you would like your podcasts reported (Classified)
  2. Your TAM will provide new appIds for the applications that will offer podcasts
  3. Update the parameters you use to call the SDK play and playheadPosition. Reference the appropriate Changes for Podcast Measurement below
  4. Obtain Nielsen Podcast certification once your changes are complete and tested
  5. Complete a Production License with your Nielsen Account Representative

Library

Use the same SDK library as Digital Audio, live AM/FM stream measurement.

Changes for Podcast Measurement

Initializing the SDK

Update your appid to the new ID provided by your TAM for podcast measurement. When you initialize the SDK, use 'dcr' in the sfcode instead of 'drm'.

play

Call play when the user taps the Play button to start the content.. The channelName parameter is not required.

play Example 

{
   "channelName": "KABC-FM Morning Show"
}

loadMetadata

Use loadMetadata to pass information about your podcast to the SDK. The parameters must be passed as a JSON object. 

    – (void) loadMetadata :(id)metadata;

Refer to loadMetadata for the list of parameters to be passed in the JSON object.

Note: The loadMetadata call after the first play call must have ‘content’ ("type": "content").

loadMetadata Example 

{
  "type": "content",
  "assetid": "KABC:345-67483",
  "program": "KABC Morning Show",
  "title": "20171125: HR1",
  "length": "3600",
  "segB": "KABC-FM",                        // station call letters and band are optional here                   
  "isfullepisode": "y",
  "airdate": "20171125 06:00:00",
  "adloadtype": "2",
  "pipmode":"false" 
}

playheadPosition for "content"

You will continue to use playheadPosition to pass the position of the playhead while the content is being played; however, you will pass the relative position from the beginning of the file. This is different than live stream measurement, which uses the current Unix timestamp (seconds since Jan-1-1970 UTC).

Key Description Values Required? (Y/N) Example
On-Demand Audio Position taken from beginning of the content in seconds. Client-defined Yes Current player position from beginning of the content.

playheadPosition Syntax Example for iOS 

    CMTime curTime=[player currentTime];
    long pos=CMTimeGetSeconds(curTime);
    [nAppApiObject playheadPosition:pos];


Usage Sequence and API The sample API sequence can be used as a reference to identify the specific events that need to be called during content and ad playback.

Action Sample code Description
Start of stream [nielsenMeter play: channelName]; // channelName contains JSON metadata of program being played
[nielsenMeter loadMetadata: contentMetadataObject]; // contentMetadataObject contains the JSON metadata for the content being played
Listening [nielsenMeter playheadPosition: position]; // playheadPosition is position of the playhead while the content is being played
End of Stream [nielsenMeter end]; // Content playback is completed.

- Continue to call playheadPosition every two seconds until the user pauses, stops, or loses audio.

- Call a new loadMetadata when the user selects a different program.

With Preroll, Midroll, Postroll Ads Please note: The below examples include ad pod information. These ads are not ads served as part of the originator's programming (studio-recorded ads). These ads are hosted independently from the podcast content file.

When applicable, Playhead should be passed for the entire duration of ad pod, if the ad pod details are passed as part of loadMetadata.

Action Sample code Description
Start of stream [nielsenMeter play: channelName]; // channelName contains JSON metadata of channel/video name being played
[nielsenMeter loadMetadata: contentMetadataObject]; // contentMetadataObject contains the JSON metadata for the content being played
Preroll [nielsenMeter loadMetadata: prerollMetadataObject]; // prerollMetadataObject contains the JSON metadata for the preroll ad
[nielsenMeter playheadPosition: position]; // position is position of the playhead while the preroll ad is being played
[nielsenMeter stop]; // Call stop after preroll occurs
Listening [nielsenMeter loadMetadata: contentMetadataObject]; // contentMetadataObject contains the JSON metadata for the content being played
[nielsenMeter playheadPosition: position]; // position is position of the playhead while the content is being played
[nielsenMeter stop]; // Call stop after the content is paused (ad starts)
Midroll [nielsenMeter loadMetadata: midrollMetadataObject]; // midrollMetadataObject contains the JSON metadata for the midroll ad
[nielsenMeter playheadPosition: position]; // position is position of the playhead while the midroll ad is being played
[nielsenMeter stop]; // Call stop after midroll occurs
Content (End of stream) [nielsenMeter loadMetadata: contentMetadataObject]; // contentMetadataObject contains the JSON metadata for the content being played
[nielsenMeter playheadPosition: position]; // position is position of the playhead while the content is being played
[nielsenMeter end]; // Called at the end of content
Postroll [nielsenMeter loadMetadata: postrollMetadataObject]; // postrollMetadataObject contains the JSON metadata for the postroll ad
[nielsenMeter playheadPosition: position]; // position is position of the playhead while the postroll ad is being played
[nielsenMeter stop]; // Call stop after postroll occurs

Note: Each Ad playhead should reset or begin from 0 at ad start. When content has resumed following an ad break, playhead position must continue from where previous content segment was left off.

Nielsen Measurement Opt-Out Implementation

No changes are necessary because Opt-out implementation for podcasts is the same as live AM/FM stream measurement.

Technical Guides

Type OS DCR Implementation Guide SDK Documentation
SDKIcon.png
Video
iOS
 DCR Video iOS SDK iOS SDK API Reference
Android
 DCR Video Android SDK Android SDK API Reference
Technical Guides
DigitalIcon.png
 Digital Measurement Onboarding Digital Measurement Metadata
Digital Measurement Testing Digital Measurement Interruption Scenarios
Digital Measurement FAQ
Digital Pre-Certification Checklist App SDK Digital Pre-Certification Checklist Browser SDK
Retrieved from "https://engineeringportal.nielsen.com/w/index.php?title=DCR_Podcasts_in_Digital&oldid=3110"