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
| Field | Field data | Type | Example | Description | From version | web/mobile | Options |
|---|---|---|---|---|---|---|---|
| Widget (Variant) | widget_id | Varchar | widget-layout-:r0: | Widget unique id | |||
| Widget (Variant) | widget_size | Varchar | 352x84 | ||||
| Widget (Variant) | widget_type | Varchar | Row | null, Row, Grid | |||
| Widget (Variant) | widget_name | Varchar | widget-layout-stories-container-grid | ||||
| Widget (Variant) | content_id | Varchar | 664c70822b6d3678d4da6298 | ||||
| Widget (Variant) | content_name | Varchar | IND v PAK Match Highlights | ||||
| Widget (Variant) | content_index | Number | 10 | ||||
| Widget (Variant) | content_type | Varchar | Story | Story, Moment | |||
| Widget (Variant) | content_version_id | Varchar | null | ||||
| Widget (Variant) | page_size | Varchar | 414x714 | ||||
| Widget (Variant) | page_type | Varchar | Category/Article | null, Category/Article, Homepage | |||
| Widget (Variant) | page_view_id | Varchar | 178-64-77-144 | The unique identifier of the HTML page where the widget is displayed. | web | ||
| Widget (Variant) | placement_distance | Varchar | 478 | The vertical distance (in pixels) of the widget from the top of the HTML page. | web | ||
| Widget (Variant) | thumbnail_aspect_ratio | Varchar | 1 | Represents the ratio between the width and height | 1- circles, 0.666- rectangles, 1.777- rectangle horizontal | ||
| Widget (Variant) | thumbnail_size | Varchar | 79x79 | ||||
| Widget (Variant) | thumbnail_type | Varchar | Circle | null, Main, Rectangle, Circle | |||
| Widget (Variant) | widget_content_count | Varchar | 4 | Indicates the number of content items within the widget | |||
| Widget (Variant) | widget_content_list | Varchar | ["6631cdb14e167da3d5a2bab2","6631c7df987317fa2ffe6576","6631a4a34e167da3d5a2b05d","6631a8ef987317fa2ffe5ee3"]["6631cdb14e167da3d5a2bab2","6631c7df987317fa2ffe6576","6631a4a34e167da3d5a2b05d","6631a8ef987317fa2ffe5ee3"] | A list of content IDs within the widget | |||
| Widget (Variant) | animated_thumbnail_enabled | Boolean | True | Indicates whether the widget has the capability to play a GIF | Android 1.2.1 iOS 1.2.0 | web | |
| Widget (Variant) | content_extra_info | Variant | { "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 field | iOS 1.0.4 | mobile | |
| Widget (Variant) | thumbnail_format | Varchar | Animated | Whether the widget is animated or static. If the widget contains a GIF, it will be reported as animated | Android 1.2.1 iOS 1.2.0 | web | Static, 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_action | widget_load | widget_visible | widget_click | sdk_init | app_launch | app_pause | app_continue |
|---|---|---|---|---|---|---|---|
| Description | This event is triggered when the widget finished loading on the App/Website | This event is triggered when a user clicks on one of the items in the widget | This event is triggered whenever the application calls SDK init method | This event is triggered whenever the application was started | This event is triggered whenever the App Moved to Background | This event is triggered whenever the App Moved to Foreground | |
| page_view_id | V | V | V | ||||
| placement_distance | V | V | V | ||||
| widget_id | V | V | V | ||||
| widget_name | V | V | V | ||||
| widget_type | V | V | V | ||||
| widget_size | V | V | V | ||||
| widget_content_count | V | V | V | ||||
| content_id | V | V | V | ||||
| content_type | V | V | V | ||||
| content_index | V | V | V | ||||
| thumbnail_size | V | V | V | ||||
| thumbnail_aspect_ratio | V | V | V | ||||
| thumbnail_type | V | V | V | ||||
| page_type | V | V | V | ||||
| page_size | V | V | V | ||||
| widget_content_list | V | V | V | ||||
| page_view_id | V | V | V | ||||
| content_name | V | V | V | ||||
| animated_thumbnail_enabled | V | V | |||||
| content_extra_info | V | ||||||
| thumbnail_format | V |
Updated about 2 months ago
Did this page help you?
