GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Events - Widgets

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

Events have the structure outlined in the table that follows

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.

Widget events

FieldField dataTypeExampleDescriptionFrom versionweb/mobileOptions
Widget (Variant)widget_idVarcharwidget-layout-:r0:Widget unique id
Widget (Variant)widget_sizeVarchar352x84
Widget (Variant)widget_typeVarcharRownull, Row, Grid
Widget (Variant)widget_nameVarcharwidget-layout-stories-container-grid
Widget (Variant)content_idVarchar664c70822b6d3678d4da6298
Widget (Variant)content_nameVarcharIND v PAK Match Highlights
Widget (Variant)content_indexNumber10
Widget (Variant)content_typeVarcharStoryStory, Moment
Widget (Variant)content_version_idVarcharnull
Widget (Variant)page_sizeVarchar414x714
Widget (Variant)page_typeVarcharCategory/Articlenull, Category/Article, Homepage
Widget (Variant)page_view_idVarchar178-64-77-144The unique identifier of the HTML page where the widget is displayed.web
Widget (Variant)placement_distanceVarchar478The vertical distance (in pixels) of the widget from the top of the HTML page.web
Widget (Variant)thumbnail_aspect_ratioVarchar1Represents the ratio between the width and height1- circles, 0.666- rectangles, 1.777- rectangle horizontal
Widget (Variant)thumbnail_sizeVarchar79x79
Widget (Variant)thumbnail_typeVarcharCirclenull, Main, Rectangle, Circle
Widget (Variant)widget_content_countVarchar4Indicates the number of content items within the widget
Widget (Variant)widget_content_listVarchar["6631cdb14e167da3d5a2bab2","6631c7df987317fa2ffe6576","6631a4a34e167da3d5a2b05d","6631a8ef987317fa2ffe5ee3"]["6631cdb14e167da3d5a2bab2","6631c7df987317fa2ffe6576","6631a4a34e167da3d5a2b05d","6631a8ef987317fa2ffe5ee3"]A list of content IDs within the widget
Widget (Variant)animated_thumbnail_enabledBooleanTrueIndicates whether the widget has the capability to play a GIFAndroid 1.2.1 iOS 1.2.0web
Widget (Variant)content_extra_infoVariant{ "gameId": "37073", "playerId": "482630", "teamId": "76" }Provides details about the item clicked by the user. The information is dynamic and can vary, as this is a general-purpose fieldiOS 1.0.4mobile
Widget (Variant)thumbnail_formatVarcharAnimatedWhether the widget is animated or static. If the widget contains a GIF, it will be reported as animatedAndroid 1.2.1 iOS 1.2.0webStatic, Animated

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 Widget variant only).

  • The events sdk_init, app_launch, app_pause, and app_continue are general events and are not directly related to the widget item, therefore they do not report the widget variant data fields.
  • 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_actionwidget_loadwidget_visiblewidget_clicksdk_initapp_launchapp_pauseapp_continue
DescriptionThis event is triggered when the widget finished loading on the App/WebsiteThis event is triggered when a user clicks on one of the items in the widgetThis event is triggered whenever the application calls SDK init methodThis event is triggered whenever the application was startedThis event is triggered whenever the App Moved to BackgroundThis event is triggered whenever the App Moved to Foreground
page_view_idVVV
placement_distanceVVV
widget_idVVV
widget_nameVVV
widget_typeVVV
widget_sizeVVV
widget_content_countVVV
content_idVVV
content_typeVVV
content_indexVVV
thumbnail_sizeVVV
thumbnail_aspect_ratioVVV
thumbnail_typeVVV
page_typeVVV
page_sizeVVV
widget_content_listVVV
page_view_idVVV
content_nameVVV
animated_thumbnail_enabledVV
content_extra_infoV
thumbnail_formatV

Did this page help you?