DCR Italy Static Facebook Instant Articles Browser SDK: Difference between revisions
From Engineering Client Portal
(first draft for DCR Italy Facebook Instant Articles Integration Guide) |
No edit summary |
||
Line 1: | Line 1: | ||
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb| | {{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|International}} {{CurrentBreadcrumb}} | ||
[[Category:Digital]] | [[Category:Digital]] | ||
Line 13: | Line 13: | ||
</figure></syntaxhighlight> | </figure></syntaxhighlight> | ||
For more information on the Analytics element, you can refer to the [https://developers.facebook.com/docs/instant-articles/analytics/overview| Insights and Analytics in Instant Articles] section of Facebook’s Instant Article Developer Documentation. | For more information on the Analytics element, you can refer to the [https://developers.facebook.com/docs/instant-articles/analytics/overview | 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 <code><iframe></code> of the Analytics element on each article: | The Nielsen DCR Tracking code below will need to be added within the <code><iframe></code> of the Analytics element on each article: | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
<script | <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[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE"); | ||
// SDK Initialization | |||
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501", 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** | |||
segC: 'Instant Articles' | |||
}; | |||
}; | |||
// Event 'staticstart' Call | |||
nSdkInstance.ggPM("staticstart", nielsenMetadata); | |||
</script></syntaxhighlight> | |||
=== Configure Metadata === | === Configure Metadata === | ||
Line 62: | Line 48: | ||
|- | |- | ||
| apid || unique ID assigned by Nielsen || <code>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</code> || ✓ | | apid || unique ID assigned by Nielsen || <code>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</code> || ✓ | ||
|- | |- | ||
| section || section of the site to be measured || <code>Entertainment</code> || ✓ | | section || section of the site to be measured || <code>Entertainment</code> || ✓ | ||
|- | |- | ||
| segC || Reserved custom segment for Instant Articles || <code>'Instant Articles'</code> || ✓ | | segC || Reserved custom segment for Instant Articles || <code>'Instant Articles'</code> || ✓ | ||
|} | |} | ||
Line 88: | Line 66: | ||
|- | |- | ||
| Section || section || section or category for the AMP page | | Section || section || section or category for the AMP page | ||
|- | |- | ||
| 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 | | 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 | ||
|} | |} | ||
=== Going Live === | |||
Once you have added the DCR Tracking Code to your Instant Articles, Nielsen will validate your implementation after which you must disable Debug logging by deleting {nol_sdkDebug: 'DEBUG'} from the initialization call. | |||
Example: | |||
<syntaxhighlight lang="javascript"> | |||
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501"}); | |||
</syntaxhighlight> | |||
Revision as of 21:23, 15 December 2017
Engineering Portal Digital International DCR Italy 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:
<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[n][o]=t[n][o]||{g:c||{},ggPM:function(e,c,r,s,i){(t[n][o].q=t[n][o].q||[]).push([e,c,r,s,i])}},t[n][o]}}}(window,"NOLBUNDLE");
// SDK Initialization
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501", 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**
segC: 'Instant Articles'
};
// Event 'staticstart' Call
nSdkInstance.ggPM("staticstart", nielsenMetadata);
</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 |
✓ |
section | section of the site to be measured | Entertainment |
✓ |
segC | Reserved custom segment for Instant Articles | 'Instant Articles' |
✓ |
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 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 |
Going Live
Once you have added the DCR Tracking Code to your Instant Articles, Nielsen will validate your implementation after which you must disable Debug logging by deleting {nol_sdkDebug: 'DEBUG'} from the initialization call.
Example:
var nSdkInstance = NOLBUNDLE.nlsQ("PXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX","nlsnInstance", {nsdkvOverride: "501"});