Sweden SDK Metadata: Difference between revisions
From Engineering Client Portal
| No edit summary | |||
| Line 29: | Line 29: | ||
|   || ✓ |   || ✓ | ||
| |- | |- | ||
| |  | | client_pass_param || MMS Values, mms_values || pass-through parameters || For clients that provide DAI (dynamic ad insertion) service, this has a standard format: origcode=channelnumber. | ||
| <small>'''Example:''' origcode=29 | <small>'''Example:''' origcode=29 | ||
| See the complete list of channel reference library with the channel number on [https://mms.se/?page_id=108 MMS homepage] tab "referensbandade kanaler".</small>   | See the complete list of channel reference library with the channel number on [https://mms.se/?page_id=108 MMS homepage] tab "referensbandade kanaler".</small>   | ||
| Line 42: | Line 42: | ||
| || ✓ | || ✓ | ||
| |- | |- | ||
| |  | | playlist_title || Title Playlist, ns_st_pl || playlist reference as a string || string value with playlist name for '''example:''' barn ||   | ||
| |- | |- | ||
| |  | | is_premium_subscriber || MMS Premium, mms_premium || identify premium level via yes or no || "yes" or "no"  || ✓ | ||
| |- | |- | ||
| | is_auto_play || Auto Start, mms_auto || identify if autoplay is enabled on the video || "yes" or "no"  || ✓ | | is_auto_play || Auto Start, mms_auto || identify if autoplay is enabled on the video || "yes" or "no"  || ✓ | ||
| Line 65: | Line 65: | ||
|    assetid: "simulcast_29", |    assetid: "simulcast_29", | ||
|    length: "3359", |    length: "3359", | ||
|    client_pass_param: "origcode=29", | |||
|    program: "leif-och-billy", |    program: "leif-och-billy", | ||
|    title: "en-ny-tjej-i-byn", |    title: "en-ny-tjej-i-byn", | ||
|    playlist_title: "barn", | |||
|    is_premium_subscriber: "yes", | |||
|    is_auto_play: "yes", |    is_auto_play: "yes", | ||
|    plugv: "1.0.1", |    plugv: "1.0.1", | ||
| Line 90: | Line 90: | ||
| | length || Clip Length, ns_st_cl || length of ad in seconds || Length of ad in seconds. || ✓ | | length || Clip Length, ns_st_cl || length of ad in seconds || Length of ad in seconds. || ✓ | ||
| |- | |- | ||
| |  | | is_programmatic || Programmatic, mms_programmatic || identify if the ad is bought prommatic. || "yes" or "no"  ||   | ||
| ||  | |||
| |- | |- | ||
| |  | | is_thirdparty_ad || MMS Thirdparty, mms_thirdparty || identify if the ad is from third party ad server || "yes" or "no"  ||   | ||
| |- | |- | ||
| |  | | ad_platform_origin || MMS Origin, mms_origin || identify where an ad is originated. It is used when is_programmatic=yes or mms_thirdparty=yes. || custom '''examples:''' Smartclip, YuMe | ||
|   ||   | |||
| |- | |- | ||
| |  | | ad_idx || Position in Break, ns_st_an || placement in ad break. It is passed by ad servers. || Custom with the following format: | ||
| <small>{ad placement}/{total number of ads in an ad break}</small><br> | <small>{ad placement}/{total number of ads in an ad break}</small><br> | ||
| Line 120: | Line 111: | ||
|    assetid: "E1UMBR1001",   |    assetid: "E1UMBR1001",   | ||
|    length: "3359", |    length: "3359", | ||
|    is_programmatic: "yes", |    is_programmatic: "yes", | ||
|    is_thirdparty_ad: "yes", | |||
|    ad_platform_origin: "YuMe", | |||
|    ad_idx: "1/5" | |||
| }; | }; | ||
| </syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 16:52, 1 July 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. 
Section 1 focuses on the content metadata
Section 2 focuses on the Ad metadata.
Content Metadata
| Nielsen Key | MMS Attribute Name, MMS Field Name | Description | Values | Required | 
|---|---|---|---|---|
| type | type of asset | "content" | ✓ | |
| assetid | Content ID, mms_tid | unique ID assigned to an asset within the same media house. | For VoD use internal format. Length limit: 20 characters. No special characters | ✓ | 
| length | Clip Length, ns_st_cl | length of content in seconds | Length of content in seconds. 
 | ✓ | 
| client_pass_param | 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 tab "referensbandade kanaler". | mandatory for clients that have DAI service (Telia, Telenor, Allente, Comhem, Boxer, Sappa, Discovery, Cmore) | 
| program | Program Name, ns_st_pr | program name | custom example: leif-och-billy Leave blank for simulcast. | ✓ | 
| title | Episode Name, ns_st_ep | episode name | custom example: en-ny-tjej-i-byn Leave blank for simulcast. | ✓ | 
| playlist_title | Title Playlist, ns_st_pl | playlist reference as a string | string value with playlist name for example: barn | |
| is_premium_subscriber | MMS Premium, mms_premium | identify premium level via yes or no | "yes" or "no" | ✓ | 
| is_auto_play | Auto Start, mms_auto | identify if autoplay is enabled on the video | "yes" or "no" | ✓ | 
| plugv | Player Version, ns_st_mv | player version. increment by 1 for each new version. | alphanumeric example: 1.0.1 | ✓ | 
| playerv | Mediaplayer, ns_st_mp | player identifier | alphanumeric example: HTML5, JW Player, Sonic | ✓ | 
Example of metadata object for content:
var contentMetadataObject = {
  type: "content", 
  assetid: "simulcast_29",
  length: "3359",
  client_pass_param: "origcode=29",
  program: "leif-och-billy",
  title: "en-ny-tjej-i-byn",
  playlist_title: "barn",
  is_premium_subscriber: "yes",
  is_auto_play: "yes",
  plugv: "1.0.1",
  playerv: "Sonic"
};
Ad Metadata
| Nielsen Key | MMS Attribute Name, MMS Field Name | Description | Values | Required | 
|---|---|---|---|---|
| type | Ad Type, ns_st_ad | type of ad | "preroll", "midroll", "postroll", "ad" if specific ad type cannot be identified. | ✓ | 
| assetid | Film Code, mms_customadid | custom Ad ID | Film code/Copy code. Custom examples: S1MYME202B, 51TRER1001, H1KYLE3032, E1UMBR1001 | ✓ | 
| length | Clip Length, ns_st_cl | length of ad in seconds | Length of ad in seconds. | ✓ | 
| is_programmatic | Programmatic, mms_programmatic | identify if the ad is bought prommatic. | "yes" or "no" | |
| is_thirdparty_ad | MMS Thirdparty, mms_thirdparty | identify if the ad is from third party ad server | "yes" or "no" | |
| ad_platform_origin | MMS Origin, mms_origin | identify where an ad is originated. It is used when is_programmatic=yes or mms_thirdparty=yes. | custom examples: Smartclip, YuMe | |
| ad_idx | 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. | ✓ | 
Example of metadata object for Ad:
var prerollMetadataObject = {
  type: "preroll",
  assetid: "E1UMBR1001", 
  length: "3359",
  is_programmatic: "yes",
  is_thirdparty_ad: "yes",
  ad_platform_origin: "YuMe",
  ad_idx: "1/5"
};