Digital Measurement Simplified API Supplements

From Engineering Client Portal

Revision as of 15:45, 13 December 2018 by YaminiKumawat (talk | contribs) (changed 86400 to 0 for livestream)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

JSON input object examples

The following are additional JSON input object examples for the Simplified API

Static Metadata

// Sample input Object for static metadata
// Since only recording static data, playheadposition = ""
{ 
   "metadata": { 
      "content": {},
      "ad": {},
      "static": { 
         "type":"static",
         "assetid":"Static1",
         "section":"Page",
         "segA":"S07E04:NBC",
         "segB":"teams",
         "segC":"Atlanta",
         "crossId1":"Reference"
      }
   },
   "ottData": {},
   "event": "playhead",
   "type": "static",
   "playheadPosition": "",
}

Ad Metadata

// Sample input object for playhead event with ad metadata
// Note: Content metadata must be also set for "playhead" event with "ad" type.
{ 
   "metadata": { 
      "content": { 
         "assetName":"MyTest789",
         "assetid":"BIG_BUNNY",
         "length":"3600",
         "program":"MyProgram",
         "segB":"CustomSegmentValueB",
         "segC":"segmentC",
         "title":"S2,E3",
         "type":"content",
         "section":"cloudApi_app",
         "airdate":"2016-02-20",
         "isfullepisode":"y"
         },
     "ad": {
        "assetid":"AD12345",
        "title":"ADTestTitle",
        "type":"preroll",
        "length":"20"
     },
     "static": {}
   },
   "event": "playhead",
   "type": "ad",
   "playheadPosition": "5"
}

ID3 Payload

// Sample input object for playhead event with id3 payload
{ 
   "metadata": { 
      "content": { 
         "type":"content",
         "length":"0",
         "adModel":"1",
         "adloadtype":"1"
      },
      "ad": {},
      "static": {}
    },
   "event": "playhead",
   "type": "content",
   "playheadPosition": "",
   "id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
      EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
      2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
      JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
      uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}

Pause Event

// Sample input object for pause event
{ 
   "metadata": { 
      "content": { 
         "assetName":"MyTest789",
         "assetid":"BIG_BUNNY",
         "length":"3600",
         "program":"MyProgram",
         "segB":"CustomSegmentValueB",
         "segC":"segmentC",
         "title":"S2,E3",
         "type":"content",
         "section":"cloudApi_app",
         "airdate":"2016-02-20",
         "isfullepisode":"y"
      },
      "ad": {},
      "static": {}
   },
   "event": "pause",
   "type": "content",
   "playheadPosition": "",
   "id3Data": ""
}

Complete Event

// Sample input object for complete event:
{ 
   "metadata": { 
      "content": { 
         "assetName":"MyTest789",
         "assetid":"BIG_BUNNY",
         "length":"3600",
         "program":"MyProgram",
         "segB":"CustomSegmentValueB",
         "segC":"segmentC",
         "title":"S2,E3",
         "type":"content",
         "section":"cloudApi_app",
         "airdate":"2016-02-20",
         "isfullepisode":"y"
      },
      "ad": {},
      "static": {}
   },
   "event": "complete",
   "type": "content",
   "playheadPosition": "",
   "id3Data": ""
}

Custom values

id3 and ott

// The follow input objects are for custom/advanced implementations
// Not required.

// Sample input object for playhead event with id3 payload and ottInfo:
{ 
   "metadata": { 
      "content": { 
         "assetName":"MyTest789",
         "assetid":"BIG_BUNNY",
         "length":"3600",
         "program":"MyProgram",
         "segB":"CustomSegmentValueB",
         "segC":"segmentC",
         "title":"S2,E3",
         "type":"content",
         "section":"cloudApi_app",
         "airdate":"2016-02-20",
         "isfullepisode":"y"
      },
      "ad": {},
      "static": {}
   },
   "ottData":{ 
      "ottStatus":"1",
      "ottTSPlype":"casting",
      "ottDevice":"chromecast",
      "ottDeviceName":"Google ChromeCast",
      "ottDeviceID":"1234",
      "ottDeviceModel":"ChromeCast",
      "ottDeviceVersion":"1.0.0"
   },
   "event": "playhead",
   "type": "content",
   "playheadPosition": "",
   "id3Data": "www.nielsen.com/065H2g6E7ZyQ5UdmMAbbpg==/_
      EMc37zfVgq_8KB7baUYfg==/ADQCAmgV1Xyvnynyg60kZO_Ejkcn
      2KLSrTzyJpZZ-QeRn8GpMGTWI7-HrEKzghxyzCyBEoIDv2kA2g1Q
      JmeYOl5GnwfrLDVK2bNLTbQxr1z9VBfxahBcQP5tqbjhyMzdVqrMK
      uvvJO1jhtSXa9AroChb11ZUnG1WVJx2O4M=/33648/22847/00"
}

mDAR/OCR

// Sample mDAR/OCR input object for playhead event and ad type:
{ 
   "metadata": { 
      "content": { 
         "assetName":"MyTest789",
         "assetid":"BIG_BUNNY",
         "length":"3600",
         "program":"MyProgram",
         "segB":"CustomSegmentValueB",
         "segC":"segmentC",
         "title":"S2,E3",
         "type":"content",
         "section":"cloudApi_app",
         "airdate":"2016-02-20",
         "isfullepisode":"y"
      },
      "ad": {
         "assetid":"ad-21",
         "nol_ocrtag":"https:\/\/secure-qat2.imrworldwide.com\/cgi-bin\/m?ci=nlsnci535&am=3&at=view&rt=banner
            &st=image&ca=nlsn12452&cr=crtve&pc=spotify_plc0001&ce=spotify&r=1065684265",
         "type":"preroll",
      },
      "static": {}
   },
   "event": "playhead",
   "type": "ad",
   "playheadPosition": "5"
}

Radio Player

// Sample radio player input object for playhead event:
{ 
   "metadata": { 
      "content": {
         "dataSrc": "cms",
         "type": "radio",
         "stationType": "1",
         "assetid": "WXYZ-FM",
         "provider": "MyRadioProvider"
      },
      "ad": {},
      "static": {}
   },
   "event": "playhead",
   "type": "content",
   "playheadPosition": "1502704743",
   "id3Data": ""
}