Sweden SDK Metadata: Difference between revisions
From Engineering Client Portal
| Line 19: | Line 19: | ||
| | 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).<br> | | 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).<br> | ||
| <small>A complete list of channel reference libraries with channel numbers is on the  [https://mms.se/?page_id=108 MMS homepage]</small> | <small>A complete list of channel reference libraries with channel numbers is on the  [https://mms.se/?page_id=108 MMS homepage] tab "referensbandade kanaler".</small> | ||
| <small>For VoD, it does not need to follow the simulcast_channelnumber format.</small> | <small>For VoD, it does not need to follow the simulcast_channelnumber format.</small> | ||
| Line 36: | Line 36: | ||
| <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]</small>   | See the complete list of channel reference library with the channel number on [https://mms.se/?page_id=108 MMS homepage]</small>   | ||
| || mandatory for clients that have DAI service (Telia, Telenor, Canal-digital, Comhem, Boxer, Sappa, Discovery, Cmore) | || mandatory for clients that have DAI service (Telia, Telenor, Canal-digital, Allente, Comhem, Boxer, Sappa, Discovery, Cmore) | ||
| |- | |- | ||
| | program || Program Name, ns_st_pr || program name || custom '''example:''' leif-och-billy || yes | | program || Program Name, ns_st_pr || program name || custom '''example:''' leif-och-billy || yes | ||
Revision as of 12:34, 25 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. 
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" | 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 tab "referensbandade kanaler". For VoD, 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, Allente, 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 | |
| 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 | 
| 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",
  length: "3359",
  client_passthrough_parameters: "origcode=29",
  program: "leif-och-billy",
  title: "en-ny-tjej-i-byn",
  title_playlist: "barn",
  mms_premium: "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. | yes | 
| assetid | Content ID, mms_tid | unique ID assigned to asset within same mediahouse. | 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 VoD, 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 ad in seconds | Length of ad 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 | |
| title | Episode Name, ns_st_ep | episode name | custom example: en-ny-tjej-i-byn | |
| 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 | yes | 
| playerv | Mediaplayer, ns_st_mp | player identifier | alphanumeric example: HTML5, JW Player, Sonic | yes | 
| film_code | Film Code, mms_customadid | custom Ad ID | custom examples: S1MYME202B, 51TRER1001, H1KYLE3032, E1UMBR1001 | yes | 
| is_programmatic | Programmatic, mms_programmatic | identify if the ad is bought prommatic. | "yes" or "no" | yes | 
| mms_thirdparty | MMS Thirdparty, mms_thirdparty | identify if the ad is from third party ad server | "yes" or "no" | yes | 
| ad_server_name | MMS Origin, mms_origin | ad server name | custom examples: Smartclip, YuMe | 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 | 
Example of metadata object for Ad:
var prerollMetadataObject = {
  type: "preroll", 
  assetid: "simulcast_29",
  length: "3359",
  client_passthrough_parameters: "origcode=29",
  program: "leif-och-billy",
  title: "en-ny-tjej-i-byn",
  is_auto_play: "yes",
  mms_premium: "yes",
  plugv: "1.0.1",
  playerv: "Sonic",
  film_code: "E1UMBR1001",
  is_programmatic: "yes",
  mms_thirdparty: "yes",
  ad_server_name: "YuMe",
  break_position: "1/5"
};