Difference between revisions of "AddEventPlayback"
| Line 2: | Line 2: | ||
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=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 | + | 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 14: | Line 21: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=playbackEventType | ParamName=playbackEventType | ||
| − | |ParamType= | + | |ParamType=String |
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription= | |ParamDescription= | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=contentId | ParamName=contentId | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=required |
|ParamDescription= | |ParamDescription= | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=contentType | ParamName=contentType | ||
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=optional |
| − | |ParamDescription= | + | |ParamDescription=Used to set what kind of content the event occur. By default this parameter is set to [[MovieType]].Unknown. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=errorMessage | ParamName=errorMessage | ||
| − | |ParamType= | + | |ParamType=String |
| − | |ParamRequired= | + | |ParamRequired=optional |
| − | |ParamDescription= | + | |ParamDescription=A message to be storage in the event. |
}} | }} | ||
Revision as of 22:09, 11 July 2014
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 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)
- contentId (int, required)
- 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
|
