Required Metadata Constants

Asset Name

Unique name for each stream/video asset. For Ads, set the name of the ad asset.

assetName

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

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

Content Length

Duration of the video content, in seconds. For Ads, set the duration of the ad asset.

contentLengthSec

Default Resource

Default video server resource to report for the content. Use when the video server resource cannot be directly inferred from streamUrl.

resource

App Name

A preferably human-readable string used to distinguish individual applications

playerName

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

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

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

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

Connection Type

The type of network connection used to consume content. Please refer the Conviva VSI integration page for your library or SDK to confirm if auto-collection is supported.

dcType

Device Model

Model of the device

Device Model

Device Manufacturer

Manufacturer of the Device

Device Manufacturer

Device OS

Name of the operating system used by the device, in uppercase.

Device Operating System

Device OS Version

Version of the Operating System used by the device

Device Operating System Version

Device Brand

Brand of the Device

deviceBrand

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

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

Content Type

More advanced content delivery method

c3.cm.contentType

Channel

The channel on which the content is consumed

c3.cm.channel

Brand

The name of the brand to which the content belongs

c3.cm.brand

Affiliate

Affiliate or MVPD name for TV Everywhere authenticated services

c3.cm.affiliate

Content Category

Content business categories of interest

c3.cm.categoryType

Asset Provider Name

Name of CMS Provider

c3.cm.name

Asset ID

Unique asset identifier to query CMS system to gather additional asset metadata information for a specific asset

c3.cm.id

Series Name

Set the Series name only if the metadata cannot be gathered from CMS System. Null if not applicable.

c3.cm.seriesName

Season Number

Season number only if the details cannot be inferred from Asset Provider Server. Null if not applicable.

c3.cm.seasonNumber

Episode Name or Show Title

Set Episode/show title only if the details cannot be inferred from Asset Provider Server.

c3.cm.showTitle

Episode Number

Set Episode Number only if the details cannot be inferred from Asset Provider Server. Null if not applicable.

c3.cm.episodeNumber

Primary Genre

Set Primary content genre only if the details cannot be inferred from Asset Provider Server

c3.cm.genre

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

Device Name

The device Name. Not previously shown.

Device Name

Device Marketing Name

The marketing name of the device. Not previously shown.

Device Marketing Name

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

Browser Name

The name of the browser on the device.

Browser Name

Browser Version

The name of the browser on the device concatenated with a more precise version.

Browser Version

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

Ad Technology

Set the ad technology as CLIENT_SIDE/SERVER_SIDE

c3.ad.technology

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

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

Ad Position

Set the ad position as a string "Pre-roll", "Mid-roll" or "Post-roll"

c3.ad.position

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

Ad MediaFileApiFramework

Set the creative media framework. Generally used for VPAID ads. Set to "NA" for non-VPAID ads

c3.ad.mediaFileApiFramework

Ad Stitcher System

Set the name of the Ad Stitcher. If not using an Ad Stitcher, set to "NA"

c3.ad.adStitcher

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

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

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