About modules – Amazon Ads Help Center

Overview

Modules are JavaScript (JS) files with functionality that can be loaded into your ad. Amazon Ad Server (AAS) provides several modules; you can select any combination of modules according to the required functionality in your ad.

Load modules

Before the AdKit declaration in our HTML files, you must include modules and declare them in an array variable called EbModulesToLoad.

The following example loads the Video and the EBAPI modules for use in an AAS ad.

<script> EBModulesToLoad = ['Video', 'EBAPI'];</script>

Modules

Module	Description
Video	For Rich Media Banner, allows you to track video interactions. For more information, see Video module.
EBCMD	Used for mobile-device In-app serving using the IAB’s MRAID framework. This module can be included using the MRAID alias. For more information, see EBCMD Module.
EBAPI	Extra functionality for Rich Media Banner. Mostly, only used by custom formats. For more information, see EBAPI Module.
Comm	Supports communication between the various panels of a multi-panel ad, or between multiple ads on the same page. For more information, see Comm Module.

The following example shows a video module, included in an ad, that is ready to record any video metrics.

Note

Note: This example is for educational purposes only. It does not contain any style or click code. Please note that you should style your elements and add a click-through according to your requirements.

<!doctype html>
<html>

<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>HTML5 Video Module Example</title>
    <script>EBModulesToLoad = ['Video'];</script>
    <script type="text/javascript" src="https://secure-ds.serving-sys.com/BurstingScript/adKit/adkit.js"></script>
    <script type="text/javascript">
        var video;
        var autoPlayVideo = true;

        function checkIfAdKitReady(event) {
            adkit.onReady(initializeCreative);
        }
        function initializeCreative(event) {
            video = document.getElementById("video01");
            videoTrackingModule = new EBG.VideoModule(video);
            if (autoPlayVideo) {
                videoTrackingModule.playVideo(false);
            }
        }
        window.addEventListener("load", checkIfAdKitReady);
    </script>
</head>

<body>
    <div id="banner">
        <button id="clickBtn"></button>
        <video id="video01" muted playsinline>
            <source src="videos/video.mp4" type="video/mp4">
        </video>
    </div>
</body>
</html>

Overview

Load modules

Modules

Note

Comments