ClientEventMessage

Property Type Required
Server Version Description
channelId int Required Value from Channel list
locationId int Required Value from Location list
eventTypeId byte Required Value from ClientEvent list
displayTypeId byte If applicable Value from DisplayType list
adId long If applicable The unique ad id
message string Optional Any extra message data you wish to include in the event
displayPosition int If applicable 3.0+ If this event is taking place on an ad or other UI element such as a collection, this is the relative position of that ad/element among its peers, starting at 0. For example, if the fourth ad in a list is interacted with, this value would be 3.
impressionToken string If applicable 3.0+ If this event is taking place on an Ad, this is the impression token found within the ad's creative.
tags string[] If applicable 3.0+ The collection of tag keys currently displayed to the user at the time of the event, such as purchase-channel, etc...
imageSlots string[] If applicable 3.0+ The collection of image slots currently displayed to the user at the time of the event, such as logo, heroImage, etc...
groupTypeId int If applicable 3.2+ If this event is taking place within the context of a collection or category, this value will indicate the "group" type. Value comes from GroupType enumeration
groupId string If applicable 3.2+ If groupTypeId is specified, this specifies the ID of the collection or category in question.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
   "clientEventMessages":[
      // For events that happen on an ad
      // include the ad ID, impressionToken, and other ad-specific fields
      {
         "eventTypeId": 3, // link clicked
         "adId": 1,
         "impressionToken" : "91e471aed3c04b81bee792f23ad4859d",
         "channelId" : 1,
         "locationId" : 32,
         "displayTypeId" : 6,
         "tags": [
            "purchase-channel"
         ],
         "imageSlots": [
            "logo",
            "heroImage"
         ],
         "displayPosition": 4
      },

      // For events on ads filtered by category, include the category ID
      {
         "eventTypeId": 3,
         "adId": 2,
         "impressionToken" : "91e471aed3c04b81bee792f23ad4859d",
         "channelId" : 1,
         "locationId" : 32,
         "displayTypeId" : 6,
         "tags": [],
         "imageSlots": [
            "logo"
         ],
         "displayPosition": 2, // position in the filtered view
         "groupTypeId" : 1, // Category
         "groupId" : 5 // Category filtered by
      },

      // For events directly on collections or categories, ad information can be omitted
      {
         "eventTypeId": 224,
         "channelId" : 1,
         "locationId" : 32,
         "displayTypeId" : 6,
         "displayPosition": 2, // relative position of the ad or category
         "groupTypeId" : 1, // Category
         "groupId" : 5 // Category interacted with
      },

      // For events not related to an ad or group, most fields can be omitted
      {
         "eventTypeId": 18,
         "channelId": 1,
         "locationId": 32,
         "displayTypeId": 6,
      }
   ]
}