Custom Event
| Name | Type | Description | Sample Data |
|---|---|---|---|
| CustomEventId | string | Unique identifier for the custom event record, generated as MD5 hash of concatenated fields | "90e19b84e78f436286aa4195140c2998" |
| Id | string | Original custom event identifier. A unique ID is generated for each custom event fired. | "a1b2c3d4e5f6g7h8i9j0" |
| EventCreatedOn | timestamp | Unix timestamp in milliseconds when the event, in this case custom event, was created | 1735689600000 |
| AdId | bigint | Identifier for the ad | 123456789 |
| AdTypeId | bigint | Type identifier for the ad | 1 |
| AdvertiserId | bigint | Identifier for the advertiser | 2325487 |
| BidModifier | json | JSON array of bid modifications | Match: json Keyword: string Zone: bigint Site: bigint Multiplier: float Price: float [{"multiplier": 1.5, "price": 0.75}] |
| CampaignId | bigint | Identifier for the campaign | 123456789 |
| ChannelId | bigint | Identifier for the channel | 123456789 |
| CreativeId | bigint | Identifier for the creative | 123456789 |
| CustomEventCount | bigint | Count 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 |
| DataCenter | boolean | Flag indicating if the custom event was served from a datacenter | false |
| DecisionId | string | Identifier for the decision. A distinct value is created for each placement object in an ADR. | "90e19b84e78f436286aa4195140c2998" |
| DecisionIdx | bigint | Refers to the index of the placement object in an ADR. | 0 |
| DeviceBrowser | string | Browser name of the device | "Chrome" |
| DeviceBrowserMajorVersion | string | Major version of the browser | "120" |
| DeviceBrowserMinorVersion | string | Minor version of the browser | "0" |
| DeviceBrowserRawVersion | string | Raw version string of the browser | "120.0.6099.130" |
| DeviceFormFactor | string | Form factor of the device | "mobile" |
| DeviceModelName | string | Model name of the device | "iPhone 13" |
| DeviceOsMajorVersion | string | Major version of the operating system | "15" |
| DeviceOsMinorVersion | string | Minor version of the operating system | "4" |
| DeviceOsRawVersion | string | Raw version string of the operating system | "15.4.1" |
| dt | string | Date partition | "2024/1/1" |
| Ecpm | float | Calculated ECPM (Effective cost per thousand impressions) of the custom event | 2.50 |
| EventId | bigint | ID of the custom event, in the case of conversion is 1, 2, or 3 | 3 |
| FlightId | bigint | Identifier for the flight | 123456789 |
| Fraudulent | boolean | Flag indicating if the click is fraudulent | false |
| GdprComputed | boolean | If true, the request has GDPR consent either from the request itself, from a UserDB record etc | true |
| GdprSource | string | Source of GDPR consent information. '+' separated string of values: 'blk', 'req', 'udb', 'req'. example: 'req+udb'. | "req" or "udb" |
| Gmv | bigint | Gross 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 |
| ImpressionCreatedOn | timestamp | Unix timestamp in milliseconds when the request was created | 1735689600000 |
| IsRemainder | boolean | Flag indicating if this is a remainder percentage impression as part of the Auction optimisation process | false |
| IsValidUa | boolean | Flag indicating if the user agent is valid | true |
| Keywords | json | JSON array of keywords | ["shoes", "sports"] |
| LocationCity | string | City name | "San Francisco" |
| LocationCountryCode | string | Country code. Can be referenced here. | "US" |
| LocationCountryName | string | Country name | "United States" |
| LocationDmaCode | string | DMA code | "807" |
| LocationLatitude | float | Latitude coordinate | 37.7749 |
| LocationLongitude | float | Longitude coordinate | -122.4194 |
| LocationMetroCode | string | Metro code | "SF" |
| LocationPostalCode | string | Postal code | "94105" |
| LocationRegion | string | Region name | "California" |
| LocationSubRegion | string | Subregion name | "Bay Area" |
| MatchingKeywords | json | JSON array of matching keywords | ["shoes", "sports"] |
| ModifiedPrice | float | Modified price value, for when Bid Modifiers are used | 0.75 |
| NetworkId | string | Identifier for the network | "12345" |
| OptimizedPrice | float | Optimized price value, after factoring in auto-bidding, second pricing and bid modifiers | 0.80 |
| PlacementName | string | Name of the placement, as specified by 'divName' in the Ad Decision Request | "homepage_leaderboard" |
| Price | float | Price of the Flight that is associated with the custom event e.g. $20.70. | 20.70 |
| PriorityId | bigint | PriorityId of the Flight that is associated with the custom event | 123456 |
| ProductId | string | Identifier for the product, if it is associated with a product Ad. | "prod_123" |
| Properties | json | JSON object of additional custom properties sent with the custom event | {"key": "value"} |
| RateType | integer | Rate type of the Flight that is associated with the custom event | 1 |
| ReferrerUrl | string | Referral URL of where the ad served, requires passing in the referrer field in the Ad Decision Request | "https://example.com" |
| RelevanceScore | float | Score indicating relevancy, requires passing in a relevancy score in the Ad Decision Request | 500.00 |
| Revenue | bigint | Revenue 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 |
| SiteId | bigint | Identifier for the Site that the custom event served in | 1234567 |
| TimezoneId | string | Identifier for the time zone | "America/Los_Angeles" |
| Url | string | URL of where the ad served, requires passing in the url field in the Ad Decision Request | "https://example.com/page123" |
| UserKey | string | Key identifying the user | "ue_e8be4e08dc0345e1b94157f104a5b2ef" |
| ZoneId | bigint | Identifier for the Zone that the custom event served in | 1234567 |
Updated 14 days ago
