Difference between revisions of "Ad Plugin"
(→Usage) |
|||
Line 55: | Line 55: | ||
* [[Background Plugin]] | * [[Background Plugin]] | ||
* [[Backdrop Plugin]] | * [[Backdrop Plugin]] | ||
+ | * [[Android Plugin]] | ||
+ | * [[Play Plugin]] | ||
* [[Plugin API Reference]] | * [[Plugin API Reference]] |
Revision as of 10:59, 23 January 2023
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 these implementation scripts:
Syntax[edit]
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. |
type |
string |
"video" |
No |
The type of the content.
|
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]
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]
- Launch via App: https://msx.benzac.de/?start=content:https://msx.benzac.de/info/xp/data/plugin_test_7.json
- Launch via Demo Page: https://msx.benzac.de/info/?start=content:https://msx.benzac.de/info/xp/data/plugin_test_7.json