Sweden SDK Metadata: Difference between revisions
From Engineering Client Portal
| Line 80: | Line 80: | ||
| ! Nielsen Key !! MMS Attribute Name/Field Name !! Description !! Values !! Required   | ! Nielsen Key !! MMS Attribute Name/Field Name !! Description !! Values !! Required   | ||
| |- | |- | ||
| |  | | type || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | assetid || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | length|| Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | client_passthrough_parameters || Example || Example || mandatory for clients that have DAI service (Telia, Telenor, Canal-digital, Comhem, Boxer, Sappa, Discovery, Cmore) | ||
|   || yes | |||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | Example || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | film_code || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | is_programmatic || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | mms_thirdparty || Example || Example || Example || yes | ||
| |- | |- | ||
| |  | | ad_server_name || Example || Example || Example || yes | ||
| |- | |||
| | break_position || Position in Break, ns_st_an || placement in ad break. It is passed by ad servers. || custom with the following format: | |||
| {ad placement}/{total number of ads in an ad break} | |||
| Example: 2/5, the second ad in an ad break with 5 ads. || yes | |||
| |} | |} | ||
Revision as of 10:31, 21 May 2021
     
Digital Metadata
Digital Metadata can pass through key values using the Nielsen reserved keys. The keys and values are listed by the product below.
Content Metadata
| Nielsen Key | MMS Attribute Name/Field Name | Description | Values | Required | |
|---|---|---|---|---|---|
| type | type of asset | "content" | yes | ||
| assetid | Content ID, mms_tid | unique ID assigned to an asset within the same media house. | For content on simulcast channels, this has a standard format: simulcast_channelnumber (Example for Channel TV4, the expected value is: simulcast_29). A complete list of channel reference libraries with channel numbers is on the MMS homepage For VoDs, it does not need to follow the simulcast_channelnumber format. Length limit: 20 characters. no special characters | yes | |
| length | Clip Length, ns_st_cl | length of content in seconds | Length of content in seconds. 
 | yes | |
| client_passthrough_parameters | MMS Values, mms_values | pass-through parameters | For clients that provide DAI (dynamic ad insertion) service, this has a standard format: origcode=channelnumber. Example: origcode=29 See the complete list of channel reference library with the channel number on MMS homepage | mandatory for clients that have DAI service (Telia, Telenor, Canal-digital, Comhem, Boxer, Sappa, Discovery, Cmore) | |
| program | Program Name, ns_st_pr | program name | custom example: leif-och-billy | yes | |
| title | Episode Name, ns_st_ep | episode name | custom example: en-ny-tjej-i-byn | yes | |
| title_playlist | Title Playlist, ns_st_pl | playlist reference as a string | string value with playlist name for example: barn | yes | |
| mms_premium | MMS Premium, mms_premium | identify premium level via yes or no | "yes" or "no" | yes | |
| is_auto_play | Auto Start, mms_auto | identify if autoplay is enabled on the video | "yes" or "no" | yes | |
| mms_window | MMS Window, mms_windowsize | player window size | example: 1920x1200 | yes | |
| plugv | Player Version, ns_st_mv | player version. increment by 1 for each new version. | alphanumeric Example: 1.0.1 | yes | |
| playerv | Mediaplayer, ns_st_mp | player identifier | alphanumeric Example: HTML5, JW Player, Sonic | yes | 
Example of metadata object for content:
var contentMetadataObject = {
  "type": "content", 
  "assetid": "simulcast_29",
  "program": "leif-och-billy",
  "title": "en-ny-tjej-i-byn",
  "length": "3359",
  "title_playlist": "barn",
  "mms_premium": "yes",
  "is_auto_play": "yes",
  "mms_window": "1900x1290",
  "plugv": "1.0.1",
  "playerv": "Sonic",
  "client_passthrough_parameters": "origcode=29"
};
Ad Metadata
| Nielsen Key | MMS Attribute Name/Field Name | Description | Values | Required | 
|---|---|---|---|---|
| type | Example | Example | Example | yes | 
| assetid | Example | Example | Example | yes | 
| length | Example | Example | Example | yes | 
| client_passthrough_parameters | Example | Example | mandatory for clients that have DAI service (Telia, Telenor, Canal-digital, Comhem, Boxer, Sappa, Discovery, Cmore) | yes | 
| Example | Example | Example | Example | yes | 
| Example | Example | Example | Example | yes | 
| Example | Example | Example | Example | yes | 
| Example | Example | Example | Example | yes | 
| Example | Example | Example | Example | yes | 
| Example | Example | Example | Example | yes | 
| film_code | Example | Example | Example | yes | 
| is_programmatic | Example | Example | Example | yes | 
| mms_thirdparty | Example | Example | Example | yes | 
| ad_server_name | Example | Example | Example | yes | 
| break_position | Position in Break, ns_st_an | placement in ad break. It is passed by ad servers. | custom with the following format: {ad placement}/{total number of ads in an ad break} Example: 2/5, the second ad in an ad break with 5 ads. || yes |