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
  • Creative > Ads > New Ad > Ad Builder

Note

Notes:

List of Events

The following tables describe the supported events.

Main Events

Event

Description

On Load

Triggers an event once the ad loads.

Tap/Click

Opens, selects, or activates whatever you tap, as clicking with a mouse.

Double Click

Triggers an event when the user performs a mouse double-click on the component.

Mouse In

Triggers an event when the user moves the mouse towards the component.

Mouse Out

Triggers an event when the user moves the mouse away from the component.

Mouse Down

Triggers an event when the user presses the mouse button on this component.

Mouse Up

Triggers an event when the user releases the mouse button from this component.

Custom Sequence

Setting the target object as Self, allows you to copy a sequence of actions and animations from one component to another.

For more information, see Ad Builder Sequence Actions.

On Visible

Triggers an event when 50% of the banner or the panel area becomes visible to the user.

On Not Visible

Triggers an event when 50% of the banner or the panel area becomes invisible to the user.

Mobile Related Events

Event

Description

Shake

Triggers an event when the user shakes the mobile phone.

Note

Note: This is not currently available.

Swipe Up

Touch navigation gesture that applies to mobile phones and tablets.

Swipe Right

Touch navigation gesture that applies to mobile phones and tablets.

Swipe Down

Touch navigation gesture that applies to mobile phones and tablets.

Swipe Left

Touch navigation gesture that applies to mobile phones and tablets.

Video Related Events

Event

Description

On Video Play

Triggers an event while a video is running. The event is triggered only once, when the video is first played (either manually by the user, by another event, or using auto-play).

On Video End

Triggers an event when the video ends.

On Video Pause

Triggers an event if the user pauses the component.

On Error

Triggers an event if the video fails to play due to an error.

On Cue Point (0.0 sec)

An event that enables assigning actions and animations to execute at specific cue points within a video. This event allows creative users to author animations that are connected to occurrences in the video, without writing code.

For more information, see Ad Builder On Cue Points Event.

Events for Expandable Ads

The following events are only available for expandable ads.

Event

Description

On Expand

Triggers an event when the panel is expanded.

On Collapse

Triggers an event when the panel is collapsed.

Events for In-Stream Ads

The following events are only available for In-Stream ads.

Event

Description

On Skip Enabled

This event is located in the Master Banner’s event list, and behaves like any other trigger in Ad Builder, for example, click, mouse in, and video play.

Once an ad starts, and the Allow Skip After X Seconds field is selected, the Skip Enabled event fires after x seconds. This timing is according to when the video starts playing, and not when the ad is loaded.

On Close Enabled

This event enables you to provide ways for the user to close the ad manually.

If the Disable Auto Close action was used anywhere in the ad, then instead of closing the ad when it is completed, the On Close Enabled event is triggered.

List of Actions

The following tables describe the supported actions for events.

URL Actions

Event

Description

Clickthrough

General click interaction using the click-through URL defined in Amazon Ad Server (AAS).

Custom Clickthrough

Custom click-through specifying the redirect URL.

Custom Interaction

Custom click interaction using the click-through custom URL defined in AAS.

Goto URL

Sends the user to the defined URL, but the click is not counted in reporting.

Mobile Actions

Action

Description

Comments

Call Number

Triggers a call action to a phone number.

When a Call Number action occurs, it launches the phone's default dialer and enters the number to be called. It does not call the number automatically. It is configured using the international phone number format.

SMS Number

Triggers a send SMS action to a mobile number.

When a Send SMS action occurs, it launches the phone's default SMS client, enters the recipient's number and the body text. It does not send the message automatically; the user must click send.

Email

Triggers a send email action.

When a Send email action occurs, it launches the phone's default email client, enters the recipient's and cc'd email addresses, email subject, and the body text. It does not send the message automatically; the user must click send.

Custom Actions

Event

Description

Run JavaScript

Enables you to add JavaScript code to your ad using the dedicated JavaScript editor accessible from the Run JavaScript action.

For more information, see Ad Builder Add JavaScript to Your HTML Ads.

Download Calendar Reminder

Downloads a calendar file from the ad and automatically adds the date to the user's local calendar application.

Note

Note: This event is not available for the action On Load.

Supported files include ICS, ICAL, IFB, and ICALENDAR.

Define a custom interaction name if you want downloads to display in campaign reports.

Download File

Allows users to download a file, for example, a coupon, from an ad. It can either be downloaded as a file or opened in a new browser tab/window.

Note

Note: This event is not available for the action On Load.

Supported files include .jpg, .png, .gif, and .pdf.

Define a custom interaction name if you want downloads to display in campaign reports.

Video Actions

Event

Description

Play

Starts the video.

Stop

Stops the video and returns to the beginning.

Pause

Pauses the video.

Replay

Starts the video from the beginning.

Mute

Mutes the audio of the video.

Unmute

Unmutes the audio of the video.

Expandable

Event

Description

Expand

Expands a panel.

Expand To Full Screen

Allows configuring a panel to expand to either predefined dimensions or to full screen.

Pushdown

Pushes down the content of a web page when the ad expands, and moves the site out of the way to display the ad.

For more information, see Create a Pushdown in AAS Ad Builder.

Collapse

Collapses a panel.

For more information, see Ad Builder Expandable Panel Actions.

Animation

Event

Description

Slide In

Allows you to define the starting point to slide the component in to the final position on stage.

Slide Out

Allows you to define the end point to slide the component out from the final position on stage.

Motion

Allows you to define the positions, start and final, where to move the component.

Fade In

Adds fade in to a component on the stage.

Fade Out

Adds a fade out to the component on the stage.

Show

Shows a component on the stage.

Hide

Hides a component on the stage.

Rotate

Rotates a component on the stage.

For more details, see Ad Builder Rotate and Scale Actions.

Scale

Scales a component on the stage.

For more details, see Ad Builder Rotate and Scale Actions.

The following table describes the available options for Animation.

Field

Description

Start x/y

End x/y

Indicates the position where the component should start before activation.

image_animation_adbuilder.png

Allows you to drag the animation to the target destination on the ad.

Duration

Indicates the duration of the animation in milliseconds.

Loop

Indicates the number of times to run the animation:

  • Repeat Times: Runs the animation according to the number of times indicated by the user.

  • Repeat Forever: Runs the animation in a loop.

Ease

Easing indicates the type of motion applied to your animations, and also adds a more natural quality to the animations.

  • None: No motion is applied.

  • Ease In: Applies a motion to the animation that starts slowly and accelerates.

  • Ease Out: Applies a motion to the animation that starts quickly and decelerates.

  • Ease in and Out: Applies a combination of the Ease In and Ease Out.

Ease Power

Enabled when the an Ease type is selected in the Ease field. It indicates the intensity of the motion. The higher the Ease Power value, the greater the acceleration and deceleration of the Ease motion.

The following values are supported: 1, 2, 3, 4

Sequence Actions

Event

Description

Pause

Pauses the animation of the sequence.

Start

Starts the animation of the sequence.

Stop

Stops the animation of the sequence, and returns to the beginning.

Gallery Actions

Event

Description

Show Next Slide

Use with the Media Gallery component to proceed to the next slide.

Show Previous Slide

Use with the Media Gallery component. to return to the previous slide.

Go to Slide

Use with the Media Gallery component to go to a specific slide.

Stop Slideshow

Use with the Media Gallery component to stop the slideshow.

Play Slideshow

Use with the Media Gallery component to play the slideshow.

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

Comments