Note: Asset Name and Stream URL are mutable metadata constants; all others are immutable. Conviva retains the different values reported for mutable constants throughout the session.
Ad-related metadata is applicable for you if there're ads in your content sessions.
| Name | Description | Key | Patterns/Acceptable Values |
|---|---|---|---|
| Asset Name | Unique name for each stream/video asset. For Ads, set the name of the ad asset. | assetName | [{contentId}] {series, movie, or game title} - {episode or other title if applicable} |
| Stream URL | The Master Manifest URL from which the video is initially loaded. For Ads, set to the url of the ad media file. | streamUrl | http://your.cdn.com/stream.m3u8 |
| Live or VOD | false = VOD and true = Live Denotes whether the content is video on-demand or a live stream. For Ads, use the same content type as the main content session. | isLive | true | false |
| Content Length | Duration of the video content, in seconds. For Ads, set the duration of the ad asset. | contentLengthSec | 4200 |
| Default Resource | Default video server resource to report for the content. Use when the video server resource cannot be directly inferred from streamUrl. | resource | "EDGECONVIVA SDKT-1", "AKAMAI-FREE", "LEVEL3-PREMIUM" |
| App Name | A preferably human-readable string used to distinguish individual applications | playerName | iOS | Android | OSMF | HTML5 | JavaScript SDK Player | C SDK Player |
| App Version | A string value used to uniquely identify a specific version of the streaming application. Must be the same version number being published on the App stores (Apple App store, Google play store) | c3.app.version | 1.1 | 1.2 |
| Viewer Id | A unique identifier to distinguish individual viewers or devices through Conviva's Viewers Module. The identifier may be a user's unique username, an email address, a unique device identifier, or a generated GUID. | viewerId | contract ID / user ID in CRM DB |
| Media Player Framework Name | Name of the application framework or the name of the player framework used for video playback. For Ads, set the Ad Manager name. | Player Framework Name | For Video: "AVFoundation", "NexPlayer", "HTML5", "OSMF". For Ads: "Google IMA SDK", "Freewheel SDK", "Uplynk SDK", "Anvato SDK", "YoSpace SDK" |
| Media Player Framework Version | Version of the application framework or the name of the player framework used for video playback, if applicable. For Ads, set the version of the Ad Manager SDK version. | Player Framework Version | "4.28.4433", "5.2" |
| Connection Type | The type of network connection used to consume content. Please refer the Conviva Video integration page for your library or SDK to confirm if auto-collection is supported. | dcType | "3G", "4G", "LTE", "WiFi", "Ethernet" |
| Device Model | Model of the device | Device Model | Safari - OS X, G011A, iPad (2017) |
| Device Manufacturer | Manufacturer of the Device | Device Manufacturer | Apple, LG, Samsung, Sony |
| Device OS | Name of the operating system used by the device, in uppercase. | Device Operating System | "WINDOWS", "LINUX", "IOS", "MAC", "ANDROID", "FIREOS", "ROKU", "PLAYSTATION", "CHROMEOS" |
| Device OS Version | Version of the Operating System used by the device | Device Operating System Version | "10.10.1", "8.1", "T-INFOLINK2012-1012", "Fire OS 5" |
| Device Brand | Brand of the Device | deviceBrand | "iPhone", "Samsung SmartTV" |
| Device Type | Type of the device. Only allows the Constants.DeviceType values and discards any other string values. Please get in touch with Conviva, if the Device Type you are looking for is not listed. | Device Hardware Type | "DESKTOP", "Console", "Mobile" |
| Device Category | Device Category to which the used device belongs to. Only allows the Constants.DeviceCategory values and discards any other string values. Please get in touch with Conviva, if the Device Category you are looking for is not listed. This field is applicable only for JS SDK integration. | deviceCategory | "WEB", "AND", "PS" |
| Content Type | More advanced content delivery method | c3.cm.contentType | "Live", "VOD" |
| Channel | The channel on which the content is consumed | c3.cm.channel | NA |
| Brand | The name of the brand to which the content belongs | c3.cm.brand | NA |
| Affiliate | Affiliate or MVPD name for TV Everywhere authenticated services | c3.cm.affiliate | NA |
| Content Category | Content business categories of interest | c3.cm.categoryType | Episodic, Movies, News, Sports, Events, Shorts, Promos |
| Asset Provider Name | Name of CMS Provider | c3.cm.name | CMS, ROVI, TMS |
| Asset ID | Unique asset identifier to query CMS system to gather additional asset metadata information for a specific asset | c3.cm.id | NA |
| Series Name | Set the Series name only if the metadata cannot be gathered from CMS System. Null if not applicable. | c3.cm.seriesName | Friends |
| Season Number | Season number only if the details cannot be inferred from Asset Provider Server. Null if not applicable. | c3.cm.seasonNumber | 1 |
| Episode Name or Show Title | Set Episode/show title only if the details cannot be inferred from Asset Provider Server. | c3.cm.showTitle | The One with all the Cheesecakes |
| Episode Number | Set Episode Number only if the details cannot be inferred from Asset Provider Server. Null if not applicable. | c3.cm.episodeNumber | 3 |
| Primary Genre | Set Primary content genre only if the details cannot be inferred from Asset Provider Server | c3.cm.genre | Drama |
| Genre | Set A list of applicable content genre in a comma separated list only if the details cannot be inferred from Asset Provider Server | c3.cm.genreList | Drama, Crime, Political, Violence |
| Device Name | The device Name. Not previously shown. | Device Name | PC, MAC, Android Phone, Windows Tablet |
| Device Marketing Name | The marketing name of the device. Not previously shown. | Device Marketing Name | Galaxy S5, Galaxy Tab S, G3 |
| Device Operating System Family | The name of the operating system group, such as PlayStation for PlayStation 3 and PlayStation 4 or Windows for Windows 10 and Windows XP. | Device Operating System Family | iOS, Playstation, Roku, Windows |
| Browser Name | The name of the browser on the device. | Browser Name | Chrome, Internet Explorer, Safari |
| Browser Version | The name of the browser on the device concatenated with a more precise version. | Browser Version | Internet Explorer 11, Chrome 60 |
| UTM URL | Provide your full generated UTM URL/ Link to track the effectiveness of the online marketing campaign across traffic sources and publishing media | c3.cm.utmTrackingUrl | NA |
| Ad Technology | Set the ad technology as CLIENT_SIDE/SERVER_SIDE | c3.ad.technology | "Server Side" or "Client Side" |
| Ad Id | Set the Ad ID as a string. This Ad ID is from the Ad Server that actually has the ad creative. For wrapper ads, this is the last Ad ID at the end of the wrapper chain | c3.ad.id | "411687224" |
| Ad System | Set as a string that identifies the Ad System (i.e. the Ad Server). This Ad System represents the Ad Server that actually has the ad creative. For wrapper ads, this is the last Ad System at the end of the wrapper chain. Set to "NA" if not available | c3.ad.system | "Freewheel", "Innovid", "Extreme IO","NA" |
| Ad Position | Set the ad position as a string "Pre-roll", "Mid-roll" or "Post-roll" | c3.ad.position | "Pre-roll", "Mid-roll" or "Post-roll" |
| Ad Type | A boolean value that indicates whether this ad is a Slate or not. Set to "true" for Slate and "false" for a regular ad. By default, set to "false" | c3.ad.isSlate | "true","false" |
| Ad MediaFileApiFramework | Set the creative media framework. Generally used for VPAID ads. Set to "NA" for non-VPAID ads | c3.ad.mediaFileApiFramework | "VPAID", "NA" |
| Ad Stitcher System | Set the name of the Ad Stitcher. If not using an Ad Stitcher, set to "NA" | c3.ad.adStitcher | "Uplynk", "Google DAI", "Google Anvato", "YoSpace","NA" |
| First Ad System | Only valid for wrapper VAST responses. This tag must capture the "first" Ad System in the wrapper chain when a Linear creative is available or there is an error at the end of the wrapper chain. Set to "NA" if not available. If there is no wrapper VAST response then the Ad System and First Ad System should be the same. Examples: "GDFP", "NA". | c3.ad.firstAdSystem | NA |
| First Ad Id | Only valid for wrapper VAST responses. This tag must capture the "first" Ad Id in the wrapper chain when a Linear creative is available or there is an error at the end of the wrapper chain. Set to "NA" if not available. If there is no wrapper VAST response then the Ad Id and First Ad Id should be the same. | c3.ad.firstAdId | "709684096", "NA" |
| First Creative Id | Only valid for wrapper VAST responses. This tag must capture the "first" Creative Id in the wrapper chain when a Linear creative is available or there is an error at the end of the wrapper chain. Set to "NA" if not available. If there is no wrapper VAST response then the Ad Creative Id and First Ad Creative Id should be the same. | c3.ad.firstCreativeId | "57861167296", "NA" |
| Ad Creative Id | The creative id of the ad. This creative id is from the Ad Server that actually has the ad creative. For wrapper ads, this is the last creative id at the end of the wrapper chain. Set to "NA" if not available. | c3.ad.creativeId | "57861167296", "NA" |