Changes

Jump to navigation Jump to search
792 bytes added ,  10:19, 13 January 2020
no edit summary
{{Api_Method_Spec|
Description=The AddEventBatch is a method to add massive events in just one request. The same behavior of , in another words, send multiply events as [[AddEvent]], in the most common use is on mobile device (after stay offline during some same time) or when the events can be send in a group of events. On mobile device , for example, in a offline mode, all events that wants to add can be storage in a pool , and when it become online, send all data in one request to the AddEventBatch.
The principal difference between [[AddEvent]], is that the parameter eventData is an Array of [[AnalyticsEventItem]] that contains each event to add with his info like timestamp and event title.
The AddEventBatch can be used logged or anonymous.
 
For each event, if not specified the context parameter, the user data will be obtained from the Token.
For more information about the behavior, see [[AddEvent]] method.
NOTE: Each event has the timestamp, event and data. The data parameter could be create with dynamic fields as needed. It's sent in a sequence of key:value.following parameters are always overwritten by GVP
For example* USERID -> (From token)* DEVICEID -> (From token, deviceID in case it is a loginTrustedDevice, User IP if loginUserPAssword)* DEVICETYPEID (From token)* IPADDRESS (From request heades)* INSTANCEID -> (From token)* LANGUAGEID -> (From token)* SESSIONID -> (From token: If wants to send three groups of data and currently empty because some device couldnt support it has different name. The application should control the order to sent that.)* CONTEXT -> (From token: always true)
* First batch:
: - Timstamp: { now }
: - Event: DetailsNavigation
: - Data: { object with information }
Avoid also using any parameter Starting By MIB* Second batch<br>: - Timstamp: { now }<br>: - Event: RentProcess<br>: - Data: { object with information }<br>(It returns an error in the method)
examples* Third batch<br>MIBAPPLICATIONAME: - Timstamp: { now }<br>* MIBTIMESTAMP: - Event: WatchingXperience<br>: - Data: { object with information }<br>* MIBEVENTNAME
|ParamType=[[AnalyticsEventItem]]
|ParamRequired=required
|ParamDescription=The eventData parameter is an [[AnalyticsEvenItemAnalyticsEventItem]] 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.
:: {
::: mediaInfo: "",
::: eventData: [
:::: {::::: "Timestamp" : "43154351141578910731",::::: "Event" : "NavigationEventName",::::: "Data" :::::::: [{:::::::: "EventType":"STOP",:::::: {:: "ChannelNumber":1,:::::::: "ChannelName":"TVE 1",:::::::: "ChannelListedChannelCallLetter": "channel_name1", :::::::: "ProductIdStreamQuality": "123SD",:::::::: "UniqueUserCode" }:null,:::::: {:: "PageViewedDeviceId": "page_name13333333333332222222222227128", :::::::: "ProductIdOBInstanceCode": 25,:::::::: "UserType"123:null,:::::::: '''"Context" :false,'''::::::: }:::: },:::: {::::: "ButtonClickedTimestamp": "button_name11578910737", ::::: "ProductIdEvent": "123AnotherEventName",::::: "Data" }:::::::: {:::::::: "ButtonClickedEventType": "button_name2Rent", :::::::: "ActionType":"ProductIdClick",:::::::: "123ProductType" }:1,:::::: {:: "PageViewedDeviceId": "page_name23333333333332222222222227128", :::::::: "ProductIdOBInstanceCode": 29,:::::::: "456Advertising" :null:::::::: "MerchantId":123,:::::::: '''"Context":true,'''::::::: }::::: ] }
::: ]
:: }
|ParamType=String
|ParamRequired=optional
|ParamDescription=This parameter can be found in the [[GetMediaURLGetMediaUrl]] 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"
|Exceptions=
None* [[InvalidEventDataException]]
|Cache=
* [[AddEvent]]
* [[GetMediaUrl]]
* [[AnalyticsEventItem]]
}}
Bureaucrats, editor
349

edits

Navigation menu