editor
725
edits
Changes
Jump to navigation
Jump to search
no edit summary
{{Api_Method_Spec|
Description=CANDIDATE TO BE DEPRECATED
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 plays the Live content, the events for the Analytics won't be registered, because the Live player use the contents sent to the PlaybackHeartBeat to register the Events about player.
In general, this method is used by the player used on "PC Client" and "Go Web". But it can be used by other devices only in the player component.
All events sent to the GVP is storage in the BI module and summarised by the BI team, who collect and analyse all data on the Mib tools.
This method can be used by logged or anonymous user.
|Parameters=
}}
{{Api_Parameter|
ParamName=eventDataplaybackEventType|ParamType=[[AnalyticsEventItem]]String
|ParamRequired=required
|ParamDescription=The eventData parameter is an [[AnalyticsEventItem]] object type and represent a set status of data to register the event wants to be storage 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 accept Strings 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: ""PLAY,::: mediaInfo: "",::: eventData: [:::: {::::: "Timestamp" : "4315435114",::::: "Event" : "EventName",::::: "Data" :::::::: {:::::::: "EventType":"STOP",:::::::: "ChannelNumber":1PAUSE,:::::::: "ChannelName":"TVE 1"BUFFERING,:::::::: "ChannelCallLetter":""RESUME,:::::::: "StreamQuality":"SD",:::::::: "UniqueUserCode":null,:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":25,:::::::: "UserType":null::::::: }:::: },:::: {::::: "Timestamp" : "34123543156",::::: "Event" : "AnotherEventName",::::: "Data" :::::::: {:::::::: "EventType":"Rent",:::::::: "ActionType":"Click",:::::::: "ProductType":1,:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":29,:::::::: "Advertising":null:::::::: "MerchantId":123::::::: }:::: }::: ]:: }ERROR and others.
}}
{{Api_Parameter|
ParamName=mediaInfocontentId|ParamType=int|ParamRequired=required|ParamDescription=The id of the content that is currently been reproduced.}}{{Api_Parameter|ParamName=contentType|ParamType=int|ParamRequired=optional|ParamDescription=Used to set what kind of content the event occur. By default this parameter is set to [[MovieType]].Unknown.}}{{Api_Parameter|ParamName=errorMessage
|ParamType=String
|ParamRequired=optional
|ParamDescription=This parameter can A message to be found storage in the [[GetMediaURL]] and has all information about the Movie. Is passed, it will be used to assign the eventData with the movie.: e.gevent.:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
}}
