DCR Static Facebook Instant Articles Browser SDK

Engineering Portal / Digital / DCR & DTVR / DCR Static Facebook Instant Articles Browser SDK

This guide will show you how to enable Digital Content Ratings (DCR) measurement on your Facebook Instant Articles.

Implementation Steps

Add Tracking Code

DCR measurement can be added to your Instant Articles through the Analytics element:

<figure class="op-tracker">
    <iframe>
        <!-- Add Nielsen DCR Tracking Code here -->
    </iframe>
</figure>

For more information on the Analytics element, you can refer to the | Insights and Analytics in Instant Articles section of Facebook’s Instant Article Developer Documentation.

The Nielsen DCR Tracking code below will need to be added within the <iframe> of the Analytics element on each article:

// load Nielsen JS Library
<script type="text/javascript">
 function loadNielsen() 
{
    // create initialization object
    var _nolggGlobalParams = 
    {
      sfcode: 'XXX-cert',  // location of collections environment. Value will be provided for testing
      apid:  'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',  // assigned App ID will be provided for testing
      apn: 'PublisherName Instant Articles' // name to identify integration. Can be custom value
    };
   
    // create SDK instance
    var gg1 = NOLCMB.getInstance(_nolggGlobalParams.apid);
   
    // initialize SDK with initialization object
    gg1.ggInitialize(_nolggGlobalParams);
 
    // create object with metadata for Instant Article
    var staticmeta = 
    {
      type: 'static',
      assetid: '', // *UPDATE*: unique ID for each article
      section: '', // *UPDATE*: section or category for article
      segA: '', // *UPDATE*: custom segment
      segB: '', // *UPDATE*: custom segment
      segC: 'Instant Articles' 
    };
    
    // pass metadata for Instant Article when it is opened  
    gg1.ggPM("staticstart",staticmeta);
 }
</script>
<script type="text/javascript" src="https://seccdn-gl.imrworldwide.com/novms/js/2/ggcmb501.js" onload="loadNielsen()"></script>

Configure Metadata

Metadata can be passed through key-values using the Nielsen reserved keys. The tracking code includes the Nielsen reserved keys and placeholder values, <metadataPlaceholder>, for dynamic metadata. You will need to update these values.

Metadata Keys

The Nielsen reserved keys are:

Key	Description	Example Value	Required
apid	unique ID assigned by Nielsen	XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX	✓
apv	current version of the Nielsen implementation	1.0	✓
section	section of the site to be measured	Entertainment	✓
segA	custom segment to be used to break out reporting	Music
segB	custom segment to be used to break out reporting	News
segC	Reserved custom segment for Instant Articles	'Instant Articles'	✓

The values passed through the Nielsen keys will determine the breakouts you will see in reporting. If you decide not to use custom segments A and B, then you do not need to pass a value in these keys.

Metadata for Reporting

You can reference the table to determine how the metadata you pass is used to define your reporting structure:

Reporting Level	Key	Description
Brand	apid	brand is determined by assigned App ID passed during initialization
Sub-brand	apid	sub-brand is determined is determined by assigned App ID passed during initialization
Section	section	section or category for the AMP page
Custom Segment A	segA	available segment for custom reporting. Custom segments will roll into the sub-brand
Custom Segment B	segB	available segment for custom reporting. Custom segments will roll into the sub-brand
Custom Segment C	segC	Custom segment C is reserved for reporting ‘Instant Articles’. The Instant Articles custom segment will be available under sub-brand and will include the total metrics for all your Instant Articles

If you would like your Instant Articles to report into the same reporting structure as your website, we recommend passing the same dynamic metadata in Section, Custom Segment A, and Custom Segment B as you are on your website. This way your Instant Articles numbers contribute to those aggregations.

Aggregation Limits

There are limits on the number of unique values that can be aggregated on in reporting. The specific limitations by key are:

Key	Aggregation Limit
section	maximum of 25 unique values (section <= 25)
segA	total sum of segA, segB, and segC must be a maximum of 24 unique values (segA + segB + segC <= 24)
segB	total sum of segA, segB, and segC must be a maximum of 24 unique values (segA + segB + segC <= 24)

Going Live

Once you have added the DCR Tracking Code to your Instant Articles, Nielsen will validate your implementation. Following Nielsen testing, you will need to update the test values included in the tracking code:

1. apid: 'PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
2. sfcode: 'XXX'

We will confirm the production values to use after testing is completed.