AddEventPlayback - Revision history

Rcalvo at 17:18, 27 October 2014

2014-10-27T17:18:06Z

Rcalvo at 13:22, 10 September 2014

2014-09-10T13:22:04Z

Rcalvo at 22:31, 11 July 2014

2014-07-11T22:31:38Z

Rcalvo at 22:29, 11 July 2014

2014-07-11T22:29:59Z

Rcalvo at 22:09, 11 July 2014

2014-07-11T22:09:17Z

Rcalvo at 15:46, 11 July 2014

2014-07-11T15:46:18Z

Rcalvo: Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the ..."

2014-07-08T13:40:28Z

Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the ..."

New page

{{Api_Method_Spec|
Description=

|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=eventData
|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: [
:::: {
::::: "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|
ParamName=mediaInfo
|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"
}}

|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

|Cache=
This method is not cached.

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"

{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author

{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral

{{!}}- valign="top"
! 2.4
{{!}}
{{!}} Ricardo Calvo

{{!}}}

|SeeAlso=
* [[AddEvent]]
}}

@@ Line 1: / Line 1: @@
 {{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.
+Description=CANDIDATE TO BE DEPRECATED
 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.

@@ Line 4: / Line 4: @@
 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 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.

@@ Line 29: / Line 29: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=The id of the content that is currently been reproduced.
 }}
 {{Api_Parameter|