loadMetadata: Difference between revisions
From Engineering Client Portal
| ColinBrown (talk | contribs) No edit summary | |||
| Line 16: | Line 16: | ||
| ! Parameter !! Description !! JSON Object | ! Parameter !! Description !! JSON Object | ||
| |- | |- | ||
| | rowspan= | | rowspan=9 | jsonMetaData | ||
| | '''DTVR''' | | '''DTVR''' | ||
| | <syntaxhighlight lang="objective-c">   | | <syntaxhighlight lang="objective-c">   | ||
| Line 26: | Line 26: | ||
| |- | |- | ||
| |'''DAR''' | |'''DAR''' | ||
| type should always be  | type should always be "ad" for DAR | ||
| | | | | ||
| <syntaxhighlight lang="objective-c">   | <syntaxhighlight lang="objective-c">   | ||
| Line 33: | Line 33: | ||
|    @"type": @"ad", |    @"type": @"ad", | ||
|    @"ocrtag": @"http://secure-gl.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" |    @"ocrtag": @"http://secure-gl.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" | ||
| }; | }; | ||
| </syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 23:57, 29 May 2019
     
The application uses this API to send metadata to the SDK. App constructs a JSON dictionary and calls loadMetadata. The API that accepts the JSON string has been deprecated.
In case of a preroll ad, call loadMetadata with metadata values for content followed by loadMetadata with ad (preroll) metadata.
Syntax
 
– (void)loadMetadata:(id)metadata;
Input Parameters
| Parameter | Description | JSON Object | 
|---|---|---|
| jsonMetaData | DTVR |  
NSDictionary *metadata = @
{
  @"adModel": @"1"
};
 | 
| DAR type should always be "ad" for DAR |  
NSDictionary *metadata = @
{
  @"type": @"ad",
  @"ocrtag": @"http://secure-gl.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"
};
 | |
| DCR type should be “content”, “static”, “preroll”, “midroll” or “postroll”. |  
// Audio & Video Measurement:
NSDictionary *metadata = @
{
  @"type": @"content",
  @"assetid": @"vid345-67483",
  @"program": @"ProgramName",
  @"title": @"Program S3, EP1",
  @"length": @"3600",
  @"segB": @"CustomSegmentValueB",
  @"segC": @"CustomSegmentValueC",
  @"crossId1": @"Reference11",
  @"crossId2": @"Reference22",
  @"subbrand": @"cXX",
  @"isfullepisode": @"y",
  @"airdate": @"20161013 20:00:00",
  @"adloadtype": @"2"
};
 
// Static Measurement:
NSDictionary *metadata = @
{
  @"type": @"static",
  @"section": @"siteSection",
  @"segA": @"segmentA",
  @"segB": @"segmentB",
  @"segC": @"segmentC"
};
 
// Ad Measurement:
NSDictionary *metadata = @
{
  @"type": @"preroll",
  @"assetid": @"AD361-84413",
  @"title": @"MyAdName"
};
 | |
| DCR Germany type should be "content", "static", "preroll", "midroll" or "postroll". |  
NSURL *url = [NSURL URLWithString:@"http://nielsense-assets.s3.amazonaws.com/id3/001/prog_index.m3u8"];
NSDictionary *assetInfoDict = @
{
//SDK Metadata
  @"type": @"content",
  @"assetid": @"vid345-67483",
  @"program": @"ProgramName",
  @"title": @"Program S3, EP1",
  @"length": @"3600",
  @"segB": @"CustomSegmentValueB",
  @"segC": @"CustomSegmentValueC",
  @"crossId1": @"Reference11",
  @"crossId2": @"Reference22",
  @"subbrand": @"cXX",
  @"isfullepisode": @"y",
  @"airdate": @"20161013 20:00:00"
 
  //Custom Properties
  @"nol_c{number}": @"p{Number},value"
};
[nielsenMeter loadMetadata:assetInfoDict];
 
 
//Ad Measurement:
//SDK Metadata
NSDictionary *assetInfoDict = @
{
  @"type": @"preroll",
  @"assetid": @"AD361-84413",
  @"title": @"MyAdName"
 
  //Custom Properties
  @"nol_c{number}": @"p{Number},value"
};
[nielsenMeter loadMetadata:assetInfoDict];
 | 
Output Parameters
| Output Parameters (Return value) | Description | 
|---|---|
| Void |