These are the top-level plugin configuration options:
URL pointing to an XML file containing ad rules for one feature clip. Has no effect if an ads array is configured for the same clip.
A list of advert objects describing timed advert requests, one per advert, for one feature clip. ads take precedence over adRules if both are configured.
Setting ads to null on the clip level explicitly prevents adverts for this clip. Useful to override defaults given on a higher level or inside the playlist array.
A list of clip level ima configuration objects, corresponding to each clip of a playlist. Handy for VIDEO tag based playlist installations, as alternative to inlining flowplayer_ima.conf into each playlist item.
Maximum number of redirects to try before ad load is aborted. Default value: 4 - higher values may affect performance.
Deprecated. Use redirects.
v2.0.1 For Flowplayer version 6.x only. Whether to display official linear advert title while advert is shown. Default value: false.
string / integer
Additionally all advert options, except for time, can also be
set at the top level of the ima configuration. They will act as default values
for all adverts in an ads array.
Each object of an ads array accepts the following options to compose an advert
Where the advert should be positioned. In terms of a video advert: 0, pre-roll: before the feature begins. Positive int, mid-roll: at int seconds into feature. -1, post-roll: after the feature finishes. Setting time is mandatory for an ad request to take effect. Note: time cannot be set outside an ads list.
The complete request URL of the scheduled advert.
When the feature is shown in native playback, i.e. on devices not supporting
inline video playback or in enabled native fullscreen mode on mobile devices,
adverts which feature graphical overlays in any form, like skippable video ads
or non-linear graphical overlay ads, are either not shown or reduced in their
These device or configuration enforced restrictions can be mitigated with a
flexible adTag configuration which prefers the interactive ad where possible,
but provides a fallback alternative.
The following option customizes all players on the page and should only be set
once in the global configuration:
v2.1.6 Flash adverts are disabled by default. Setting this to true may lead to erratic behavior. Only use this as a measure of last resort, if your publisher has not upgraded to HTML5 compatible adverts yet, while urging them to do so.
The language used by the IMA SDK for UI elements: can be any 2 letter code.
Deprecated. Use locale.
Disabling the plugin
The plugin can be disabled for specific players by setting ima to false in
the player configuration, or adding the the data-ima="false" attribute to the
player container element.
The third argument of the ima_ad_error event gives direct access to the error
message and error code:
Ad tags and ad rules can be tested directly against the IMA HTML5 SDK in its
online Video Suite Inspector. Paste the adTag or adRules in the
input field and click 'TEST AD'.
If the advert does not play, consult the 'Events' section below the player.
Common errors and their meanings are:
'Ad Error: The VAST response document is empty.' - The ads inventory of your
ads provider currently contains no ads which target your site.
'Ad Error: Linear assets were found in the VAST ad response, but none of them
matched the video player's capabilities.' - The tag requests a Flash video
advert. You should ask your ads provider to deliver HTML5 compatible video ads
'Ad Error: There was a problem requesting ads from the server. Inner Error:
Error: Http response at 400 or 500 level' - Most probably a cross domain
security (CORS) issue; you can verify this in the browser console. Ask
your ad network to enable CORS.
If you need new ad tags or ad rules you can still test the functionality of the
plugin with some of the sample rules/tags listed here.
To turn on the IMA SDK's debug logging to the browser console load its debug
version ima3_debug.js instead of ima3.js:
Does not work with manual jQuery installations into multiple containers
using a class selector
Internet Explorer 9 and below is not supported by the Google IMA API
The plugin only supports the IMA3 HTML5 API
the Google IMA3 SDK currently does not support skippable ads on iOS