Events - Ads

Use this reference to interpret ad-related events provided using the Experiences SDK onEventTriggered callback. It lists the ad event structure and explains each event_action and its associated values.

Events have the structure outlined in the table that follows.

There are three ad types: Ad, Banner, and IMA.

Table structure

Field: The field name.
Field data: For fields with a variant type, this column specifies the name of the field data within the variant
Type: The type of the field or field data (if the field is a variant). Possible types include Number, Varchar, or Boolean.
Example: A sample value or instance of the field.
Description: An explanation of the field's meaning, if necessary.
From version: The SDK version from which this field started being reported.
web/mobile: Indicates whether the field reports data only when a viewer is on web ("web"), mobile ("mobile"), or both (no entry).
Options: Lists possible values for the field if it has a finite set of options.

Ads events

Field	Field data	Type	Example	Description	Options
Ad (Variant)	ad_id	Varchar	6733773748	Ad unique id
Ad (Variant)	ad_title	Varchar	telefonica_ucl
Ad (Variant)	ad_index	Number	22
Ad (Variant)	ad_system	Varchar	GDFP
Ad (Variant)	ad_description	Varchar	telefonica_ucl ad
Ad (Variant)	ad_path	Varchar	182539303/hotstar
Ad (Variant)	ad_duration	Number	15
Ad (Variant)	ad_duration_viewed_percent	Number	58	Percentage of the video duration that the user watched
Ad (Variant)	ad_start_trigger	Varchar	Widget	Method by which the user accessed the ad	Widget, "", null

In the table below, you'll find descriptions for each event_action, along with indicators showing whether the event_action reports a specific field (fields from the Ad variant only).

Note, that each event_action reports not only the fields listed in the table below, but also all generic fields, as described on the events page.

event_action	ad_view	ad_click	ad_exit	ad_playback_pause	ad_forced_playback_pause	ad_playback_play	ad_forced_playback_play	banner_ad_view	banner_ad_load	banner_ad_click	ima_all_ads_completed	ima_ad_clicked	ima_ad_completed	ima_ad_loaded	ima_ad_paused	ima_ad_resumed	ima_ad_skipped	ima_ad_started	ima_ad_tapped	ima_ad_first_quartile	ima_ad_midpoint	ima_ad_third_quartile
Description	This event will triggered when the user viewed the ad content	This event will triggered when the user clicked on the ad content	This event will triggered when the user exited the ad content	This event will triggered when the click on the pause button (for video format ads)		This event will triggered when the click on the play button (for video format ads)		This event will triggered when the user viewed the ad content	This event will triggered when the request was fulfilled and the ad server return a valid ad	This event will triggered when the user clicked on the ad content
ad_id											V	V	V	V	V	V	V	V	V	V	V	V
ad_title											V	V	V	V	V	V	V	V	V	V	V	V
ad_index	V	V	V	V	V	V	V				V	V	V	V	V	V	V	V	V	V	V	V
ad_system											V	V	V	V	V	V	V	V	V	V	V	V
ad_description											V	V	V	V	V	V	V	V	V	V	V	V
ad_path	V	V	V
ad_duration	V	V	V								V	V	V	V	V	V	V	V	V	V	V	V
ad_duration_viewed_percent	V	V	V
ad_start_trigger	V										V	V	V	V	V	V	V	V	V	V	V	V
ad_exit_trigger			V								V	V	V	V	V	V	V	V	V	V	V	V
session_id	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
advertiser_id	V	V	V	V	V	V	V				V	V	V	V	V	V	V	V	V	V	V	V
advertiser_name	V	V	V	V	V	V	V				V	V	V	V	V	V	V	V	V	V	V	V
content_type	V	V	V	V		V		V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
story_id	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
story_title	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
moment_id	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
moment_title	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
skippable											V	V	V	V	V	V	V	V	V	V	V	V
skip_time_offset											V	V	V	V	V	V	V	V	V	V	V	V
audio_state	V	V	V	V	V	V	V				V	V	V	V	V	V	V	V	V	V	V	V
playback_action_method				V		V					V	V	V	V	V	V	V	V	V	V	V	V

Updated about 2 months ago

Did this page help you?