TV PLAYER REPORT

PROJECT OVERVIEW

Project Summary

The TV Player Report represents the first stage of Barb Project Dovetail.

As audiences continue to fragment across both content and delivery mechanisms, the stresses of using of a sample survey alone to create and report audience estimates at a granular level increase. Project Dovetail sets out an ultimate aim of augmenting a panel approach with new, granular datasets. In short, raw absolute census data providing the totality of what has been consumed, with the panel providing the context of who has viewed. The resulting merged dataset will allow the full dissemination and analysis of viewing behaviour across viewing platforms, who is watching what, and what incremental and de-duplicated coverage is obtained.

The first stage of this unified vision is to standardise and centrally collect the site centric IP data from all participating broadcasters, enabling a regular account of the size and delivery content through a variety of devices. This means that all broadcaster data will be directly comparable without differing definitions or collection methods hindering the direct analysis.

To this end, Barb has chosen Kantar Media as its supplier of this data. Broadcasters are asked to implement the Kantar Media plugin' library sensor into their media players. In addition to the integration of the Kantar Media measurement, Barb requires a broadcaster consistent approach to cataloguing and tracking of content. This parallel Content ID project is discussed Barb TVPR Project#Content ID.

Participating Broadcasters

The following companies are currently part of the Barb TV Player Report project:

• BBC
• Channel 4
• Channel 5
• ITV
• Sky
• STV
• S4C
• UKTV

Current Project Status

For more information on the current project status and schedule, please contact Kantar UK and/or Barb.

Project Teams and Resources

The Kantar project team is led by Kantar Audiences in London.  Our technology specialists from Kantar Germany will assist with your technical queries as you begin and progress each player/platform implementation.

Before you start your implementation we will discuss with you and your teams which of our libraries you should use and be available to answer queries arising from your review of our documentation and testing framework.

We will be directly involved in the sign-off process for your implementation, undertaking a review of the data we receive from your implementation once on a staging environment.  You can find out more about how together we verify your stream implementation Barb TVPR Project#FROM IMPLEMENTATION TO PUBLICATION - PROCESS.

Who Do I Contact and When?

General Queries

Please contact us at the following address: uk-tvpr-ops@kantarmedia.com

More about us

LIBRARY CODE BASE AND ROADMAP

Our Technology Roadmap

This expert-based forward roadmap is constructed based on BARB-driven industry platform coverage priorities. It is expected that each project stakeholder will engage in the process to agree ongoing solution design and prioritisation. We anticipate being able to build upon our existing technologies to meet many of the new target platforms.

The roadmap contains the following key phases:

1. Discovery stage
   1. Internal project discovery workshop
   2. Identify the player “library product”, and potential alternatives (if any)
   3. Broadcaster workshop (conference call)
   4. Agree scope and boundaries of solution
2. Initial library development
3. POC with selected broadcasters
4. Final standard library development (incorporating changes where necessary)
5. Library official release
6. Individual stakeholder implementations scheduled

Each project stakeholder will have the opportunity to critique and validate the roadmap, and that in-house plans across the project lifecycle will be shared with Kantar. A regular 3-monthly review process will be used to review and update project platform priorities between Barb, Kantar, and each broadcaster stakeholder.

Library Downloads

Which library do I need?

You can find our currently available libraries below.  We will work with you to identify which library you should use as part of your initial implementation planning discussions.

Streaming libraries and JavaScript downloads

Help with Adapters

Why do I need an Adapter?

When a library specifically suited for your player is not available, you can still use our measurement by implementing an "adapter". This is a small piece of code that ensures the connection between the Kantar Media library and your player. It is typically written by yourself; and Kantar Media can provide consultancy to aid you with this.

Documentation about how to integrate the libraries by using an adapter is available in the general documentation Implementation of Stream Measurement for Barb TV Player Report.

Some examples that require an adapter are here below.

Microsoft Silverlight

Silverlight Implementation

Brightcove

For Flash: /wiki/spaces/KASRLCS/pages/159726836

Not available natively yet for Android or iOS. It can be done currently with the available Android and iOS Spring libraries + a custom adapter to connect the library with the Brightcove API. 

YouView

YouView runs a proprietary version of Flash and they do not use "flash.net.NetStream" but "MediaRouter" instead. An adapter is needed in this case to extend flash.net.NetStream and grab information from MediaRouter such as the position and duration. It is similar to what is demonstrated in NetStream adapter for the flash.media.Sound object example in the documentation.

The library does not rely on flash.external.ExternalInterface being available or cookies. The ExternalInterface is normally used for passing an "unload" call from the browser back to the library in case the browser is being closed. However, this "unload()" method can also be triggered from inside the Flash application itself.

UNDERSTANDING HOW TO IMPLEMENT THE SPRING LIBRARIES

Our Measurement Ethos

The Kantar Media technology was conceived and developed to be as platform-agnostic as possible.
Every video player has at least the possibility to report a playhead-position and the duration of the video (enables the user to see how long the video is and can keep track of the progress). These two variables form the basis of our measurement system, and they are common in every environment.
We capture a combination of environment-specific identifiers and additional metadata to attribute each streaming heartbeat to a session and a device.

Documentation

Our comprehensive Implementation of Stream Measurement document describes how the Kantar libraries work. It includes sample implementations and guidelines for writing a custom adapter for our libraries.

In order to measure any streaming content, a sensor on the client side is necessary, which measures which sequences of the stream were played by the user. These sequences can be defined by time intervals in seconds - therefore, the player or the playing instance must be able to provide a method for delivering the actual position on the stream in seconds.

The regular reading of the current position allows the tracking of all actions on a stream. Winding operations can be identified, if there are unexpected jumps in reading out the position. Stop or pause operations are identified by the fact, that the current position will not change.

User actions and operations like stop or pause are not measured directly (not player event based) but are instead derived from measuring the current position on stream.

Step-by-Step Guide

The step-by-step guide gives a graphical and concise overview of HOW, WHEN, and WHY to measure. We recommend to have look at it: here.

General metadata tagging instructions

It is essential that you ensure the standardised functions and values are passed in your library implementation.

How to map:

Live Stream Measurement – Instructions

The instructions for measuring your Live TV streams will vary depending on the features of your Player.
Instructions on how to map the “cq”, “stream”, and “dur” variables for Live TV streams are detailed in the General metadata tagging instructions section. As your implementation requires that you also provide access to other functionality, this section declares in full the Live TV stream requirement.
As part of your implementation, to ensure that all your Live TV streams are included in the BARB TV Player Report production you must inform BARB and our UK Project Manager of the following information:

1. Complete up-to-date list of your Player channel identifiers (or Service Key identifier) including regional programming identifiers
2. The official “known as” name of each channel identifier
3. Date from which the Live TV channel becomes available online
4. Player platforms the channel is available on
5. Identify whether the channel carries commercials, and how they are handled
6. The agreed offset between broadcast time and streaming time for your channel.  A table of all existing offsets can be seen here. 

METHOD 1 – “Barb OFFICIAL CHANNEL METHOD”

This is the recommended method for implementing livestreams. This method assumes that for live simulcast streams, your Player will not provide any indicator of where a stream crosses a programme boundary. It also assumes your Player will not provide any unique content identifier.

You will call trackMethod whenever a Live TV channel stream begins; a new View will be created. Every time the Live TV stream is pause/resume no action is required. When the Live TV stream is stop/start you will need to stop the library and once again call trackMethod. By doing this you will correctly create a new View.

INSTRUCTIONS:

1. Map the “dur” variable for Live TV streams as detailed in the General metadata tagging instructions section.
2. Populate the channel name (or Service Key identifier) into the stream variable as instructed in the General metadata tagging instructions section.
3. Set the Live TV channel identifier within the stream variable, e.g.
   1. live/channelone
   2. live/channeltwo
   3. live/channeltwosouth
   4. live/channelthree
   5. live/channelfour
   6. live/F230
   7. live/X234
4. Supply the playhead position (“pst” variable) using the linear broadcast date and time as a timestamp value in seconds. You will need to account for the fact that the delay between linear broadcast and online playout may vary between platforms. Your Player should retain control over how any delay versus linear broadcast is handled.
5. Handle FFWD/RWD (“tricks”) by updating the broadcast date and time in the pst variable, i.e. for the scenarios commonly understood as “Scrubbing”, “Live Rewind” and “Live Restart”.

Example tracking call:

http://tvplayerplugintest.2cnt.net/j0=,,,,v=A%201.1.0+app=mobiletestapp+pl=mobiletestapp+did=868e10589389fd35+aid=bb97262e90e4ef1f+sy=768+plv=1.0.0.0+sx=1196;+,vt=16+uid=3a8w7ib+stream=live/channelname+pst=,,0+0+na8vcw;+,1407932109+1407932126+na8vcw;;+sy=360+dur=0+sx=640;;;;?lt=hysmffp1

– deprecated – METHOD 2 – “CONTENT ASSET TRACKING METHOD”

This method must only be used if the Live TV channel stream can be restarted at each programme boundary, i.e. your Player must know the programme boundary and relevant EPG information, enabling you to create a new View for each programme. It assumes that your Player can handle the tracking of programmes delivered as part of a live stream in the same way as on-demand content.

INSTRUCTIONS:

You will call trackMethod whenever a new programme on your Live TV channel stream begins; a new View will be created every time. Pause/resume of a Live TV programme represents a continuation of the same stream View. Only when the stream is stop/start or background/foreground will you reset the playhead position to “0” and create a new View.

1. Map the “cq” variable using the unique BARB system program ID, as detailed above in the General metadata tagging instructions section,
2. Map the “dur” variable for Live TV streams as detailed above in the General metadata tagging instructions section
3. Set the Live TV channel identifier within the stream variable, e.g.
   1. live/channelone
   2. live/channeltwo
   3. live/channeltwosouth
   4. live/channelthree
   5. live/channelfour
   6. live/F230
   7. live/X234
4. Supply the playhead position (“pst” variable) using an offset in seconds, in the same way as for on-demand steams. It is not necessary to expose a variable delay within your player or to pass it to the measurement system.
5. Handle FFWD/RWD (“tricks”) by updating the offset, in the same way as for on-demand steams.

Example tracking call:

http://tvplayerplugintest.2cnt.net/j0=,,,,v=A%201.1.0+app=mobiletestapp+pl=mobiletestapp+did=868e10589389fd35+aid=bb97262e90e4ef1f+sy=768+plv=1.0.0.0+sx=1196;+,vt=16+uid=3a8w7ib+stream=live/channelname+cq=C4:12345/2+pst=,,0+0+na8vcw;+,1+16+na8vcw;;+sy=360+dur=0+sx=640;;;;?lt=hysmffp1

METHOD 3 – “CHANNEL-ONLY METHOD”

This method assumes that for live simulcast streams, your Player will not provide any indicator of where a stream crosses a programme boundary. It also assumes your Player will not provide any unique content identifier. Moreover the broadcast date and time cannot be exposed to the measurement tracking system.

INSTRUCTIONS:

You will call trackMethod whenever a Live TV channel stream begins; a new View will be created. Every time the Live TV stream is pause/resume or stop/start, the position in stream is reset to “0” and a new View is created.

1. Map the “dur” variable for Live TV streams as detailed above in the General metadata tagging instructions section
2. Populate the channel name (or Service Key identifier) into the stream variable as instructed in the General metadata tagging instructions section.
3. Set the Live TV channel identifier within the stream variable, e.g.
   1. live/channelone
   2. live/channeltwo
   3. live/channeltwosouth
   4. live/channelthree
   5. live/channelfour
   6. live/F230
   7. live/X234

Example tracking call:

http://tvplayerplugintest.2cnt.net/j0=,,,,v=A%201.1.0+app=mobiletestapp+pl=mobiletestapp+did=868e10589389fd35+aid=bb97262e90e4ef1f+sy=768+plv=1.0.0.0+sx=1196;+,vt=16+uid=3a8w7ib+stream=live/channelname+pst=,,0+0+na8vcw;+,1+16+na8vcw;;+sy=360+dur=0+sx=640;;;;?lt=hysmffp1

New Kantar Media Library Code Releases

Each and every time our library sensor technology is updated, it is subject to a strict release checklist process as outlined below:

1. Component Testing
   
   • We test the different components of the library with the help of special test-app (Kantar Media made) that allows
     changing internal parameters of the library. With this app we trigger the overflowing of configured maximum values,
     in order to make sure that everything is handled correctly.
   • For iOS specifically, we test for memory leaks and search for potential memory leaks.
     Tests are conducted with the tools XCode and Instruments.
   • These tests are conducted for every new release of the library; and of course also tested on any new feature should
     there be one.
2. Functional and System Testing
   Here we test if the data from the libraries are leading to correct results in reporting. All components of the system are being
   passed through here.
   
   • Test 1 - Test Tool
     Test of Lib-Testapp with the help of our TestTool (internal and external)
     internal address: http://10.20.1.4:7779/doc/html5/mobile.html
     Currently the Test-Tool can be used to test the following:
     

     • Does the AUT (ApplicationUnderTest) send all requests?
       (STARTED, FOREGROUND, BACKGROUND, CLOSED (optional))

     • Heartbeat events can then be analyzed.
   • Test 2 - Unittests
     
     • Check the DID, AID, and AI in the logstream and in Hadoop cluster.
       (Android ID, Apple Advertising ID, Device ID, ... 16 character a-f0-9 (hex)).
       See also Barb TVPR Project#CUSTOMER DATA PRIVACY DOCUMENTATION.
     • Without connection
     • Via WiFi
       
       • With and without SIM card
     • Via 2/3/4/5G
     • With bad connection
       
       • WiFi when you are finding yourself on the edge of its reach
     • Test if the cookie is stable (when applicable)
       
       • Does the cookie remain the same even after the app is restarted?
       • Does the cookie remain while the app is opened?
   • Test 3a - Integration Test in App Environment
     
     • Implement in different apps and test:
       
       • Panelapp
       • Lib-Testapp
       • Mobile-streaming-app
     • Scenario
       
       • start Lib-Testapp
         => Lib-Testapp shows DID (, AID), AI?
         => DID (, AID), AI in Logstream?

       • For Panelapp: log on as Testpanelist
         => same DID (, AID), AI in Logstream, and additionally the pid?

   • Test 3b - Integrationtest in Web Environment

   • Start browser
     Log on to Panelwebsite as same Testpanelist
     => cookie and pid in Logstream?
      Also check mobile websites, e.g. heise.de (m-heisede.2cnt.net, surf to http://heise-online.mobi/)

   • Cookie in Logstream
     In the Hadoop cluster we have to be able to identify the DID (, AID), pid and cookie.

3. Release Process and Documentation

   We will communicate the availability of new code releases in the following manner:

1. Library downloads will be made publically available on this wiki site, with new version numbering process strictly applied.

2. High-level communication about what has been changed, informing you whether a change is required or not on your side.
   This will include an explanation of why you should upgrade, and whether the change is critical or optional. Critical changes will also be communicated directly outside of this wiki site.
   

3. Accompanying change log document inside the new library download and also mirrored on the project page here.

4. Kantar QC report documenting that the new library has passed release tests.

FROM IMPLEMENTATION TO PUBLICATION - PROCESS

The process of verifying your stream implementation follows four big steps: Unit testing, Comms testing, Go-live acceptance testing, and Operational testing.

Unit Tests for Initial Implementation

By the time the broadcaster gets his hands on a library, the package has already run through unit tests that have been conducted by Kantar (see above).

Communications Tests

In this phase the http-requests that are being sent from the Kantar library inside your player to the collection servers are tested and verified.

Desktop Player (“dotcom”) Streaming Measurement implementations:

For desktop player implementations, you will need to observe the log stream data and verify the content of the heartbeats. You do this by running a simple analysis of the http-requests sent from and to a browser whilst your webplayer is operating.

There are NO warnings or error messages produced using this method, it is a simple tracking of the http requests sent to the Kantar measurement systems.

You can observe an example of a correct webplayer implementation using an http analyser such as the "httpfox" plugin in Firefox or "developer tools" in Chrome.

Step-by-step instructions for running an http-request Analyser:

You can see an example of the heartbeats sent from the Kantar Media libraries here:
kantarmedia.atlassian.net/wiki/spaces/public/pages/159727225/BARB+TVPR+Test+Tool#BARBTVPRTestTool-Heartbeatssentfromthelibraries

We recommend that the verification should be done using an http proxy, such as Charles Proxy or Fiddler.

Once verification is complete your implementation can move to the next QA stage.

Go-Live Acceptance Tests

Before live release, your desktop or mobile app player integration must pass tailored acceptance tests to ensure it adheres to the desired TV Player report project outcomes.

Every player works in subtly different ways and is often subject to customisation. Desired behaviours must be understood in the context of the functionality and user features specific to your player. The specific acceptance criteria will be determined as a result of discussions between developers and business analysts at both the Broadcaster and Kantar Media.

Kantar Media will support this process to assess desired behaviours, e.g. correct handling of stream interruptions. We will undertake acceptance testing of your desktop or mobile app player integration if you can make a staging/beta release available.
For mobile app streaming measurement implementations we recommend you share your build using the test flight platform:

https://testflightapp.com/

We will provide our device/account details. Other methods or products for providing access to a pre-release version of your implementation are of course also accepted.

The table below describes example test scenarios.

The table below describes example test scenarios for live streams.

We will provide written confirmation once acceptance tests have been successfully completed, signing off your implementation.

Publishing your player

With acceptance tests complete, you may now schedule your implementation for publication.
Please:

1. Inform us in advance of the go-live date
2. Change your site-specific sitename from test value to live measurement, e.g. sitename "tvprdotcomtest" must be changed to "tvprdotcom". 

You will use your site-specific test sitename (e.g. "tvprdotcomtest") for testing future upgrades in staging environments.

Live Operational Calibration

The Live Operational Calibration process is used to “calibrate” the TVPR project metrics in the weeks immediately after your player implementation goes live.

Barb JIC ask you to share data from your internal measures for comparison versus the Barb metrics. These are reviewed between Barb, the Broadcaster, and Kantar. At the end of the process BARB will sign-off the data for publication on an ongoing basis. All calibration phase data and discussions are in the strictest confidence.

The diagram below details the optimum schedule. We recognise that iterations of each stage may be required before sign-off can take place, leading to an extended calibration phase.

Managing Future Updates

Once your integration is live, library sensor code changes will be infrequent. Changes will largely be driven by software environment changes (e.g. introduction of Apple IFA/IFV). When a new Kantar library becomes available, you will be notified whether the update is critical to the measurement and therefore mandatory, or whether an upgrade can be scheduled at your discretion.

Integration and testing of your player with the new Kantar library code must not take place on your live system – you must not use your live sitename at any point during the integration process. Your live service is protected during the testing stages by simply directing your test traffic to your alternative site-specific test sitename, e.g.

Test traffic directed to sitename: tvprdotcomtest
Live traffic directed to sitename: tvprdotcom

Once the upgrade implementation has been verified by all parties, you will be advised to switch to your standard sitename before publishing your upgraded player.

CUSTOMER DATA PRIVACY DOCUMENTATION

Here is an overview of all the types of data that is being collected and/or processed by Kantar in the context of the TVPR project.

1. Stream metadata that are explicitly defined in the video players by the broadcasters. See at:  General metadata tagging instructions.
2. Stream metadata that are not explicitly defined in the video players by the broadcasters, but are rather automatically transferred to and via the libraries' functionalities:
   
   1. Device identifiers:
      
      1. From web players: 
         cookie-ID
      2. From iOS devices: 
         Apple Advertising ID (IFA) and the ID for Vendors (IFV) for iOS 6/7, mac address for iOS 5. All are MD5 hashed and truncated to 16 characters.
         NOTE: full unencrypted ID's are never sent to our systems!
      3. From Android devices: 
         Google Advertising ID, Android ID and Device ID (MD5 hashed and trunctated to 16 characters) 
         NOTE: full unencrypted ID's are never sent to our systems!
   2. Screen resolution (!= stream resolution)
   3. Viewtime, contact time with the player, including all buffering, pausing, advertisement. This is different from "playtime"!
3. Data that are inherent to internet traffic and the measurement process:
   
   1. IP-addresses are used for processing, but they are not saved. They are used for:
      
      1. Geo-location of users.
      2. When no cookie is accepted: creating a browser fingerprint based on IP+browser user agent.
   2. Browser user agent where applicable.
   3. Timestamps when heartbeats are received.

Informing Users

With regards to data privacy, there is an obligation to inform the user that the application monitors the user actions and transmits them to a measuring system. Furthermore, the user must be informed that he has the possibility to switch of the tracking in the application and how to do this.

For this purpose, you can use the following example text in an appropriate place in your app implementation:

Opt-Out on Mobile Applications

The library offers the following method to do this:

/**
 * When the value <code>false</code> is specified, the sending of
 * requests to the measuring system is switched off.
 * This value is <code>true</code> by default.
 */
public void setTracking(boolean tracking) { }
/**
 * Delivers the value <code>true</code> when the tracking
 * is activated otherwise the value is <code>false</code>.
 */
public boolean isTracking() { }

Opt-Out on Desktop Player

In the web-environment, the opt-out mechanism uses a specific cookie content to identify the client who does not want to be measured. Due to the fact that a direct and/or standardized way of recognition of the client is not provided, there is no other way to identify such clients.
A client is able to change his identity anytime (e.g. by cookie deletion). Such an identity change always leads to a loss of specific settings of the initial clients (causing them to appear in the system again from the moment of change).

Therefore it is necessary that the client who refuses measurement, communicates this setting to the system constantly. This means that the client may not delete his specific cookie.

The optout page for the TVPR project is located at http://optout.2cnt.net/. Any broadcaster can link to or embed that page on their own pages.

More information can be found at https://kantarmedia.atlassian.net/wiki/spaces/public/pages/159726816/OPT-OUT+and+Anonymization.

FAQ

FEEDBACK