Contact support

Video plugin: send content metadata

Overview

This document lists the different types of content metadata, which describe the video content. 

Content metadata keys

You can pass content metadata to the ad server with a contentData object of the main object passed at registration. Content metadata can then be targeted and used for reports.  

The following table contains the available keys for content metadata with their type and a description for each.

Content metadata key name Type Description
sas_contentid String The ID of the content video.
sas_contentproviderid String The ID of the content provider.
sas_contentProviderName String The name of the content provider.
sas_contentTitle String The title of the content video.
sas_externalContentId String A content ID, used in a third-party system.
sas_videoCmsId String The ID of the video content management system in charge of the content.
sas_videoContentCategory String The category of the content video.
sas_videoContentChannelName String The name of the content channel.
sas_videoContentDistributorId String The ID of the content distributor.
sas_videoContentDistributorName String The name of the content distributor.
sas_videoContentDuration Number The duration of the content video, in seconds.
sas_videoContentNetworkName String The name of the content network.
sas_videoContentRating String The permissible audience of the content video, for example: general audiences, parental guidance, or adult.
sas_videoContentTags Array of strings The keywords describing the video content.
sas_videoContentType String The type of the content video.
sas_videoEpisodeNumber Number The episode number of the content video.
sas_videoSeasonNumber Number The season number of the content video.

Example contentData object

The following example, shows a contentData object with content metadata:

sas.video.register({
    id: "playerId",	
    adData: {...},
    configuration: ...,
    contentData: {
        sas_contentid: 'Content ID',
        sas_contentTitle: 'Content title',
        sas_videoContentType: 'Content type',
        sas_videoContentCategory: 'Content category',
        sas_videoContentDuration: 300,
        sas_videoSeasonNumber: 1,
        sas_videoEpisodeNumber: 1,
        sas_videoContentRating: 'Content rating',
        sas_contentproviderid: 'Content provider ID',
        sas_contentProviderName: 'Content provider name',
        sas_videoContentDistributorId: 'Content distributor ID',
        sas_videoContentDistributorName: 'Content distributor name',
        sas_videoContentTags: ['Content tag 1', 'Content tag 2'],
        sas_externalContentId: 'External content ID',
        sas_videoCmsId: 'sCMS ID',
        sas_videoContentChannelName: 'channel name',
        sas_videoContentNetworkName: 'network name'
    },
    ...
});