# Player Events Player events represent how users interact with content, advertisement, and streaming quality within the app video/audio player. Measuring player events allows us to see which content drives more engagement (number of plays, view time), optimize our in-player advertisement, and ensure we provide a high-quality streaming service. The player events include three main groups of events: 1) The **Player General Events**, which are reporting player presentations and closing. 2) The **Player Playback Events** include information regarding player buffering and users' interactions like pause and a seek. 3) The **Player Advertisement Events** report information about which ads are shown and clicked. ## Player General Events | event name | properties | description | | :----------------------- | ------------------------- | ------------------------------------------------------------------------------- | | **player_presented** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_closed** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_session_start** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | **player_session_end** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | ## Player Playback Events | event name | properties | description | | :------------------------- | ------------------------- | ------------------------------------------------------------------------------- | | **player_play** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | reason | The reason the player start playing/pause and etc | | **player_pause** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | reason | The reason the player start playing/pause and etc | | **player_complete** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_error** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | **player_buffer_start** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_buffer_complete** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_seek_start** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_seek_complete** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_stop** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_next** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | **player_previous** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | ## Player Advertisement Events | event name | properties | description | | :--------------------------- | ------------------------- | ------------------------------------------------------------------------------- | | **player_ad_break_start** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | start_time | Playhead value at the start of the ad break | | | total_ads | Total number of ads in the ad break | | | max_duration | Max ads duration | | **player_ad_break_complete** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | start_time | Playhead value at the start of the ad break | | | total_ads | Total number of ads in the ad break | | | max_duration | Max ads duration | | **player_ad_start** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | ad_id | The ad id from the ad object | | | position | The position from the ad object | | | advertiser | The advertiser from the ad object | | | campaign | The campaign from the ad object | | | creative | The creative from the ad object | | | placement | The placement from the ad object | | | site | The site from the ad object | | | creative url | The creative url from the ad object | | | ad_type | The ad type from the ad object | | | system | The system from the ad object | | | ad_duration | The ad duration from the ad object | | **player_ad_skip** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | ad_id | The ad id from the ad object | | | position | The position from the ad object | | | advertiser | The advertiser from the ad object | | | campaign | The campaign from the ad object | | | creative | The creative from the ad object | | | placement | The placement from the ad object | | | site | The site from the ad object | | | creative url | The creative url from the ad object | | | ad_type | The ad type from the ad object | | | system | The system from the ad object | | | ad_duration | The ad duration from the ad object | | **player_ad_complete** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | ad_id | The ad id from the ad object | | | position | The position from the ad object | | | advertiser | The advertiser from the ad object | | | campaign | The campaign from the ad object | | | creative | The creative from the ad object | | | placement | The placement from the ad object | | | site | The site from the ad object | | | creative url | The creative url from the ad object | | | ad_type | The ad type from the ad object | | | system | The system from the ad object | | | ad_duration | The ad duration from the ad object | | **player_ad_error** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_ad_request** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | **player_ad_clicked** | uuid | The uuid of the device, on web platforms we generate a uuid4 and store in local | | | version | Version name / number from zapp | | | build number | The number describes that last build built by zapp | | | bundle_id | ID defined in zapp for this specific app version, and platform | | | sdk_version | SDK version selected on zapp | | | quickbrick_version | Quick brick version selected on zapp | | | layout_id | The UI Builder layout id that is presented on the device | | | zapp_platform | The zapp platform build | | | analyticsCustomProperties | Custom properties that comes from the extensions object, only shows when used | | | name | The playable item name | | | media_id | Entry item id | | | media_type | The entry type mapping | | | free_or_paid | Is the entry is a free or paid item | | | stream_type | live / vod | | | stream_format | video / audio | | | player_state | full-screen / partial / pip | | | downloaded | True is the item was downloaded | | | current_position | The current position when the event was sent | | | ad_id | The ad id from the ad object | | | position | The position from the ad object | | | advertiser | The advertiser from the ad object | | | campaign | The campaign from the ad object | | | creative | The creative from the ad object | | | placement | The placement from the ad object | | | site | The site from the ad object | | | creative url | The creative url from the ad object | | | ad_type | The ad type from the ad object | | | system | The system from the ad object | | | ad_duration | The ad duration from the ad object |