loadMetadata (Browser)

From Engineering Client Portal

Engineering Portal breadcrumbArrow.png Digital breadcrumbArrow.png Browser SDK API Reference breadcrumbArrow.png loadMetadata (Browser)
This event loads the metadata from the stream, but does not inform SDK about playhead position. This API is only necessary for announcing main content before 'preroll' ads, so SDK can relate the ads with content.

Example: If loadMetadata API is called for a video identified as 'Video1', then all subsequent setPlayheadPosition events will be related to 'Video1', until another loadMetadata is executed.

Syntax

International (Germany) implementation:

ggPM("loadMetadata", metadataObject); //Except VA users


ggPM('3', metadataObject); //For VA users only

Input Parameters

Parameter Description JSON Object
metadataObject DTVR
 
{
  "adloadtype": "1"
};
DAR

type should always be "ad" for DAR

 
{
   "type": "ad",
   "ocrtag": "http://secure-uat-cert.imrworldwide.com/cgi-bin/m?ci= ENTXX5&am=3&ep=1&at=view&rt=banner&st=image&ca=cmp97144&cr=1186239&pc=3739659&r=2011370876 "
};
Digital Audio

type should always be "radio".

 
{
   "type": "radio",
   "assetid": "WXYZ-FM",
   "stationType": "3",
   "provider": "providerName",
   "dataSrc": "cms"
};
DCR

type should be "content"

 
{
   "type": "content",
   "assetName": "myassetName",
   "length": "300",
   "title": "myTitle",
   "program": "myProgram",
   "censuscategory": "myCensusCategory",
   "assetid": "myAssetId",
   "channelName": "myChannel",
   "segB": "segmentB",
   "segC": "segmentC",
   "isfullepisode":"Y",
   "crossId1": "Reference11",
   "crossId2": "Reference22",
   "airdate": "20161013 20:00:00",
   "adloadtype": "2",
   "hasAds": "0"
};
 
// Static Measurement:
{
   "type": "static",
   "assetid": "static123",
   "assetName": "Page-Asset",
   "section": "siteSection",
   "segA": "segmentA",
   "segB": "segmentB",
   "segC": "segmentC"
};
 
// Ad Measurement:
{
    "type": "midroll",
    "length": "30",
    "assetid": "myMidrollAssetId",
    "adloadtype": "2",
    "tv": "true",
    "dataSrc": "cms"
};
DCR Germany
 
// type should be "content"
{
   // SDK
   "assetid": "VID123-123456",
   // SDK and VA Beacon
   "type": "content",
   "program": "programName",
   "title": "title",
   "length": "length",
   // VA Beacon
   "censuscategory": "censuscategory",
   "livestream": "no",
   "subcategory": "subcategory",
   "uurl":"uurl",
   "vidtype": "vidtype",
   // Custom Properties
   "nol_c2": "p2, nol_c2",
   "nol_c5": "p5, nol_c5",
   "nol_c7": "p7, nol_c7",
   "nol_c8": "p8, nol_c8",
   "nol_c9": "p9, nol_c9",
   "nol_c10": "p10, nol_c10",
   "nol_c12": "p12, nol_c12",
   "nol_c14": "p14, nol_c14",
   "nol_c15": "p15, nol_c15",
   "nol_c16": "p16, nol_c16",
   "nol_c18": "p18, nol_c18",
   "nol_c19": "p19, nol_c19",
}
 
 
//Ad Measurement - type should be "preroll", "midroll" or "postroll".:
{
   // SDK
   "type": "preroll"
   "assetid": "AD-1",
   "length": "123",
   "title": "title",
   // VA Beacon Metadata
   "censuscategory": "censuscategory",
   "vidtype": "vidtype",
   "subcategory": "subcategory",
   "uurl":"http://nielsen.com",
   // Custom Properties
   "nol_c2": "p2, nol_c2",
   "nol_c4": "p4, nol_c4",
   "nol_c5": "p5, nol_c5",
   "nol_c7": "p7, nol_c7",
   "nol_c8": "p8, nol_c8",
   "nol_c9": "p9, nol_c9",
   "nol_c10": "p10, nol_c10",
   "nol_c11": "p11, nol_c11",
   "nol_c12": "p12, nol_c12",
   "nol_c16": "p16, nol_c16",
   "nol_c17": "p17, nol_c17",
   "nol_c18": "p18, nol_c18",
},

Notes

The actual parameter names and possible values passed in metadataObject depend on application. These are defined between the client and Nielsen before integration starts. Contact the Nielsen Technical Account Manager (TAM) for exact details.

Custom Variables Setup

Nielsen SDK supports collection of custom format and variables. This feature allows the App to pass additional data to the SDK. Contact Nielsen Technical Account Manager (TAM) to configure any custom variables, as needed for implementing the audio / video player.

Samples for passing values to Segment parameters A, B and C

 
{
   "type": "content",
   "length": 300,
   "title": "%Program Title%",
   "assetid": "%Asset ID",
   "assetName": "%Asset Name%",
   "segmentA": "%Segment A%",
   "segmentB": "%Segment B%",
   "segmentC": "%Segment C%"
}