PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements and tag managers was disabled.

Follow

Overview

You can subscribe to the events listed in this article using the EB.addEventListener() API method. To subscribe to events, you need to load and initialize our creative API. For more information, see Load and Initialize the API.

General events

Event

Description

EBG.EventName.EB_INITIALIZED

Triggers when the API is initialized.

EBG.EventName.COLLAPSE

Triggers when any expandable panel that belongs to the ad is collapsed.

EBG.EventName.DEVICE_MOTION

Triggers when the devicemotion event is detected in the parent window.

EBG.EventName.EXPAND

Triggers when an expandable panel that belongs to the ad is expanded.

EBG.EventName.PAGE_LOAD

Triggers when the page is fully loaded.

EBG.EventName.SCREEN_ORIENTATION

Triggers when the screen orientation changes. Only works on mobile devices.

EBG.EventName.SDK_DATA_CHANGE

Triggers each time data changes as a result of an event. Use when building ads that are compliant with MRAID (Mobile Rich Media Ad Interface Definitions).

EBG.EventName.VISIBILITY

Triggers when the viewability of the ad changes. For example, when the user scrolls the ad up above the fold. You can access this information synchronously using methodEB.getVisibilityData().

EBCMD events

The following events are only triggered when the EBCMD module is loaded. For more information, see About modules.

Event

Description

EBG.EventName.collapseAd

Triggers the event when MRAID or another mobile-device In-app container tells the ad to collapse.

EBG.EventName.expandAd

Triggers the event when MRAID or another mobile-device In-app container tells the ad to expand.

EBG.EventName.SDK_DATA_CHANGE

Triggers the event when MRAID or another mobile-device In-app container tells the ad that there is a change in the data.

EBG.EventName.SDK_EVENT

Triggers the event when MRAID or another mobile-device In-app container sends a command to the ad.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments