Interface ComscoreMetadata

interface ComscoreMetadata {
    c3?: string;
    c4?: string;
    c6?: string;
    carryTvAdvertisementLoad?: boolean;
    classifyAsAudioStream: boolean;
    classifyAsCompleteEpisode?: boolean;
    clipUrl?: string;
    customLabels?: CustomComscoreMetadata;
    dateOfDigitalAiring?: ComscoreDate;
    dateOfProduction?: ComscoreDate;
    dateOfTvAiring?: ComscoreDate;
    deliveryAdvertisementCapability?: ComscoreDeliveryAdvertisementCapability;
    deliveryComposition?: ComscoreDeliveryComposition;
    deliveryMode?: ComscoreDeliveryMode;
    deliverySubscriptionType?: ComscoreDeliverySubscriptionType;
    distributionModel?: ComscoreDistributionModel;
    episodeId?: string;
    episodeNumber?: string;
    episodeSeasonNumber?: string;
    episodeTitle: string;
    feedType?: ComscoreFeedType;
    genreId?: string;
    genreName: string;
    length: number;
    mediaFormat?: ComscoreMediaFormat;
    mediaType: ComscoreMediaType;
    networkAffiliate?: string;
    playlistTitle?: string;
    programId?: string;
    programTitle: string;
    publisherName?: string;
    stationCode?: string;
    stationTitle: string;
    timeOfDigitalAiring?: ComscoreTime;
    timeOfProduction?: ComscoreTime;
    timeOfTvAiring?: ComscoreTime;
    totalSegments?: number;
    uniqueId: string;
    videoDimension?: ComscoreDimension;
}

Properties

c3? c4? c6? carryTvAdvertisementLoad? classifyAsAudioStream classifyAsCompleteEpisode? clipUrl? customLabels? dateOfDigitalAiring? dateOfProduction? dateOfTvAiring? deliveryAdvertisementCapability? deliveryComposition? deliveryMode? deliverySubscriptionType? distributionModel? episodeId? episodeNumber? episodeSeasonNumber? episodeTitle feedType? genreId? genreName length mediaFormat? mediaType networkAffiliate? playlistTitle? programId? programTitle publisherName? stationCode? stationTitle timeOfDigitalAiring? timeOfProduction? timeOfTvAiring? totalSegments? uniqueId videoDimension?

Properties

Optional c3

c3?: string

VMX dictionary (level 1), mandatory, Comscore API: setDictionaryClassificationC3( string value ) - (c3)

Optional c4

c4?: string

VMX dictionary (level 2), mandatory, Comscore API: setDictionaryClassificationC4( string value ) - (c4)

Optional c6

c6?: string

VMX dictionary (level 3), mandatory, Comscore API: setDictionaryClassificationC6( string value ) - (c6)

Optional carryTvAdvertisementLoad

carryTvAdvertisementLoad?: boolean

This metadata helps Comscore differentiate if the stream is carrying the same ad load as TV, Comscore API: carryTvAdvertisementLoad( Boolean value ) - (ns_st_ia)

classifyAsAudioStream

classifyAsAudioStream: boolean

Use value true if the content is audio-only, rather than video (with or without audio). Otherwise omit or use value false, Comscore API: classifyAsAudioStream( Boolean value ) - (ns_st_ty)

Optional classifyAsCompleteEpisode

classifyAsCompleteEpisode?: boolean

Complete Episode Flag, 1 - if the content media is a full episode, LIVE: Optional, VOD: Optional, Adv: Inherited from Content, Comscore API: classifyAsCompleteEpisode( Boolean value ) - (ns_st_ce)

Optional clipUrl

clipUrl?: string

The URL (or path/filename) of the content stream, Comscore API: setClipUrl( string url ) - (ns_st_cu)

Optional customLabels

customLabels?: CustomComscoreMetadata

Can be used to specify a collection of custom metadata name/value pairs, Comscore API: addCustomLabels( Object labels )

Optional dateOfDigitalAiring

dateOfDigitalAiring?: ComscoreDate

The date on which the content was made available for streaming consumption. This metadata helps Comscore establish monetization windows (live, day +1, day +3, etc.) for any given episode or show. The monetization windows are used to calculate commercial and program ratings, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setDateOfDigitalAiring( int year, int month, int day ) - (ns_st_ddt)

Optional dateOfProduction

dateOfProduction?: ComscoreDate

The date on which the content was produced or created, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setDateOfProduction( int year, int month, int day ) - (ns_st_dt)

Optional dateOfTvAiring

dateOfTvAiring?: ComscoreDate

The date on which the content aired on TV. This metadata helps Comscore establish monetization windows (live, day +1, day +3, etc.) for any given episode or show. The monetization windows are used to calculate commercial and program ratings. LIVE: Optional,VOD: Optional,Adv: Inherited from Content Comscore API: setDateOfTvAiring( int year, int month, int day ) - (ns_st_tdt)

Optional deliveryAdvertisementCapability

deliveryAdvertisementCapability?: ComscoreDeliveryAdvertisementCapability

Indicate what capability is allowed for advertisement placements, Comscore API: setDeliveryAdvertisementCapability( value ) - (ns_st_cda)

Optional deliveryComposition

deliveryComposition?: ComscoreDeliveryComposition

Indicates whether or not ads are delivered as part of the content stream, Comscore API: setDeliveryComposition( value ) - (ns_st_cdc)

Optional deliveryMode

deliveryMode?: ComscoreDeliveryMode

Identifies the content delivery to be on-demand or linear, Comscore API: setDeliveryMode( value ) - (ns_st_cde)

Optional deliverySubscriptionType

deliverySubscriptionType?: ComscoreDeliverySubscriptionType

Identifies the type of subscription of the user, Comscore API: setDeliverySubscriptionType( value ) - (ns_st_cds)

Optional distributionModel

distributionModel?: ComscoreDistributionModel

Content Distribution Model, Specify where the content was distributed, LIVE: Optional, VOD: Optional, Adv: Inherited from Content, Comscore API: setDistributionModel( value ) - (ns_st_cdm)

Optional episodeId

episodeId?: string

Episode ID Sub level content ID to be used for matching and grouping purposes,LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setEpisodeId( string id ) - (ns_st_tep)

Optional episodeNumber

episodeNumber?: string

Episode number for episodic content. It is recommended to use values with 2 digits — or 3 digits for episodic content with more than 99 episodes in a season — left-padded with 0, Comscore API: setEpisodeNumber( string value ) - (ns_st_en)

Optional episodeSeasonNumber

episodeSeasonNumber?: string

Season Number, Season number for episodic content, LIVE: Optional, VOD: Optional, Adv: Inherited from Content, Comscore API: setEpisodeSeasonNumber( string value ) - (ns_st_sn)

episodeTitle

episodeTitle: string

Episode title, Sub level content title (i.e., the title of the specific episode),LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setEpisodeTitle( string title ) - (ns_st_ep)

Optional feedType

feedType?: ComscoreFeedType

Specify the type of feed provided on the live stream, Comscore API: setFeedType( value ) - (ns_st_ft)

Optional genreId

genreId?: string

Genre ID to be used for matching and grouping purposes (for example when the genres are multilingual). Multiple values can be provided as a comma-separated string, Comscore API: setGenreId( string id ) - (ns_st_tge)

genreName

genreName: string

Genre description. Multiple values can be provided as a comma-separated string, LIVE: Optional, VOD: Optional, Adv: Inherited from Content, Comscore API: setGenreName( string name ) - (ns_st_ge)

length

length: number

Clip Length in milliseconds, Comscore API: setLength( int length ) - (ns_st_cl)

Optional mediaFormat

mediaFormat?: ComscoreMediaFormat

Specify the type of content media in more detail, VOD: Mandatory, Adv: Inherited from Content, Specify the type of content media in more detail, Comscore API: setMediaFormat( value ) - (ns_st_cmt)

mediaType

mediaType: ComscoreMediaType

Classification type, mandatory, setMediaType( value ) - (ns_st_li)

Optional networkAffiliate

networkAffiliate?: string

Code to identify station affiliation in cases where the same local TV station call sign is affiliated with multiple national TV networks, Comscore API: setNetworkAffiliate( string code ) - (ns_st_sta)

Optional playlistTitle

playlistTitle?: string

Can be used if the player offers the media as part of a playlist. Specify an identifier (title, etc.) for the playlist. For example, the TV Show title for a playlist which contains all episodes from a specific TV show, Comscore API: setPlaylistTitle( string title ) - (ns_st_pl)

Optional programId

programId?: string

Program Id, Top level content ID to be used for matching and grouping purposes, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setProgramId( string id ) - (ns_st_tpr)

programTitle

programTitle: string

Program name, Top level content title (i.e., the name of the overall program, show, or content series), LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setProgramTitle( string title ) - (ns_st_pr)

Optional publisherName

publisherName?: string

Publisher Brand Name, the consumer-facing brand name of the media publisher that owns the content, LIVE: Mandatory, VOD: Mandatory, Adv: Inherited from Content, Comscore API: setPublisherName( string name ) - (ns_st_pu)

Optional stationCode

stationCode?: string

Channel ID, Code of the station or channel for which content was recorded or where content is made available, LIVE: Mandatory,VOD: Mandatory,Adv: Inherited from Content, Comscore API: setStationCode( string code ) - (ns_st_stc)

stationTitle

stationTitle: string

Channel Name, title of the station or channel for which content was recorded or where content is made available, LIVE: Mandatory,VOD: Mandatory,Adv: Inherited from Content, Comscore API: setStationTitle( string title ) - (ns_st_st)

Optional timeOfDigitalAiring

timeOfDigitalAiring?: ComscoreTime

The time at which the content was made available for streaming consumption, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setTimeOfDigitalAiring( int hours, int minutes ) - (ns_st_dtm)

Optional timeOfProduction

timeOfProduction?: ComscoreTime

The time at which the content was produced or created, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setTimeOfProduction( int hours, int minutes ) - (ns_st_tm)

Optional timeOfTvAiring

timeOfTvAiring?: ComscoreTime

The time at which the content aired on TV, LIVE: Optional,VOD: Optional,Adv: Inherited from Content, Comscore API: setTimeOfTvAiring( int hours, int minutes ) - (ns_st_ttm)

Optional totalSegments

totalSegments?: number

Indicates the total number of segments of the content, which is one more than the number of mid-roll ad breaks. For example, content with no mid-roll ad breaks has 1 segment and content with 2 mid-roll ad breaks has 3 segments, Comscore API: setTotalSegments( int total ) - (ns_st_tp)

uniqueId

uniqueId: string

Program ID for VMX, unique identifier for the content, LIVE: Mandatory, VOD: Mandatory, Adv: Inherited from Content, Comscore API: setUniqueId( string id ) - (ns_st_ct)

Optional videoDimension

videoDimension?: ComscoreDimension

Content video dimensions in pixels, Comscore API: setVideoDimensions( int pixelsWide, int pixelsHigh ) - (ns_st_cs)

Settings

Member Visibility

Theme

On This Page

c3c4c6carryTvAdvertisementLoadclassifyAsAudioStreamclassifyAsCompleteEpisodeclipUrlcustomLabelsdateOfDigitalAiringdateOfProductiondateOfTvAiringdeliveryAdvertisementCapabilitydeliveryCompositiondeliveryModedeliverySubscriptionTypedistributionModelepisodeIdepisodeNumberepisodeSeasonNumberepisodeTitlefeedTypegenreIdgenreNamelengthmediaFormatmediaTypenetworkAffiliateplaylistTitleprogramIdprogramTitlepublisherNamestationCodestationTitletimeOfDigitalAiringtimeOfProductiontimeOfTvAiringtotalSegmentsuniqueIdvideoDimension

Generated using TypeDoc