Custom Event

NameTypeDescriptionSample Data
CustomEventIdstringUnique identifier for the custom event record, generated as MD5 hash of concatenated fields"90e19b84e78f436286aa4195140c2998"
IdstringOriginal custom event identifier. A unique ID is generated for each custom event fired."a1b2c3d4e5f6g7h8i9j0"
EventCreatedOntimestampUnix timestamp in milliseconds when the event, in this case custom event, was created1735689600000
AdIdbigintIdentifier for the ad123456789
AdTypeIdbigintType identifier for the ad1
AdvertiserIdbigintIdentifier for the advertiser2325487
BidModifierjsonJSON array of bid modificationsMatch: json
Keyword: string
Zone: bigint
Site: bigint
Multiplier: float
Price: float[{"multiplier": 1.5, "price": 0.75}]
CampaignIdbigintIdentifier for the campaign123456789
ChannelIdbigintIdentifier for the channel123456789
CreativeIdbigintIdentifier for the creative123456789
CustomEventCountbigintCount of the event that has been incremented by the Event Multiplier in either the Request placement or in the query parameter of the event.1
DataCenterbooleanFlag indicating if the custom event was served from a datacenterfalse
DecisionIdstringIdentifier for the decision. A distinct value is created for each placement object in an ADR."90e19b84e78f436286aa4195140c2998"
DecisionIdxbigintRefers to the index of the placement object in an ADR.0
DeviceBrowserstringBrowser name of the device"Chrome"
DeviceBrowserMajorVersionstringMajor version of the browser"120"
DeviceBrowserMinorVersionstringMinor version of the browser"0"
DeviceBrowserRawVersionstringRaw version string of the browser"120.0.6099.130"
DeviceFormFactorstringForm factor of the device"mobile"
DeviceModelNamestringModel name of the device"iPhone 13"
DeviceOsMajorVersionstringMajor version of the operating system"15"
DeviceOsMinorVersionstringMinor version of the operating system"4"
DeviceOsRawVersionstringRaw version string of the operating system"15.4.1"
dtstringDate partition"2024/1/1"
EcpmfloatCalculated ECPM (Effective cost per thousand impressions) of the custom event2.50
EventIdbigintID of the custom event, in the case of conversion is 1, 2, or 33
FlightIdbigintIdentifier for the flight123456789
FraudulentbooleanFlag indicating if the click is fraudulentfalse
GdprComputedbooleanIf true, the request has GDPR consent either from the request itself, from a UserDB record etctrue
GdprSourcestringSource of GDPR consent information. '+' separated string of values: 'blk', 'req', 'udb', 'req'. example: 'req+udb'."req" or "udb"
GmvbigintGross Merchandise Value. Sourced from the event URL if appended as a query parameter. Calculated by taking the gmv parameter on the event URL and multiplying by 1,000,000.1000000
ImpressionCreatedOntimestampUnix timestamp in milliseconds when the request was created1735689600000
IsRemainderbooleanFlag indicating if this is a remainder percentage impression as part of the Auction optimisation processfalse
IsValidUabooleanFlag indicating if the user agent is validtrue
KeywordsjsonJSON array of keywords["shoes", "sports"]
LocationCitystringCity name"San Francisco"
LocationCountryCodestringCountry code. Can be referenced here."US"
LocationCountryNamestringCountry name"United States"
LocationDmaCodestringDMA code"807"
LocationLatitudefloatLatitude coordinate37.7749
LocationLongitudefloatLongitude coordinate-122.4194
LocationMetroCodestringMetro code"SF"
LocationPostalCodestringPostal code"94105"
LocationRegionstringRegion name"California"
LocationSubRegionstringSubregion name"Bay Area"
MatchingKeywordsjsonJSON array of matching keywords["shoes", "sports"]
ModifiedPricefloatModified price value, for when Bid Modifiers are used0.75
NetworkIdstringIdentifier for the network"12345"
OptimizedPricefloatOptimized price value, after factoring in auto-bidding, second pricing and bid modifiers0.80
PlacementNamestringName of the placement, as specified by 'divName' in the Ad Decision Request"homepage_leaderboard"
PricefloatPrice of the Flight that is associated with the custom event e.g. $20.70.20.70
PriorityIdbigintPriorityId of the Flight that is associated with the custom event123456
ProductIdstringIdentifier for the product, if it is associated with a product Ad."prod_123"
PropertiesjsonJSON object of additional custom properties sent with the custom event{"key": "value"}
RateTypeintegerRate type of the Flight that is associated with the custom event1
ReferrerUrlstringReferral URL of where the ad served, requires passing in the referrer field in the Ad Decision Request"https://example.com"
RelevanceScorefloatScore indicating relevancy, requires passing in a relevancy score in the Ad Decision Request500.00
RevenuebigintRevenue generated from the custom event multiplied by 1,000,000 (in order to support very small prices, such as $0.01 CPC).May be altered by revenue modifying parameters .50000
SiteIdbigintIdentifier for the Site that the custom event served in1234567
TimezoneIdstringIdentifier for the time zone"America/Los_Angeles"
UrlstringURL of where the ad served, requires passing in the url field in the Ad Decision Request"https://example.com/page123"
UserKeystringKey identifying the user"ue_e8be4e08dc0345e1b94157f104a5b2ef"
ZoneIdbigintIdentifier for the Zone that the custom event served in1234567