DisplayServingAd

This type corresponds to the impression token and additional metadata needed by some API endpoints that manipulate the life-cycle of an ad, such as serving and activating. These fields are required for reporting and display purposes.

Property Type Required
Server Version
Description
impressionToken string Required The impression token of the ad creative to which this action is being made.
channelId int Required Value from Channel list
locationId int Required Value from Location list
displayTypeId byte Required Value from DisplayType list
displayPosition int Required 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.
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.

Example

1
2
3
4
5
6
{
   "impressionToken":"eb2176a194ca4d56aae5b88509f5f70e",
   "channelId":1,
   "locationId":10,
   "displayTypeId":1
}

Example 2 (AdServer 3.x)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
   "impressionToken":"eb2176a194ca4d56aae5b88509f5f70e",
   "channelId":1,
   "locationId":10,
   "displayTypeId":1,
   "tags":[
      "In-Store Only",
      "Vegetarian Options"
   ],
   "imageSlots":[
      "logo",
      "HeroImage"
   ]
}