Ad Plugin Configuration

Integration

You can customize Equativ's plugin to fit your needs by supplying a configuration file in JSON format.
Simply, add a configuration section to the main object passed at registration:

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

Alternatively, you can pass a javascript object to this method:

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

Creating your own configuration is optional. If a parameter is missing in your configuration file, the default value will be taken from the embedded default configuration.

Required settings for the loading of the configuration file

Equativ's plugin will try to load your file with AJAX. To ensure the plugin can read the file content, make sure that your response contains CORS headers as follows:

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

*yourdomain.com - your domain, where Equativ's plugin is integrated

Note: Sending CORS headers is not needed in case your configuration are directly passed as an array of objects or in case the configuration-file is loaded from the domain of your website (where Equativ's plugin is integrated).

Player settings

The configuration file is divided into sections, the player settings being one of them.

Here are the options included in the player section:

Sample for the configuration JSON-file:

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

Labels

All labels within the plugin are included in the "labels" section of the configuration object. Each label is defined by its key. There is a key for each supported language.
All the labels can include a {0} tag. If applicable, it will be automatically replaced by a duration in seconds.

Sample for the configuration JSON-file:

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

Format options

These options are related to a dedicated format.

Overlay options

Sample of the configuration JSON file:

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

Companion options

Sample for the configuration JSON file:

{
    "companions": {
        "slot": "myDefaultDivID"
    }
}
		

Banner options

The video plugin is capable of requesting banner ad when pausing the main video content. The corresponding configuration keys must be set in the dedicated banner object of sasVideoData.

Sample for the configuration JSON file:

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

Publisher settings

These options are related to the publisher. They are part of the "publisher" section.

Sample for the configuration JSON file:

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

Modules' options

These options are related to the external modules (e.g., ID5 UID module). They are included in the "modules" section

Each module has a similar general structure that looks like the following:

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

In case a module object is not added or the value of its "useModule" parameter is falsy, the module won't be used in the plugin. If there are no required module's parameters the "config" object is optional as well.

Here is the list of the supported at this moment modules:

Sample of the configuration JSON file:

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

VPAID options

These options only apply to VPAID creatives. They are included in the "vpaid" section

Sample of the configuration JSON file:

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

RTB options

These options only apply for RTB+ Video insertions. They are meant to better qualify the bid requests sent to buyers, and so improve valuation of the inventory. Some of these parameters are automatically generated by our video plugin (type of ad break, video player dimensions, ...). Some other parameters are configuration settings, they are listed below.

Sample of the configuration JSON file:

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