Ad Plugin

From MSX - Wiki
Jump to navigation Jump to search

This is a special video plugin that integrates example ads (i.e. pre-rolls, mid-rolls, and post-rolls) into a video. It can be used as a template for integrating different ad providers. The plugin can be used with version 0.1.146 or higher.

Usage[edit]

The plugin must be loaded with a video URL. Optionally, the content type and GUID can be indicated. Please see following action syntax example.

If you would like to use the plugin as reference to implement your own plugin, please have a look at this implementation scripts:

Syntax[edit]

Parameter syntax of ad plugin
Parameter Type Default Value Mandatory Description
url string null Yes

The URL of the video. It is recommended to encode the value to ensure that it is evaluated correctly (e.g. "http://msx.benzac.de/media/video1.mp4""http%3A%2F%2Fmsx.benzac.de%2Fmedia%2Fvideo1.mp4").

type string "video" No

The type of the content.

  • "video": Video content.
  • "audio": Audio content. If this type is set, the plugin will not serve any ads.
guid string null No

The GUID of the content that can be used for tracking.

Example[edit]

Please note that this example uses the MRSS Feeds interaction plugin to load example content.

Screenshot[edit]

Example Screenshot (Ad Plugin)

Code[edit]

{
    "reference": "request:interaction:http://msx.benzac.de/info/data/mrss/example.xml|||http://msx.benzac.de/plugins/ad.html?url={URL}&type={TYPE}&guid={GUID}@http://msx.benzac.de/interaction/mrss.html",
    "pages": []
}

Demo[edit]

See also[edit]