Overview

This document explains how to customize Equativ's Video plugin, using the configuration section.

Integrate configuration file

When calling sas.video.register(), pass the configuration by adding a configuration property to the main object.

Specify the URL of your JSON configuration file as a string value for the configuration property, as shown in the following example:

sas.video.register({
    id: 'myContainer',
    adData: {...},
    configuration: 'url_to_config_file.json',
    ...
});

Alternatively, pass a JavaScript object containing your configuration settings directly to the configuration property, as shown in the following example:

sas.video.register({
    id: 'myContainer',
    adData: {...},
    configuration: {
            publisher: {
                forceSkipDelay: true,
                skipDelay: 5
            }
    },
    ...
});

Loading requirements for configuration file

The Video plugin uses AJAX to load your configuration file when you provide a URL. To ensure the plugin can read the file's content, the server response containing the JSON file must include Cross-Origin Resource Sharing (CORS) headers, as follows:

Access-Control-Allow-Origin: http://yourdomain.com*
Access-Control-Allow-Credentials: true

Replace yourdomain.com with the domain containing the Video plugin.

You don't need to send CORS headers in the following cases:

• You pass the configuration directly as a JavaScript object, not with a URL.
• The configuration file is loaded from the same domain as your website containing the Video plugin.

Customize player

The player section controls the core appearance and functionality of the video player.

The following example shows a player JSON file:

{
    "player": {
        "scaleMode": "SCALE_MODE_ZOOM",
        "enableSound": false,
        "enableCountdownSkip": false
    }
}

Customize labels

The labels in the Video plugin are included in the labels section of the configuration object.

The following table contains the available labels:

To customize the language of labels, refer to the list of available language keys in section “Supported languages”, later in this document.

The following example shows the lbl_countdown_skip label, customized in the languages French ("FR") and English ("EN"):

{
    "labels": {
        "lbl_countdown_skip": {
            "FR": "Vous pourrez passer cette publicité dans {0} secondes",
            "EN": "You can skip this ad in {0} seconds"
        }
    }
}

Customize languages

To change the language used by the plugin, pass a language property to the sas.video.register method, as illustrated by the following snippet:

javascript// Sets the language to French
sas.video.register({
    id: 'myContainer',
    adData: {...},
    ...,
    language: 'FR'
});

Supported languages

The Video plugin supports the following languages: 

Configure ad formats

Configure overlay ads

The overlays section controls the behavior of overlay ads.

The following example shows an overlay configuration with resizing enabled:

{
    "overlays": {
        "resize": true
    }
}

Configure companion ads

The companions section controls the display of companion ads.

Configure banner ads

The banner section configures the request for a banner ad when the main video content is paused. Set the following keys in the dedicated banner object of sasVideoData.

The following example shows a banner ad configuration with the banner format ID and keyword targeting to be applied.

{
    "banner": {
		"sas_format_banners": '1234',
		"sas_target_banners": 'key=value'
	}
}

Configure publisher 

The publisher section contains publisher-specific options.

The following example shows a publisher section with various parameters:

{
    "publisher": {
        "enableSSAR": true,
        "forceSkipDelay": true,
        "schain": "1.0,1!exchange1.com,1234,1,publisher,publisher.com",
        "skipDelay": 5
    }
}

Configure modules

The modules section contains options and settings related to external integrations, such as the ID5 Universal ID module.

Each module object has the following structure:

"moduleName": {
    "useModule": true,
    "config": {
        // a list of the dedicated module's parameters
    }
}

The module isn't used if the module object is missing or if useModule is set to false. The config object is optional if the module doesn't require any parameters.

The id5 module is the only supported module. 

The following example shows an ID5 module:

{
    "modules": {
        "id5": {
            "useModule": true,
            "config": {
                "pd": "MT1iNTBjYTA4MjcxNzk1YThlN2U0MDEyODEzZjIzZDUwNTE5M2Q3NWMwZjJlMmJiOTliYWE2M2FhODIyZjY2ZWQzJjU9bSVDMyVCNmxsZXIlMjZmcmFuJUMzJUE3b2lz"
            }
        }
    }
}

Configure VPAID creatives

The vpaid section contains options that apply only to VPAID creatives.

The following example shows a vpaid section:

{
    "vpaid": {
        "enableCountdownVideo": false,
        "enableSkipLabel": false,
        "loadTimeout": 5
    }
}

Enrich bid requests (RTB options)

The rtb section contains options that apply only to programmatic (RTB) video insertions. These parameters help qualify bid requests to buyers and improve inventory valuation. Some parameters are automatically generated by the Video plugin.

The following example shows an rtb section:

{
    "rtb": {
        "vdmin": 5,
        "vdmax": 15,
        "vpmt": 1,
        "pgDomain": "http://www.somepublisherwebsite.com/some/page"
    }
}