editor
725
edits
Changes
Jump to navigation
Jump to search
no edit summary
{{Api_Method_Spec|
Description=The devices send events to the UNIAPI EventService to collect Playback events. They call to the addEventPlayback method to send this playback events.
This events are sent only in the Player so it's related to VoD and Live contents and related to the HeartBeat event. In case of VoD contents, two kinds of request are made to register events in the platform: AddEventPlayback to register the analytics events and the events for the PlaybackHeartBeat control. In case of an OB has the PlaybackHeartBeat deactivated, and the device's play the Live content, the events for the Analytics won't be registered.
}}
{{Api_Parameter|
ParamName=eventDataplaybackEventType|ParamType=[[AnalyticsEventItem]]|ParamRequired=required|ParamDescription=The eventData parameter is an [[AnalyticsEventItem]] object type and represent a set of data to register the event in the Mongo data base. Each event has the Timestamp, Event and an object with many pair of key:value. It allow to add any pair key:value as you need because it will be add in the Mongo database dynamically inserting a new column by each new key added.: e.g. }}:: {::: Token: "",::: mediaInfo: "",::: eventData: [:::: {Api_Parameter|::::: "Timestamp" : "4315435114",ParamName=contentId::::: "Event" : "EventName",|ParamType=::::: "Data" :|ParamRequired=::::::: {|ParamDescription=:::::::: "EventType":"STOP",:::::::: "ChannelNumber":1,:::::::: "ChannelName":"TVE 1",:::::::: "ChannelCallLetter":"",:::::::: "StreamQuality":"SD",:::::::: "UniqueUserCode":null,:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":25,:::::::: "UserType":null::::::: }:::: },:::: {::::: "Timestamp" : "34123543156",::::: "Event" : "AnotherEventName",::::: "Data" :::::::: {Api_Parameter|:::::::: "EventType":"Rent",ParamName=contentType:::::::: "ActionType":"Click",|ParamType=:::::::: "ProductType":1,|ParamRequired=:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":29,:::::::: "Advertising":null:::::::: "MerchantId":123::::::: }:::: }::: ]:: }|ParamDescription=
}}
{{Api_Parameter|
ParamName=mediaInfoerrorMessage|ParamType=String|ParamRequired=optional|ParamDescription=This parameter can be found in the [[GetMediaURL]] and has all information about the Movie. Is passed, it will be used to assign the eventData with the movie.: e.g.:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
}}
