Difference between revisions of "AddEventPlayback"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the ...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
−
Description=
+
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=
 
|Parameters=
Line 12: Line 23:
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=eventData
+
ParamName=playbackEventType
−
|ParamType=[[AnalyticsEventItem]]
+
|ParamType=String
 
|ParamRequired=required
 
|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.
+
|ParamDescription=The status of the event wants to be storage in the event. It accept Strings as PLAY, STOP, PAUSE, BUFFERING, RESUME, ERROR and others.
−
: e.g.
 
−
:: {
 
−
:::  Token: "",
 
−
:::  mediaInfo: "",
 
−
:::  eventData: [
 
−
::::  {
 
−
:::::  "Timestamp" : "4315435114",
 
−
:::::  "Event" : "EventName",
 
−
:::::  "Data" :
 
−
:::::::    {
 
−
::::::::      "EventType":"STOP",
 
−
::::::::      "ChannelNumber":1,
 
−
::::::::      "ChannelName":"TVE 1",
 
−
::::::::      "ChannelCallLetter":"",
 
−
::::::::      "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
 
−
:::::::    }
 
−
::::  }
 
−
:::  ]
 
−
:: }
 
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=mediaInfo
+
ParamName=contentId
 +
|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
 
|ParamType=String
 
|ParamRequired=optional
 
|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.
+
|ParamDescription=A message to be storage in the event.
−
: e.g.
 
−
:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
 
 
}}
 
}}
−
 
  
  

Latest revision as of 17:18, 27 October 2014

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

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • playbackEventType (String, required)
The status of the event wants to be storage in the event. It accept Strings as PLAY, STOP, PAUSE, BUFFERING, RESUME, ERROR and others.
  • contentId (int, required)
The id of the content that is currently been reproduced.
  • contentType (int, optional)
Used to set what kind of content the event occur. By default this parameter is set to MovieType.Unknown.
  • errorMessage (String, optional)
A message to be storage in the event.


Returns

Returns a JSON object containing the information if the event is registered on server.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": true

}


Exceptions

None


Caching

This method is not cached.


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral
2.4 Ricardo Calvo



See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=AddEventPlayback&oldid=876"